@ai-rpg-engine/starter-template
v3.5.0
Published
Starter template for ai-rpg-engine — scaffold a standalone game project from it
Maintainers
Readme
My Game
An ai-rpg-engine content
pack, scaffolded from the starter template. The project is standalone: it
carries its own tsconfig.json and declares every dependency it needs
(including typescript and vitest as devDependencies), so it builds and
tests anywhere — no engine monorepo required.
Getting started
If you are reading this inside templates/starter, scaffold your own copy
first (it names everything for you):
npx --package=@ai-rpg-engine/cli ai-rpg-engine create-starter my-game --out=./my-gameThen, from the project directory:
npm install # pulls @ai-rpg-engine/* plus typescript + vitest
npx tsc --noEmit # typecheck
npx vitest run # run the pack's testsMake it yours
| File | What to edit |
|------|--------------|
| package.json | name and description |
| src/ruleset.ts | your stats, resources, verbs |
| src/content.ts | entities and zones — keep each enemy's ai.profileId paired with a profile in setup |
| src/setup.ts | wire your modules alongside buildCombatStack; the intent profiles list lives here |
| src/starter.test.ts | grows with your content — register dialogues/abilities in the integrity lists |
Two wiring rules worth knowing from day one:
- Enemies act only if their
ai.profileIdresolves. Every profile id declared insrc/content.tsmust appear in thecognition.profileslist insrc/setup.ts(built-ins:aggressive,cautious). An empty profiles list means enemies never select an intent. buildCombatStackowns the combat stack (cognition, tactics, resources, intent, recovery, narration). Your custom modules go in the marked starter-owned section ofsrc/setup.ts.
See Chapter 58 — Create Your Own Starter in the handbook for the full walkthrough.
