Mojulo README
The full upstream README, mirrored here for reference. Install config, tool schemas, adoption signals, and an original overview live on the Mojulo listing page.
Mojulo
Mojulo is a 3D compiler for coding agents: an MCP server that runs wherever your agent runs, on your machine or in the throwaway Linux box it gives itself, where the agent you already run (Claude Code, Codex, any MCP host, or a chat app that can open a Linux box: Claude, ChatGPT with Codex, Grok, Meta Muse) builds objects, walkable worlds and games by conversation, and what gets stored is source, not a mesh. Every artifact is a small deterministic recipe: a few hundred bytes of JSON, or an OpenSCAD program, that a kernel compiles back to the same geometry on every read, byte for byte, and that emits to Godot, Blender, Unity, Unreal, glTF, OpenUSD, or print-ready STL / 3MF at true scale. Small enough to carry home from a box and re-mint on your own disk. A compiler, not a generator: you edit and diff the recipe like code, and renders are disposable. No API key, no account, no telemetry. Your agent does the thinking; mojulo holds the state and does the geometry.
Quickstart
Needs Node 22.12+ and an MCP-capable coding agent (Claude Code or Codex; Claude Desktop works too). init finds the hosts on your machine, asks once per host, and opens the dashboard at http://localhost:3001. Everything lands in ~/.mojulo/. Then open a fresh agent session and ask: "what is this?"
The first install is the big one: npx pulls a ~27 MB tarball whose native dependencies land at about 590 MB on disk (2.0.6 measured 885 MB before the local search model and its runtime became the opt-in mojulo install recall; semantic_search ranks lexically without them). Most of the rest is puppeteer-core (local headless Chrome for stills) and better-sqlite3. Nothing in the list reaches the network on its own; the per-dependency sheet is in docs/tech-requirements.md. Verified on macOS (Apple Silicon) and on native Windows under Claude Code (init and a first render). On Linux x64 the test suite runs in CI, and the agent-box path below has been run to a mint and an export from the Claude app and web, ChatGPT work mode with Codex, Grok chat and Meta Muse.
Wire it by hand instead
Open the dashboard on its own with npx -y -p mojulo mojulo-ui. The same bin is a CLI over the tool registry: npx mojulo tools, npx mojulo help mint_solid, npx mojulo call version.
Where it runs, three things you can add
Mojulo runs wherever your agent runs, and a recipe minted in one place re-mints byte for byte in the other. Two shapes, one install.
In your agent's box, nothing on your machine. One sentence to the agent installs mojulo in the throwaway Linux box it gives itself:
- The Claude app (macOS, Windows, web, iOS); Grok chat; Meta Muse (iOS, web, macOS app, one session across all three): Open a Linux box and install the mojulo npm package in it.
- ChatGPT (Codex included): In work mode, open a Linux box and install the mojulo npm package in it.
Each of those has been run this way, from the sentence to a mint and an export handed back. You get
the same recipes and the same exports, as files: the export result names this host's door, an
artifact page, a PR or a file card. The box has no dashboard you can reach, a scene-to-PNG bake needs a
browser it may not be allowed to fetch, and it is gone when the session ends, so ask for the bundle
(one zip: world.html, mesh, print STL for literal-scale objects, recipe.json, README) and keep
the recipe. A box with no MCP client never sends initialize, so tell the agent to run
npx mojulo orient first: it prints what an MCP client is handed at connect, translated to the
shell, and points at the routing index. Claude's box built a 47-part phone at true scale this way and handed back the glTF;
Grok chat's sandbox minted a city from the shell. Blender installs in those boxes too.
On your machine: macOS, Windows, Linux. npx mojulo init wires mojulo into the agents it finds,
opens the dashboard at localhost:3001, keeps everything under ~/.mojulo/, and probes your PATH for
the optional local workers (Blender, a slicer, OpenSCAD, the game engines). This is the whole loop, and
where a recipe from a box comes home to.
Who has run it where. 
persistent (your machine; ~/.mojulo/ stays) · 
ephemeral (the web
agent's throwaway Linux box; keep the recipe). Blank means not verified yet, not "does not work".
| agent | macOS | Windows | Web Agent Linux Box (Headless) |
|---|---|---|---|
| Claude Code | | | |
| Claude app (macOS, Windows, web, iOS) | | | |
| ChatGPT (work mode; Codex) | Codex | | |
| Hermes Agent | | ||
| Grok (Build; chat) | Build | | |
| Meta Muse (iOS, web, macOS app; one session across them) | |
Three things are opt-in, and the choice is the same in both places:
| add | with | what you get |
|---|---|---|
| creative (installed by default) | plain npm install | worlds, audio, fonts for wordmarks, exact booleans, OpenSCAD-in-process, sharp for skins and sprite sheets. npm install --omit=optional sheds it for a kernel-only install that still mints diagrams, floorplans, workbench solids and exports GLB and STL. |
| recall | mojulo install recall | the embedding model behind semantic_search. Without it, search still answers, ranking by the words in your ask (about 480 MB of runtime plus a 130 MB model, kept under ~/.mojulo/ so it survives upgrades). Most sessions never need it: the agent reads the tool index and the vocab cards directly. |
| chatbot | mojulo install chatbot | the bot factory: build, deploy and operate chatbots. Needs an LLM key of its own and Docker for the default deploy, so this one is for your machine, not a temporary box. It installs recall first, because a bot's preview search must rank the way the deployed bot does. |
mojulo install with no argument prints which of the three are present.
Six things to say to it
Each one is a sentence to your agent, the tool it reaches for, and the recipe that gets stored. Every example below runs keyless and offline.
1. "Make me a coffee mug, 90 mm tall"
The agent calls mint_solid { kind: 'workbench' }. This is the whole stored recipe: a lathe for the body, a sweep for the handle, real centimetres.
It is served shaded and turnable at /sketches/<ref>, and the same ref downloads as model.stl or model.3mf at 90 mm tall, z-up, slicer-ready. "Make the handle thicker" is update_sketch setting one radius; nothing is re-minted. measure_solid reads wall thickness, overhangs and closure off the recipe before you print, and if a slicer is installed the print gate stamps layers, time and filament beside the file. A bore through the body is a cuts line naming the body and the sweep that bores it; exact: true on that line composes it with Manifold instead of the sampled grid, so the lip is a true circle and a 40 mm disc measures 40, in the viewer, the .glb and the print.
2. "Write me a Raspberry Pi 4 case tray in OpenSCAD"
The agent calls mint_solid { kind: 'scad' } and the program is the recipe, stored verbatim:
with parts: { tray: 'tray();', standoffs: 'standoffs();' }. OpenSCAD itself meshes it on every read, in-process as WebAssembly with the Manifold backend, so booleans are exact and every edge is sharp. color() is the tint; each named part is a render group a hinge in movers can swing. The same ref serves the orbit view, the .glb, the engine packs and model.stl at 91 × 62 × 14 mm as written; model.scad hands the source back unchanged. Change wall_h with update_sketch and the readout names the one part that moved. For what OpenSCAD cannot say, a blended join, a stroked dent, seeded noise, the source calls mojulo_field("<id>") and a field solid from the same recipe is baked in at that spot.
3. "Build a 20 by 24 ft living room with a door on the south wall"
That is the GIF at the top. The agent calls create_sketch { title, manifest: { kind: 'floorplan', … } } and the stored manifest is this:
The L glyph and the seed furnish it: sofa, two chairs, rug, lamp, windows. "Add pot lights to the ceiling" adds "potLights": true and nothing else changes. "levels": [...] stacks it into a building with stairs through the slabs. The same recipe walks in the browser at /world, exports as a .glb, or goes to Blender as an art-pass pack, where a Cycles bake can write traced light back into the mesh's own vertex colours so the lit result runs anywhere at zero runtime cost.
4. "Generate a 3D city at night"
The agent calls compose_world { base: 'city', seed: 42, overrides: { context: { time: 'night', locale: 'east-asia' }, asset: { anchor: 'tower' }, fog: true } }. The whole city is a pure function of the seed: change it for a new city, keep it and the same city regrows on any machine. Open the /scene URL for a dependency-free CSS-3D render, or /world to walk it with WASD. Bases besides city: a transport hub, a K-12 campus, a torch-lit dungeon, a planetary body, a painted landscape, a walkable Cayley graph of a finite group.
5. "Make it walkable, then make it a game, then export it for Godot"
compose_world { base: 'controllable' } gives a live world you drive. Adding game: { mechanics: [...] } to a world makes it a level: reach the exit, survive twenty seconds, collect the relay core. create_game binds levels, a synthesized score and figures into one playable artifact with a typed store (inventory, party, flags) that carries between levels; every level must pass a contract dry-run and a traversal that reached the win condition before the game mints. export_game { target: 'godot' } writes a real Godot 4 project you open and extend. Unity and Unreal get the same data pack plus an importer; the worked Unreal example is docs/examples/unreal-night-run/.
6. "Create a snowman with a top hat"
mint_solid as a part graph: three snowballs, a brimmed hat, twig arms, a carrot nose, coal buttons, a scarf, each part placed by relation to its parent rather than by coordinates. Coloration iterates in place on the same ref. Same doors out: HTML viewer, .glb, .stl.
Also from a sentence: a posed human figure or an animal mid-stride, rigged for glTF or VRM; a six-storey building with a set-back penthouse; an ambient loop or a full score synthesized from seeded math with no samples; a room's layout recovered from a photo you show your agent. The full catalog is in docs/tour.md.
Where it goes
One recipe, several targets, all off the same ref: /api/sketches/<ref>/{svg,scene,world,model.glb,model.stl,model.3mf,model.usdz,model.scad}. Each URL regenerates deterministically on request — geometry byte for byte across platforms; an embedded texture PNG can differ in its compressed bytes while its pixels do not — and every handoff carries a ledger naming what did not travel.
| Target | What you get | The gate |
|---|---|---|
| Browser | A still SVG, a dependency-free CSS-3D scene, a walkable WebGL world. | Your eyes. |
.glb / OpenUSD | glTF with lighting baked into vertex colours (or lit for PBR), rig clips, skinned meshes, VRM bone names; usda / usdz at true scale. | Blender and usdcat, when installed. |
| Godot (first-class) | A real Godot 4 project: project.godot, the versioned kernel scripts, the GLB, export presets. | Headless import and a one-frame run, when MOJULO_GODOT names the binary. |
| Unity / Unreal (gated legs) | A data pack plus a C# editor importer or a Python importer; game packs add a C++ kernel plugin. | A scratch project imported headless, when MOJULO_UNITY / MOJULO_UNREAL name the editor. |
| Blender (art pass) | An art-pass pack with importer scripts, and a Cycles bake of global illumination back into vertex colours. | The importer run headless, when MOJULO_BLENDER names the binary. |
| STL / 3MF | Print-ready at true scale: mm, z-up, colours and instanced repeats in 3MF, process-aware advisories (FDM, SLA, SLS, MJF). | A local slicer run over the 3MF, stamping layers, time and filament. PrusaSlicer and Bambu Studio verified. |
.scad | A program, not a mesh. A scad recipe returns its own source verbatim; a workbench recipe is transpiled term by term into OpenSCAD solids and booleans, with a coverage ledger naming any term that arrived as a frozen polyhedron(). | OpenSCAD re-renders it and checks size and volume against the recipe, when the binary is installed. |
Every export works with nothing installed; the pack is written and the gate reports "skipped" with the reason. Installing the engine adds the machine gate. Gates advise and stamp, none refuse, and no gate ever claims a human looked. Doctrine: docs/bicycles.md.
What stays on your machine
- Recipes live in one SQLite file at
~/.mojulo/mojulo-lite.db. Renders are derived and disposable. - Your cookbook.
save_recipepromotes a recipe to~/.mojulo/data/cookbook, plaincard.md+recipe.jsonfolders in a local git repo with no remote, recallable by intent months later throughsemantic_search. The public mojulo-recipe-book is the same format: clone it, pointMOJULO_RECIPE_BOOKat it, and it adds chapters and whole new kinds without touching core. - Exports are plain files you open in anything. Provider keys, if you ever save one, are AES-256-GCM encrypted at rest.
- No telemetry, no phone-home. Outbound traffic is npm at install, a few one-time lazy downloads on first use (the embedding model, a browser if you have none, ffmpeg, geo data), and an update check when your agent asks for one. Full list: docs/tech-requirements.md.
The control plane is single-operator and localhost-only by default. The stdio MCP has no network surface; the HTTP MCP route 404s unless CONTROL_PLANE_MCP_KEY is set. Don't expose it to the public internet; use a tunnel or Tailscale if you need it remote. Threat model: SECURITY.md. Terms and the operator-owns-consequences posture: TERMS.md, docs/responsibility-model.md. The open-source mojulo is and stays Apache-2.0 with no telemetry; if a hosted mojulo cloud is ever explored, it would be its own opt-in product and the local install would not change or depend on it.
How it works
A Next.js app exposes two faces over one SQLite: an MCP server (stdio for the npm package, HTTP for remote clients) that your agent calls, and a dashboard at localhost:3001 that renders what accumulates. The compiler shape: a recipe is the source (params plus a kind), a kernel is the backend that regenerates it on every read, and each emitter is a target that owns its own frame and unit conversion from the native z-up metre frame. A kernel's output for given params is a compatibility promise over already-minted rows, tested byte-for-byte. Optional local workers (Blender, slicers, mesh sculptors, ComfyUI, Kokoro) are operator-hosted and never dependencies; absence degrades one loop without breaking any.
Also in the box, present by default and never in the way: diagrams and charts, directed images an external model paints, publications and research notebooks, local apps whose inference parks back on your agent, and workflows over the MCPs you already run. The chatbot factory is an opt-in pack (mojulo install chatbot) and is the one artifact that needs an LLM key of its own.
- docs/tour.md — the long tour: everything mojulo makes and who it is for
- docs/AGENT-REFERENCE.md — the substrate, rings, data layout, daemons
- docs/MCP-ARCHITECTURE.md — transport, session binding, deliberation surfaces
- docs/POLYGONIZER-SYNTHESIS.md — the geometry substrate
- docs/tech-requirements.md — measured footprint, engine legs, slicers, workers, platform notes
- docs/local-blender-worker.md, docs/local-slicer-worker.md, docs/local-mesh-worker.md, docs/local-image-worker.md — the optional workers
- AGENTS.md — for non-Claude hosts; docs/chatbot/ — the optional pack
Contributing
One maintainer, no SLA. The wide door is the recipe book: a folder with a card and a recipe, or a pure builder for a whole new kind, needs no change here. In core, bug reports with a pasted recipe (they reproduce exactly), correctness fixes, translations and tests are welcome; concept PRs that change how mojulo works will likely sit, and forks are the open door. Straight up: the maintainer is one person and most read passes are AI-assisted. Full stance and the open requests: CONTRIBUTING.md.