Difference between revisions of "IFID"

From IFWiki
Jump to: navigation, search
(rephrased first 2 lines to "An interactive fiction identifier (IFID) is a specific type")
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
An [[IFID]] is a specific type of [http://en.wikipedia.org/wiki/Universally_Unique_Identifier UUID] used for uniquely identifying both new and legacy works of interactive fiction.
+
An '''interactive fiction identifier''' ('''IFID''') is a specific type of [http://en.wikipedia.org/wiki/Universally_Unique_Identifier UUID] used for uniquely identifying both new and legacy works of interactive fiction.
  
 
An IFID may only contain digits, letters, and hyphens.
 
An IFID may only contain digits, letters, and hyphens.
Line 26: Line 26:
 
* [http://www.tads.org/howto/gameinfo.htm#ifids Bibliographic Metadata in TADS Games: IFIDs].
 
* [http://www.tads.org/howto/gameinfo.htm#ifids Bibliographic Metadata in TADS Games: IFIDs].
 
* [http://www.tads.org/ifidgen/ifidgen Online TADS IFID Generator]. Use this for ''new'' TADS games. For older games, you want to use an MD5 hash; see previous link.
 
* [http://www.tads.org/ifidgen/ifidgen Online TADS IFID Generator]. Use this for ''new'' TADS games. For older games, you want to use an MD5 hash; see previous link.
 +
 +
====IFID Extraction Tools====
 +
* [http://babel.ifarchive.org/program.html The Babel Software Suite]
 +
* [https://ifdb.tads.org/help-ifid How do I determine a game's IFID?]
  
 
{{stub|Everything. This is a NEW topic.}}
 
{{stub|Everything. This is a NEW topic.}}
  
 
[[Category:Technical standards]]
 
[[Category:Technical standards]]

Revision as of 03:17, 22 May 2020

An interactive fiction identifier (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, use any UUID generator (such as 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

IFID Extraction Tools

This article is a stub. You can help IFWiki by expanding it.
TODO: Everything. This is a NEW topic.