Inform

Inform 6

Inform was originally created by Graham Nelson in 1993. In 1996 Nelson rewrote Inform from first principles to create version 6 (or Inform 6). Over the following decade, version 6 became reasonably stable and a popular language for writing interactive fiction.

The Inform 6 system consists of two major components: the Inform compiler, which generates story files from Inform source code, and the Inform library, a suite of software which handles most of the difficult work of parsing the player's text input and keeping track of the world model. The name Inform also refers to the Inform programming language that the compiler understands.

Although Inform 6 and the Z-Machine were originally designed with interactive fiction in mind, many other programs have been developed, including a BASIC interpreter, a LISP tutorial (complete with interpreter), a Tetris game, and a version of the game Snake.

The Inform 6 compiler

The Inform compiler generates files for the Z-machine or Glulx (also called story files) from Inform 6 source code.

The Inform 6 programming language

The Inform programming language is object-oriented and procedural. A key element of the language is objects. Objects are maintained in an object tree which lists the parent–child relationships between objects. Since the parent–child relationship is often used to represent location, an object which is the parent of another object is often said to "hold" it. Objects can be moved throughout the tree. Typically, top level objects represent rooms and other locations within the game, which may hold objects representing the room's contents, be they physical items, non-player characters, the player's character, or background effects. All objects can hold other objects, so a livingroom object might hold an insurancesaleman object which is holding a briefcase object which contains the insurancepaperwork object.

In early versions of Inform, objects were different from the notion of objects from object-oriented programming, in that there was no such thing as a class. Later versions added support for class definitions and allowed objects to be members of classes. Objects and classes can inherit from multiple classes. Interactive fiction games typically contain many unique objects. Because of this, many objects in Inform do not inherit from any class, other than the "metaclass" Object. However, objects very frequently have attributes (boolean properties, such as scenery or edible) that are recognized by the Inform library. In other languages this would normally be implemented via inheritance.

Here is a simple example of Inform 6 source code.

<span id="mwVw"></span><span class="c1" id="mwWA">! Square brackets define a routine. This is the Main routine, which takes no arguments.</span> <span class="p" id="mwWQ">[</span> <span class="nf" id="mwWg">Main</span><span class="p" id="mwWw">;</span> <span class="k" id="mwXA">print</span> <span class="s2" id="mwXQ">"Hello, World!</span><span class="se" id="mwXg">^</span><span class="s2" id="mwXw">"</span><span class="p" id="mwYA">;</span> <span class="p" id="mwYQ">];</span>

The procedual parts, statements and operators, are largely borrowed from C, with the notable exception that -->x instead of [x] is used to take array subscripts. Routines are defined in square brackets, as in the Main routine above, but called with round brackets as in C. The character @ is used to escape characters and to invoke raw Z-machine opcodes.

Inform 6 library

The Inform system also contains the Inform library, which automates nearly all the most difficult work involved in programming interactive fiction; specifically, it includes a text parser that makes sense of the player's input, and a world model that keeps track of such things as objects (and their properties), rooms, doors, the player's inventory, etc.

The Inform compiler does not require the use of the Inform library. There are several replacement libraries available, such as Platypus and InformATE, a library that codes Inform in Spanish. Some games may use no library at all, such as a direct port of Zork into Inform 6.

Example game

Here is an example of Inform 6 source code that makes use of the Inform library. The Inform 6 code sample below is usable in Inform 7, but not without special demarcation indicating that it is embedded legacy code.

<span id="mwhA"></span><span class="k" id="mwhQ">Constant</span> <span class="no" id="mwhg">Story</span> <span class="s2" id="mwhw">"Hello Deductible"</span><span class="p" id="mwiA">;</span> <span class="k" id="mwiQ">Constant</span> <span class="no" id="mwig">Headline</span> <span class="s2" id="mwiw">"</span><span class="se" id="mwjA">^</span><span class="s2" id="mwjQ">An Interactive Example</span><span class="se" id="mwjg">^</span><span class="s2" id="mwjw">"</span><span class="p" id="mwkA">;</span> <span class="k" id="mwkQ">Include</span> <span class="s2" id="mwkg">"Parser"</span><span class="p" id="mwkw">;</span> <span class="k" id="mwlA">Include</span> <span class="s2" id="mwlQ">"VerbLib"</span><span class="p" id="mwlg">;</span> <span class="p" id="mwlw">[</span> <span class="nf" id="mwmA">Initialise</span><span class="p" id="mwmQ">;</span> <span class="n" id="mwmg">location</span> <span class="o" id="mwmw">=</span> <span class="n" id="mwnA">Living_Room</span><span class="p" id="mwnQ">;</span> <span class="s2" id="mwng">"Hello World"</span><span class="p" id="mwnw">;</span> <span class="p" id="mwoA">];</span> <span class="k" id="mwoQ">Object</span> <span class="vg" id="mwog">Kitchen</span> <span class="s2" id="mwow">"Kitchen"</span><span class="p" id="mwpA">;</span> <span class="k" id="mwpQ">Object</span> <span class="vg" id="mwpg">Front_Door</span> <span class="s2" id="mwpw">"Front Door"</span><span class="p" id="mwqA">;</span> <span class="k" id="mwqQ">Object</span> <span class="vg" id="mwqg">Living_Room</span> <span class="s2" id="mwqw">"Living Room"</span> <span class="kd" id="mwrA">with</span> <span class="n" id="mwrQ">description</span> <span class="s2" id="mwrg">"A comfortably furnished living room."</span><span class="p" id="mwrw">,</span> <span class="n" id="mwsA">n_to</span> <span class="n" id="mwsQ">Kitchen</span><span class="p" id="mwsg">,</span> <span class="n" id="mwsw">s_to</span> <span class="n" id="mwtA">Front_Door</span><span class="p" id="mwtQ">,</span> <span class="kd" id="mwtg">has</span> <span class="n" id="mwtw">light</span><span class="p" id="mwuA">;</span> <span class="k" id="mwuQ">Object</span> <span class="p" id="mwug">-></span> <span class="vg" id="mwuw">Salesman</span> <span class="s2" id="mwvA">"insurance salesman"</span> <span class="kd" id="mwvQ">with</span> <span class="nb" id="mwvg">name</span> <span class="s1" id="mwvw">'insurance'</span> <span class="s1" id="mwwA">'salesman'</span> <span class="s1" id="mwwQ">'man'</span><span class="p" id="mwwg">,</span> <span class="n" id="mwww">description</span> <span class="s2" id="mwxA">"An insurance salesman in a tacky polyester</span> <span class="s2" id="mwxQ"> suit. He seems eager to speak to you."</span><span class="p" id="mwxg">,</span> <span class="n" id="mwxw">before</span> <span class="p" id="mwyA">[;</span> <span class="n" id="mwyQ">Listen</span><span class="p" id="mwyg">:</span> <span class="k" id="mwyw">move</span> <span class="n" id="mwzA">Insurance_Paperwork</span> <span class="k" id="mwzQ">to</span> <span class="n" id="mwzg">player</span><span class="p" id="mwzw">;</span> <span class="s2" id="mw0A">"The salesman bores you with a discussion</span> <span class="s2" id="mw0Q"> of life insurance policies. From his</span> <span class="s2" id="mw0g"> briefcase he pulls some paperwork which he</span> <span class="s2" id="mw0w"> hands to you."</span><span class="p" id="mw1A">;</span> <span class="p" id="mw1Q">],</span> <span class="kd" id="mw1g">has</span> <span class="n" id="mw1w">animate</span><span class="p" id="mw2A">;</span> <span class="k" id="mw2Q">Object</span> <span class="p" id="mw2g">-></span> <span class="p" id="mw2w">-></span> <span class="vg" id="mw3A">Briefcase</span> <span class="s2" id="mw3Q">"briefcase"</span> <span class="kd" id="mw3g">with</span> <span class="nb" id="mw3w">name</span> <span class="s1" id="mw4A">'briefcase'</span> <span class="s1" id="mw4Q">'case'</span><span class="p" id="mw4g">,</span> <span class="n" id="mw4w">description</span> <span class="s2" id="mw5A">"A slightly worn, black briefcase."</span><span class="p" id="mw5Q">,</span> <span class="kd" id="mw5g">has</span> <span class="n" id="mw5w">container</span><span class="p" id="mw6A">;</span> <span class="k" id="mw6Q">Object</span> <span class="p" id="mw6g">-></span> <span class="p" id="mw6w">-></span> <span class="p" id="mw7A">-></span> <span class="vg" id="mw7Q">Insurance_Paperwork</span> <span class="s2" id="mw7g">"insurance paperwork"</span> <span class="kd" id="mw7w">with</span> <span class="nb" id="mw8A">name</span> <span class="s1" id="mw8Q">'paperwork'</span> <span class="s1" id="mw8g">'papers'</span> <span class="s1" id="mw8w">'insurance'</span> <span class="s1" id="mw9A">'documents'</span> <span class="s1" id="mw9Q">'forms'</span><span class="p" id="mw9g">,</span> <span class="n" id="mw9w">description</span> <span class="s2" id="mw-A">"Page after page of small legalese."</span><span class="p" id="mw-Q">;</span> <span class="k" id="mw-g">Include</span> <span class="s2" id="mw-w">"Grammar"</span><span class="p" id="mw_A">;</span>

Notable games developed in Inform 6 or earlier versions

• Curses, by Graham Nelson (1993), the first game ever written in the Inform programming language. Considered one of the first "modern" games to meet the high standards set by Infocom's best titles.
• Zork: The Undiscovered Underground (1997), written by Marc Blank & Michael Berlyn, programmed by Gerry Kevin Wilson. Given away free by Activision to promote the release of Zork: Grand Inquisitor.
• Anchorhead, by Michael S. Gentry (1998) is a highly rated horror story inspired by H. P. Lovecraft's Cthulhu Mythos.
• Photopia, by Adam Cadre (1998), the first almost entirely puzzle-free game. Won the annual Interactive Fiction Competition in 1998.
• Varicella by Adam Cadre (1999). It won four XYZZY Awards in 1999 including the XYZZY Award for Best Game, and had a scholarly essay written about it.
• Galatea, by Emily Short (2000). Galatea is focused entirely on interaction with the animated statue of the same name. Galatea has one of the most complex interaction systems for a non-player character in an interactive fiction game. Adam Cadre called Galatea "the best NPC ever".
• Slouching Towards Bedlam, by Star C. Foster and Daniel Ravipinto (2003). Set in a steampunk setting, the game narratively integrates meta-game functionality (saving, restoring, restarting) into the game world itself. The game won two XYZZY Awards and received the highest average score of any game in the Interactive Fiction Competition as of 2006.

Inform 7

On April 30, 2006, Graham Nelson announced the beta release of Inform 7 to the rec.arts.int-fiction newsgroup. Inform 7 consists of three primary parts: The Inform 7 IDE with development tools specialized for testing interactive fiction, the Inform 7 compiler for the new language, and "The Standard Rules" which form the core library for Inform 7. Inform 7 also relies on the Inform library and Inform compiler from Inform 6. The compiler compiles the Inform 7 source code into Inform 6 source code, which is then compiled separately by Inform 6 to generate a Glulx or Z-code story file. Inform 7 also defaults to writing Blorb files, archives which include the Z-code together with optional "cover art" and metadata intended for indexing purposes. The full set of Inform 7 tools are currently available for Mac OS X, Microsoft Windows and Linux (since 2007).

As of 2023, Inform 7 and its tools remain under development. Since April 2022, Inform 7 is open source and developed on GitHub.

Inform 7 was named Natural Inform for a brief period of time, but was later renamed Inform 7. This old name is why the Inform 7 compiler is named "NI".

Inform 7 IDE

Inform 7 comes with an integrated development environment (IDE) for Mac OS X, Microsoft Windows and Linux. The Mac OS X IDE was developed by Andrew Hunter. The Microsoft Windows IDE was developed by David Kinder. The Linux IDE (known as GNOME Inform) was developed by Philip Chimento.

The Inform 7 IDE includes a text editor for editing Inform 7 source code. Like many other programming editors it features syntax highlighting. It marks quoted strings in one color. Headings of organizational sections (Volumes, Books, Chapters, Parts, and Sections) are bolded and made larger. Comments are set in a different color and made slightly smaller.

The IDE includes a built-in Z-code interpreter. The Mac OS X IDE's interpreter is based on the Zoom interpreter by Andrew Hunter, with contributions from Jesse McGrew. The Microsoft Windows IDE's interpreter is based on WinFrotz.

As a developer tests the game in the built-in interpreter, progress is tracked in the "skein" and "transcript" views of the IDE. The skein tracks player commands as a tree of branching possibilities. Any branch of the tree can be quickly re-followed, making it possible to retry different paths in a game under development without replaying the same portions of the game. Paths can also be annotated with notes and marked as solutions, which can be exported as text walkthroughs. The transcript, on the other hand, tracks both player commands and the game's responses. Correct responses from the game can be marked as "blessed". On replaying a transcript or a branch of the skein, variations from the blessed version will be highlighted, which can help the developer find errors.

The IDE also provides various indices into the program under development. The code is shown as a class hierarchy, a traditional IF map, a book-like table of contents, and in other forms. Clicking items in the index jumps to the relevant source code.

The IDE presents two side-by-side panes for working in. Each pane can contain the source code being worked on, the current status of compilation, the skein, the transcript, the indices of the source code, a running version of the game, documentation for Inform 7 or any installed extensions to it, or settings. The concept is to imitate an author's manuscript book by presenting two "facing pages" instead of a multitude of separate windows.

Inform 7 programming language

Notable features include strong bias towards declarative rule-based style of programming and ability to infer types and properties of objects from the way they are used. For example, the statement "John wears a hat." creates a "person" called "John" (since only people are capable of wearing things), creates a "thing" with the "wearable" property (since only objects marked "wearable" are capable of being worn), and sets John as wearing the hat.

Another notable aspect of the language is direct support for relations which track associations between objects. This includes automatically provided relations, like one object containing another or an object being worn, but the developer can add their own relations. A developer might add relations indicating love or hatred between beings, or to track which characters in a game have met each other.

Inform 7 is a highly domain-specific programming language, providing the writer/programmer with a much higher level of abstraction than Inform 6, and highly readable resulting source code. General-purpose logical and arithmetic statements are written in natural language (see e.g. the "Physics" example in The Inform Recipe Book).

In early Inform 7, the compiler translates the code to Inform 6, much like CFront did with C++ and C. The current compiler (as of version 10 of 2022) is additionally able to translate the code directly to C for a native executable, and to generate an "index mini-website" describing the story.

Example game

Statements in Inform 7 take the form of complete sentences. Blank lines and indentation are in some places structurally significant. The basic form of an Inform 7 program is as follows:

<span id="mwAZY"></span><span class="gh" id="mwAZc">"Hello, World!" by "I.F. Author"</span> The world is a room. When play begins, say <span class="s2" id="mwAZg">"Hello, World!"</span>

The following is a reimplementation of the above "Hello Deductible" example written in Inform 7. It relies on the library known as "The Standard Rules" which are automatically included in all Inform 7 compilations.

<span id="mwAZw"></span><span class="gh" id="mwAZ0">"Hello Deductible" by "I.F. Author"</span> The story headline is <span class="s2" id="mwAZ4">"An Interactive Example"</span>. The Living Room is a room. <span class="s2" id="mwAZ8">"A comfortably furnished living room."</span> The Kitchen is north of the Living Room. The Front Door is south of the Living Room. The Front Door is a door. The Front Door is closed and locked. The insurance salesman is a man in the Living Room. The description is <span class="s2" id="mwAaA">"An insurance salesman in a tacky polyester suit. He seems eager to speak to you."</span> Understand <span class="s2" id="mwAaE">"man"</span> as the insurance salesman. A briefcase is carried by the insurance salesman. The description is <span class="s2" id="mwAaI">"A slightly worn, black briefcase."</span> Understand <span class="s2" id="mwAaM">"case"</span> as the briefcase. The insurance paperwork is in the briefcase. The description is <span class="s2" id="mwAaQ">"Page after page of small legalese."</span> Understand <span class="s2" id="mwAaU">"papers"</span> or <span class="s2" id="mwAaY">"documents"</span> or <span class="s2" id="mwAac">"forms"</span> as the paperwork. Instead of listening to the insurance salesman: say <span class="s2" id="mwAag">"The salesman bores you with a discussion of life insurance policies. From his briefcase he pulls some paperwork which he hands to you."</span>; move the insurance paperwork to the player.

Notable games written in Inform 7

Mystery House Possessed (2005), by Emily Short, was the first Inform 7 game released to be public. It was released as part of the "Mystery House Taken Over" project.

On March 1, 2006, Short announced the release of three further games: Bronze (an example of a traditional puzzle-intensive game) and Damnatio Memoriae (a follow-up to her award-winning Inform 6 game Savoir-Faire) were joined by Graham Nelson's The Reliques of Tolti-Aph (2006). When the Inform 7 public beta was announced on April 30, 2006, six "worked examples" of medium to large scale works were made available along with their source code, including the three games previously released on March 1.

Emily Short's Floatpoint was the first Inform 7 game to take first place in the Interactive Fiction Competition. It also won 2006 XYZZY Awards for Best Setting and Best NPCs. Rendition, by nespresso (2007), is a political art experiment in the form of a text adventure game. Its approach to tragedy has been discussed academically by both the Association for Computing Machinery and Cambridge University. According to writer Aaron A. Reed, Inform 7's friendlier syntax and IDE allowed Jeremy Freese to create Violet (2008).