Skip to content
| Marketplace
Sign in
Visual Studio Code>Programming Languages>Inform EcosystemNew to Visual Studio Code? Get it now.
Inform Ecosystem

Inform Ecosystem

jeffnyman

|
11 installs
| (0) | Free
Write, compile, play and test Inform stories in VS Code, with Inform 7's documentation, Index and extensions; plus language support for Inform 6, Inweb, Intest and Preform.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

Inform Ecosystem

Language and tool support for the Inform ecosystem in Visual Studio Code.

Inform Ecosystem

Inform is a family of tools for writing interactive fiction, and this extension aims to support all of it from one place:

Language File extensions What you get
Inform 7 source .ni, .i7 Syntax highlighting; folding by heading and by rule indentation; an outline of headings, rules, phrases and tables; snippets
Inform 7 extensions .i7x As above, plus rubric, credits and documentation sections
Inform 6 .inf, .i6, .h, .i6h Syntax highlighting including library functions, actions, attributes and opcodes; an outline of objects, classes, routines, constants and verbs; snippets
Inform 6 templates .i6t Highlighting for the literate template files used by Inform 7
Preform .preform Highlighting for Inform's grammar-definition syntax
Intest .intest Highlighting for Delia test recipes
Inweb .w, .inweb Highlighting for literate-programming webs

Inform 6 code included in Inform 7 source between (- and -) is colored as Inform 6, with (+ ... +) references back to Inform 7 marked. A [preform] comment before (- colors the block as Preform instead. Texts used with Vorple's execute JavaScript command, or preceded by [js], are colored as JavaScript.

The .i6 and .i6h extensions are not official. Inform 6 traditionally used .inf and .h, which collide with other languages, so the i6 variants are offered as an unambiguous alternative.

How it works

Highlighting uses TextMate grammars in JSON, with Oniguruma regular expressions. VS Code tokenises each file with the grammar as you type. Folding for Inform 7 is a small folding-range provider, since headings and indentation are structural in Inform 7 and a grammar alone cannot express that.

The outline (the Outline view, breadcrumbs, and "Go to Symbol in Editor") comes from a line-based scan that relies on Inform's own conventions: headings stand alone between blank lines, Inform 7 rule and phrase preambles start at the left margin and end with a colon, and Inform 6 declarations start at the left margin with their bodies indented.

Snippets: type a prefix such as room, instead, action, table or to in an Inform 7 file, or object, routine, verb, objectloop or story in an Inform 6 file, and accept the suggestion.

Compiling from VS Code

With an Inform 7 file open, the run button in the editor title bar compiles the enclosing .inform project the way the Inform IDE does: inform7, then inform6, and for a release also inblorb. Errors appear in the Problems panel, linked to the source line, and the full compiler output is in the "Inform" output channel. The commands are also in the palette under "Inform:" and in the Explorer context menu of a project folder.

Command What it does
Inform: New Project... Asks for a title, an author and a folder, creates Title.inform with a Source/story.ni that compiles straight away, and opens it
Inform: Compile Project (debug build) inform7 then inform6 with debugging on; output in the project's Build folder
Inform: Release Project Release build; bound into a Blorb if the project's settings ask for one and Release.blurb exists
Inform: Play Compiled Story Opens the newest story file in Build in the player tab
Inform: Play Compiled Story in External Interpreter Opens it with your system's associated application instead
Inform: Compile Inform 6 File Compiles a stand-alone .inf with inform6, to Glulx by default
Inform: Show Compiler Locations Prints which compilers and Internal folder will be used

The project's own settings are honoured where they exist: the story format (Glulx or Z-machine), whether to create a Blorb, and the predictable-random option come from Settings.plist written by the IDE. Projects without one compile to Glulx unless informEcosystem.inform7.defaultFormat says otherwise. A bare project folder with only Source/story.ni works; the uuid.txt that inform7 requires is created for you.

Where the compilers come from

The extension does not bundle compilers. It looks, in order, at the informEcosystem.compilersPath setting, the INFORM_COMPILERS environment variable, a Windows-Inform7\Build\Compilers folder near the workspace (the layout produced by the companion inform-builder project), compilers fetched with Inform: Download Compilers, an installed Inform IDE (on Windows, wherever the Inform installer recorded it, otherwise Program Files\Inform\Compilers; on macOS, Inform.app), and the PATH. The Internal folder is taken from informEcosystem.internalPath or found beside the compilers.

If you have no Inform installation, run Inform: Download Compilers, or choose Download Compilers when a compile reports that none were found. It fetches a complete Inform 10.1.2 toolchain for Windows, Linux or macOS (about 51 MB) from the Informant toolchain releases, checks it against a pinned SHA-256, and unpacks it into the extension's own storage. Nothing else on your system is changed.

Reading the documentation

Inform: Open Documentation (the book button in the title bar of an Inform 7 file) opens Writing with Inform beside your source. Links between pages stay in the panel, web links open in your browser, and Back, Forward and Go to... (Writing with Inform, The Inform Recipe Book, the General Index and the example indexes) sit in the panel's title bar; Alt+Left and Alt+Right, or the mouse's back and forward buttons, also work, and Ctrl+F searches the page. An example's paste button inserts its code at the cursor of the Inform source you were last editing.

The pages are read from the documentation that comes with the compilers: the Inform for Windows IDE's Documentation folder, opening at its contents page, or the copy inside compilers fetched with Inform: Download Compilers. To use another copy, set informEcosystem.documentationPath to that folder. If none is found, the extension offers to download the compilers or to open the online copy instead. In a dark colour theme the pages are shown inverted, with their colours' hues and the pictures kept as they are; set informEcosystem.documentation.colorTheme to light to keep them black on white. In the Windows IDE's documentation, an example's "create a new project" button starts New Project with the example's title offered and its source as the story.

The Index

Inform: Open Index (the tree button in the title bar of an Inform 7 file) shows the Index that Inform writes into the project on every compile: Welcome, Contents, Actions, Kinds, Phrasebook, Rules, Scenes and World, through Go to... in the panel's title bar, with the same Back and Forward as the documentation. It reloads when you recompile. Within it:

  • the paste buttons insert the phrase or rule at the cursor of your source;
  • links to a line of the source open the source there, with the line selected;
  • the blue "?" links open that section of the documentation, in either the Windows IDE's or the downloaded compilers' copy;
  • the boxes that show and hide parts of a page work as in the IDE.

The Index's images come from Inform's own folders, so they need the documentation or the downloaded compilers. Its links to an extension's documentation open that extension's pages in their own panel (see below).

Installing extensions

Inform: Install Extension... lists the 220 extensions in the community library for Inform 10.1 (the catalog Informant publishes), marking those you already have. Pick one and you are told what it will bring with it: the extensions it includes that you do not yet have, those it will use that are already installed or built into Inform, and anything it needs that the catalog cannot supply. Each file is checked against the catalog's size and SHA-256 before anything is written.

Inform finds extensions in two places, and either can be used:

  • All projects: Documents/Inform/Extensions, shared by every project and by the Inform IDE (or your informEcosystem.externalPath);
  • This project: the story's own Story.materials/Extensions, seen only by that project, and preferred by Inform when both have a copy.

The confirmation offers both; informEcosystem.extensions.installLocation decides which is the default button (all projects, unless set to project).

Inform: Open Extension Documentation shows the documentation of the extensions available to the current project: those built into Inform, those installed for all projects, and the project's own. Inform writes these pages each time they are wanted, into the extension's storage, so they are always current and nothing is written to your Inform folder. The Index's extension links and Manage Installed Extensions open them too.

Inform: Manage Installed Extensions... lists what is installed in both places, to read the documentation of, open, reveal or remove, and to upgrade when the catalog has a newer version. An upgrade brings what the newer version needs, replaces the old file in the same place, and warns first if another installed extension needs the old version. Only unchanged copies from the catalog can be removed or upgraded here; your own extensions, and edited copies, are never deleted or replaced.

Testing

Every Test me with "..." sentence in a project's story.ni is a test. They appear in VS Code's Testing view, under the project, and with a run button beside the sentence in the source.

Running them compiles the project as a test build (debug, with Inform's predictable random outcomes) into Build/tests.ulx or tests.z8, leaving the playable story alone. The story is then run with no window and sent test me, so Inform plays the script itself, just as in the IDE. Its output is compared with the expected output kept in Story.materials/Tests/<name>.txt:

  • the first run of a test records its output as the expected output;
  • after that, any difference fails the test, with a side-by-side comparison of the expected and actual output;
  • if the change is intended, Accept Test Output (right-click the test, or its project for all of them) makes the latest output the expected output.

Both Glulx and Z-machine projects can be tested. A test takes a few milliseconds once the project is compiled.

Recording a test. Rather than write a Test sentence, you can play one: press Record in the corner of the player tab, and the story restarts from the beginning; play as you like, then press Stop. You are asked for a name, and a sentence such as Test lamp with "take lamp / inventory". is added to the end of story.ni, where it runs like any other test (and in the Inform IDE's own test command too). Characters a Test sentence cannot hold (a double quote, /, square brackets) are replaced, and you are told.

About the engines. Tests run in the extension itself, not in the player: the Glulxe and Bocfel interpreters from the emglken package, as WebAssembly, in engines/. They add about 0.7 MB to the extension. Parchment, the player, contains the same interpreters, but the code that drives them is built into Parchment with its browser interface, and emglken's driver cannot load Parchment's copies: they come from a newer build than the latest emglken release. If a later emglken release matches Parchment again, the test runner could use Parchment's interpreters and ship only emglken's small driver files, dropping most of that 0.7 MB; see scripts/copy-engines.mjs.

Playing stories in VS Code

Story files open in a player tab: .ulx and .gblorb (Glulx), and .z3, .z4, .z5, .z8 and .zblorb (Z-machine). After a successful compile the story opens beside your source by default (informEcosystem.openStoryAfterCompile), and when the file changes on disk, for example after the next compile, the player restarts it. The corner of the tab has Restart, and Record for recording a test (see Testing). Saves and autosaves are kept in the editor's storage, per story.

The interpreter is Parchment, in the same "for Inform 7" bundle that Inform's own Release along with an interpreter ships, so what you see in VS Code is what players will see on the web: Glulxe for Glulx and Bocfel for the Z-machine, both compiled to WebAssembly. Version 6 Z-machine files are the one format it does not play. The bundle is fetched at build time (npm run fetch-parchment) and is not part of this repository; see THIRD_PARTY_NOTICES.md for its licences.

Status

In place: highlighting, folding, outline and snippets for every language; compiling and playing; downloading compilers; new projects; the documentation and the Index; installing and documenting extensions; and testing, including recording tests in the player. See the CHANGELOG.

Acknowledgements

Parts of the grammars were informed by Natrium729's Inform 6 and Inform 7 extensions.

Much of the IDE side (downloading compilers, the documentation and Index viewers, installing extensions, and testing) follows Informant, an Inform development environment for VS Code by OpcodeASM, whose compiler packages and extension catalog this extension downloads.

Stories are played by Parchment and tested with the interpreters of emglken, both by Dannii Willis.

See THIRD_PARTY_NOTICES.md for licences.

Licence

MIT; see LICENSE.

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
  • Your Privacy Choices
  • Consumer Health Privacy
© 2026 Microsoft