DocsFormat v2

Everything you need to ship a game UI.

Start with the quick start. Every page is also available as Markdown, and llms.txt indexes them for AI tools.

Start

Draw a screen and run it in your game.

Quick startMake your first game UI screen in Envy (alpha), preview it, and run it in Godot 4 or a web page. Takes about ten minutes.
The editorHow Envy's game UI editor is laid out, the tools on the canvas, previewing, saving and the keyboard shortcuts you'll use every day.

Layout, style and components.

LayoutAnchors, offsets and auto layout in Envy work like Godot's Control anchors and box containers, so one layout holds at 16:9, 21:9, 16:10 and 4:3.
Style, tokens and fontsFills, gradients, image fills, borders, shadows, blur, text styles, color tokens and embedded fonts in Envy, and how each maps to Godot and CSS.
ComponentsComponents, instances, variants, overrides and component properties in Envy. Build a button once and keep every copy on every screen in step.

Data, events, lists, motion, focus and translations.

Data, events and listsBind Envy layers to game data, emit named events from buttons, run actions without code, preview scenarios and repeat a row for every item in an array.
Animation, transitions and overlaysKeyframe animation in Envy with seven easing curves, screen transitions (fade, slide, scale) and overlay screens, identical in Godot and the browser.
Keyboard and gamepad focusMake Envy menus playable with arrow keys, a d-pad or a stick. Automatic focus by position, explicit neighbours, initial focus and focus rings in Godot and the web.
LocalizationTranslate an Envy game UI with keyed text and per-language tables, preview a pseudo-locale to catch clipping, export CSV for translators and switch language at runtime.

Exports, both runtimes, the CLI and AI agents.

Handoff and exportExport an Envy game UI as a Godot package, playable HTML, the raw document or an AI handoff package with AGENTS.md, a contract, screenshots and typed code.
Godot runtimeRun Envy game UI in Godot 4.3+ with the EnvyUI node. Real Control nodes, data binding, events, animation, overlays, translations and hot reload while the game runs.
Web runtimeRun Envy game UI in any web page or web game with one dependency-free script. Mount a document, set data, listen to events, run overlays and switch language.
CLIThe envy command-line tool validates Envy documents in CI, prints the event and data contract, outlines screens, writes handoff files and prints the JSON Schema.
For AI coding agentsHow AI coding agents work with Envy - the AI handoff package, the event and data contract, the JSON Schema, the CLI, llms.txt and Markdown docs.

The file format and where the runtimes differ.

The document formatReference for the .envy.json game UI document - boards, nodes, layout, style, components, interaction, bindings, focus, lists, scenarios, localization and animation.
Known differencesWhere Envy's Godot and web runtimes draw or behave slightly differently - fonts, clipping, shadows, blur, group opacity, focus search and lists.