create-gridlock-game

Scaffolding CLI for new games on the @gridlock/* engine. Generates a minimal working project — schema, scenario, characters, validators, tests, and a CLI runner.

Usage

npm create gridlock-game@latest my-first-game
# or
npx create-gridlock-game my-first-game
cd my-first-game
pnpm install
pnpm test

Options

• --template <name> — what to scaffold. Default narrative.
  • narrative — investigative scenario on @gridlock/schema + @gridlock/orchestrator
  • blank — legacy alias for narrative
  • turn-based — dice/board game on @gridlock/turn-based (not yet published to npm — this template currently installs only inside the gridlock workspace)
• --channel <name> — optional channel adapter skeleton(s); repeatable or comma-separated. Available: cli (readline loop), whatsapp (Twilio webhook handler, sandbox-aware), discord (discord.js /play + DM dispatchers).

npx create-gridlock-game cipher-hunt --template narrative --channel cli
npx create-gridlock-game dual --channel whatsapp,discord

Docs

• Getting started
• Scenario schema
• Architecture

License

MIT