# Gameable Engine

> Gameable Engine (the npm package `gameable`) is a browser game engine: gaussian-splat worlds rendered by three.js on WebGPU, with all game logic compiled to a WebAssembly component.

Status: M0-M3 shipped. Building a game? Read one task bundle below, copy a template, edit src/game.ts, run `npm run dev`, follow one recipe. Never read the whole repository; never edit packages/*.

Authoritative actor list: `GET /actors` or `gameable actors --json`.

## Bundles

- [llms-actors.txt](/llms-actors.txt): actors, premade props and level files.
- [llms-script.txt](/llms-script.txt): exact guest script API and four complete games.
- [llms-fps.txt](/llms-fps.txt): first-person shooter.
- [llms-third-person.txt](/llms-third-person.txt): third-person adventure.
- [llms-three-character.txt](/llms-three-character.txt): a character in a three.js app.
- [llms-visit.txt](/llms-visit.txt): a character page.
- [llms-physics.txt](/llms-physics.txt): physics: bodies, joints, queries and solver quality.
- [llms-race.txt](/llms-race.txt): the race kit.
- [llms-multiplayer.txt](/llms-multiplayer.txt): rooms.
- [llms-character.txt](/llms-character.txt): splat characters.
- [llms-xr.txt](/llms-xr.txt): headsets and phones’ rooms.
- [llms-talking-character.txt](/llms-talking-character.txt): talking characters (AI NPCs on Convorcher).
- [llms-gameplay.txt](/llms-gameplay.txt): gameplay building blocks (timers, tweens, triggers, damage, inventory, abilities, quests, waves, turns) and a fighting game.
- [llms-audio.txt](/llms-audio.txt): music, effects and rhythm games.
- [llms-strategy.txt](/llms-strategy.txt): tower defense or RTS.
- [llms-ui.txt](/llms-ui.txt): game screens and UI (menus, cards, trivia, shops).
- [llms-effects.txt](/llms-effects.txt): effects and post-processing (hit sparks, fire, bloom).
- [llms-full.txt](/llms-full.txt): the core corpus, without the topics above.

## Templates

- [templates/ROUTING.md](/llms/templates/ROUTING.md.txt): which of the 26 templates to start from.

## Start here

- [AGENTS.md](/llms/AGENTS.md.txt): hard rules, commands, repository map.
- [Overview](/): what the engine is; the 60-second quickstart.
- [Hello world with your Gameable character](/start/01-hello-world)
- [Install](/start/01-install)
- [Build your first FPS](/start/02-first-fps)
- [Build your first adventure](/start/03-first-adventure)
- [Ship it](/start/04-deploy)
- [Make a multiplayer game](/start/05-make-a-multiplayer-game)

## Concepts

- [Concepts](/concepts/): Gameable Engine splits a game in two…
- [The engine loop](/concepts/engine-loop): The host runs a single…
- [Engine modules](/concepts/modules): Every host subsystem is an EngineModule:
- [Assets and the manifest](/concepts/assets): gameable: page assetUrl(id) after engine…
- [The wasm game-logic boundary](/concepts/wasm-boundary): All game logic is TypeScript compiled to…
- [ECS and game code](/concepts/ecs): bitecs 0.4 is the ECS and it lives…
- [Gaussian splats](/concepts/splats): Worlds are gaussian splats rendered by…
- [Animation](/concepts/animation): A character is animated by one object.…
- [Worlds](/concepts/worlds): A world package is one folder a game can…

## Packages

- [@gameable/animation](/api/@gameable.animation)
- [@gameable/assets](/api/@gameable.assets)
- [@gameable/assets-aosrig](/api/@gameable.assets-aosrig)
- [@gameable/assets-placeholder](/api/@gameable.assets-placeholder)
- [@gameable/bundle](/api/@gameable.bundle)
- [@gameable/cli](/api/@gameable.cli)
- [@gameable/core](/api/@gameable.core)
- [@gameable/create-gameable](/api/@gameable.create-gameable)
- [@gameable/gameable](/api/@gameable.gameable)
- [@gameable/input](/api/@gameable.input)
- [@gameable/presentation](/api/@gameable.presentation)
- [@gameable/sdk](/api/@gameable.sdk)
- [@gameable/splat](/api/@gameable.splat)
- [@gameable/test-harness](/api/@gameable.test-harness)
- [@gameable/vite-plugin-gameable](/api/@gameable.vite-plugin-gameable)
- [@gameable/voice](/api/@gameable.voice)
- [@gameable/wasm-host](/api/@gameable.wasm-host)
- [@gameable/world](/api/@gameable.world)

## Schemas

- [Gameable Engine asset manifest](/llms/docs/schemas/assets.schema.json.txt): JSON Schema, draft 2020-12.
- [Gameable Engine level](/llms/docs/schemas/level.schema.json.txt): JSON Schema, draft 2020-12.
- [Gameable Engine prefab](/llms/docs/schemas/prefab.schema.json.txt): JSON Schema, draft 2020-12.

## Reference

- [Premade actors](/reference/premade-actors): every class and prop.
- [Recipes](/recipes/): every recipe, by genre.
- [Troubleshooting](/troubleshooting): symptom-first fixes.
- [Glossary](/glossary): project-specific terms.
- [API reference](/api/): TypeDoc markdown; run `npm run docs:api`.