Introduction
Introductionπ
LocalGPT turns a Markdown document, a song or a screenplay into a 3D world you can walk through and edit. A world is an Open World Format package: the scene, its assets and the history of every change.
The desktop app is native Rust: eframe and egui draw the panels, and Bevy renders the world. Your own coding agent can work in a terminal beside it or connect over MCP. LocalGPT provides the world, editing tools and local API; the agent provides its own model and login.
Choose a starting pointπ
| I want to⦠| Start here |
|---|---|
| Open a document, song or world | The desktop app |
| Turn a screenplay into a previs board | localgpt.md, then the previs workflow |
| Build a world with my coding agent | Quick start and MCP server |
Edit a .world from a script or CI | localgpt world |
| Host a world for other people | Collaborative sessions |
| Open a world in a browser | localgpt.world |
The piecesπ
- LocalGPT app β documents, songs and live
.worldpackages in one native window, with history, a timeline, an inspector and terminals. - Gen β the world builder and its 88 MCP tools, also available as a standalone binary for headless work and collaborative sessions.
- Previs β deterministic screenplay-to-board drafting in the browser or on the command line.
localgpt worldβ a packageβs command line and MCP shim: commit, undo, inspect history, verify and drive an open canvas.- localgpt.world β the gallery and browser viewer for the same packages.
What a world containsπ
scene.world/
βββ manifest.json # the world at its current head
βββ ops.jsonl # every committed change
βββ assets/ # meshes, textures and sounds by content hash
βββ AGENTS.md # how an external agent can edit this world
One authority writes at a time. While an app has the package open, edits from the window, the CLI and agents all go through its local API. With no app open, localgpt world commits directly to the folder. Both paths produce the same attributed, undoable and branchable history.
Install LocalGPT or follow the Quick start.