IFID: Difference between revisions
From IFWiki
(although I appreciate the correction when I'm in error, a couple things I got right got edited out as well. tsk.) |
(+ How to add an IFID to your game if your authoring system isn't covered by the Treaty of Babel) |
||
| Line 4: | Line 4: | ||
See section 2.2 of the [[Treaty of Babel]]. | See section 2.2 of the [[Treaty of Babel]]. | ||
==How to add an IFID to your game if your authoring system isn't covered by the Treaty of Babel== | |||
Since this is not part of the Treaty of Babel, this advice can't be ''official'', but here's what to do. | |||
STEP ONE: Determine the IFID of your game. | |||
* If your game was previously released to the public, use the MD5 hash of the earliest released version of the main "[[story file]]" for your game. | |||
* If your game has never been released to the public, visit the [http://www.tads.org/ifidgen/ifidgen TADS IFID Generator] page to get one. | |||
STEP TWO: Insert the string "UUID://''XXXXXXXXXXXXXXXX''//" into your story file, where ''XXXXXXXXXXXXXXXX'' is the IFID you determined in step one. | |||
For example, in a [[Undum]], [[ChoiceScript]], or other Web browser game, you may insert | |||
<nowiki><!-- UUID://XXXXXXXXXXXXXXXX// --></nowiki> | |||
as a comment anywhere in your HTML file. | |||
By putting '''UUID://''' in front of your IFID, and '''//''' after your IFID, you make it possible for automated tools like [[Babel (utility)|Babel]] to find it. | |||
==Links== | ==Links== | ||
Revision as of 15:06, 17 June 2012
An IFID is a specific type of UUID used for uniquely identifying both new and legacy works of interactive fiction.
An IFID may only contain digits, letters, and hyphens.
See section 2.2 of the Treaty of Babel.
How to add an IFID to your game if your authoring system isn't covered by the Treaty of Babel
Since this is not part of the Treaty of Babel, this advice can't be official, but here's what to do.
STEP ONE: Determine the IFID of your game.
- If your game was previously released to the public, use the MD5 hash of the earliest released version of the main "story file" for your game.
- If your game has never been released to the public, visit the TADS IFID Generator page to get one.
STEP TWO: Insert the string "UUID://XXXXXXXXXXXXXXXX//" into your story file, where XXXXXXXXXXXXXXXX is the IFID you determined in step one.
For example, in a Undum, ChoiceScript, or other Web browser game, you may insert
<!-- UUID://XXXXXXXXXXXXXXXX// -->
as a comment anywhere in your HTML file.
By putting UUID:// in front of your IFID, and // after your IFID, you make it possible for automated tools like Babel to find it.
Links
TADS
- Bibliographic Metadata in TADS Games: IFIDs.
- Online TADS IFID Generator. Use this for new TADS games. For older games, you want to use an MD5 hash; see previous link.
This article is a stub. You can help IFWiki by expanding it.
TODO: Everything. This is a NEW topic.
TODO: Everything. This is a NEW topic.