@vgai/editor
v0.5.32
Published
Visual and agent-controllable editor for VGAI game projects.
Maintainers
Readme
vgai editor
The vgai visual editor: a browser-based React app with a Three.js viewport (orbit camera, transform gizmo, marquee selection), hierarchy/inspector/ asset panels, prefabs, undo/redo, play mode (hands the in-memory scene to the real engine runtime, then adopts the live scene so the panels drive live objects), and ingest (opening a vendored game folder as a project mounts it unmodified through the adapter seam; every authored edit writes the game's own code or data — there is no overlay or sidecar, and ownership decides only who records the diff).
License: AGPL-3.0-only (see LICENSE). This matters only if you modify or host the editor itself — offering a modified editor to others (including as a web service) obliges you to share your editor changes. Making games with the editor places zero obligations on your game; the scaffolded project template (template/) is MIT. Commercial terms are available — see the repo-root COMMERCIAL.md.
Make a game with it
npx @vgai/cli@latest create my-gameThat command installs a standalone project and opens its packaged editor.
Later, npm run dev inside the project reopens the editor. The standalone
player page (npm run dev:standalone) serves EXPORTED builds only — until a
game is exported it refuses to mount, so the editor is where a game in
development runs.
Start from a shipped reference project when that is closer to your goal:
npx @vgai/cli@latest create my-game --example hp-hudThe npm package carries the same canonical examples as the hosted editor and the repository's example picker; creating one copies it into a new standalone project that you own and can modify.
Run the editor source checkout
npm run dev # from the repository rootThe hosted build (no install) is at https://vgai-editor.pages.dev.
Local coding-agent chat
The left chat surface is powered by Supercode. Its server-side controller can discover and mirror project-local sessions from supported coding harnesses, start a new session, resume persisted history, attach to a genuinely reachable live process when that harness supports it, branch, interrupt, and release a controlled session back to a structured terminal command. Collapsing the panel does not close its runtime or transcript follower.
Supercode remains an optional integration so the editor can run without a coding harness. A packaged editor installation should install the binary and both headless packages together:
npm install @volter-ai-dev/supercode @volter-ai-dev/supercode-harness-sdk @volter-ai-dev/supercode-clientIn adjacent development checkouts (vgai-engine/ and supercode/ as sibling
folders), the editor loads the Supercode SDK sources and local debug/release
binary automatically. SUPERCODE_BIN, SUPERCODE_SDK_PATH, and
SUPERCODE_CLIENT_PATH can override those locations. Execution policy is set
by the trusted editor server (currently YOLO); browser actions cannot choose or
upgrade it.
Orientation
- Architecture notes live in the repo-root CLAUDE.md
(Editor section) and ARCHITECTURE.md: the
THREE.Scene is the store;
editor-store.tsis a mutation façade; descriptors are truth for properties, live objects for transforms. template/— the standalone project template used by@vgai/cli create.src/ingest/,src/authoring/— unmodified-game ingestion and the AuthoringAdapter seam.e2e/— the Playwright suite.
