Skip to content

Inkforge documentation ​

Inkforge is a browser-only studio for authoring and playing YAML + Lua text adventures. A project is a folder of text files and assets; the studio edits it, runs it, and packs it for sharing, all in one tab with no server.

Two trees, two audiences:

AuthoringWriting a scenario: the YAML schema, the Lua API, the canvas, UI, tools, audio, and what to do when something goes wrong
DevelopmentWorking on Inkforge itself: the toolchain, the module map, the invariants, and the rules to follow when changing code

Authors should start at Authoring. Developers should start at Development — which links into the authoring tree, since the authored surface is much of what the code implements.