Loading repository data…
Loading repository data…
boringstack-xyz / repository
A reusable, strictly-typed, architecturally-enforced starter template for Phaser games. Designed so AI agents can contribute at high velocity without eroding structure.
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
A reusable, strictly-typed, architecturally-enforced starter for Phaser games — built so AI agents can contribute at high velocity without eroding structure, and so a programmer who has never shipped a game can become a one-person game studio in a single weekend.
Backend engineer, tech lead, web developer who always wanted to make games but never had the time? Start with docs/learn/ — a 2.5-hour primer that bridges the gap between "I can write code" and "I know how to use AI to generate art, design a core loop, and ship a playable game on itch.io."
Use this as a GitHub template. Click "Use this template" on the repo page, fork it into a new repo for each game, then read
BUILD_THE_GAME.mdto walk from empty fork to shipped feature.
Settings → Pages → Build and deployment → Source: "GitHub Actions". Without this the deploy-pages workflow 404s on the first run.Settings → Actions → General → Workflow permissions → [x] Allow GitHub Actions to create and approve pull requests.Settings → General → Template repository so your own "Use this template" button works.Everything else (CI, Scorecard, CodeQL, Dependabot) works out of the box.
eslint-plugin-boundaries in the editor/PR, dependency-cruiser as belt-and-braces in CI. Try importing phaser from src/domain/** and watch both reject it.pnpm new:module|scene|feature|port|content|adr) so AI agents scaffold boilerplate in ~200 tokens instead of 500–800./speckit:specify → :clarify → :plan → :tasks → :analyze → :implement) with a project constitution pointing at your architectural rules.CLAUDE.md, AGENTS.md, docs/ai/*) so every fresh session starts with the same context without token-heavy onboarding.pnpm audit, plus a grep-based invariants job that triple-checks the rails.| If you are... | Read next |
|---|---|
| A programmer who never shipped a game | docs/learn/ — 2.5-hour primer on game dev, AI asset generation, game design, and solo workflow |
| A human forking this to build a game | BUILD_THE_GAME.md — the full walkthrough |
| An AI agent in a fresh session | CLAUDE.md / AGENTS.md + docs/ai/catalog.md |
| Just evaluating the architecture | docs/ai/architecture.md + this README |
| Looking for the rules | docs/ai/contribution-contract.md + .specify/memory/constitution.md |
pnpm install
pnpm dev # http://localhost:5173
Arrow keys or WASD to move. Walk onto a yellow circle to score. Press S to save, R to reset.
+--------+
| app | composition root
+--------+
|
+-----------+--+--+-----------+
| | | |
+--------+ +--------+ +---------+
| domain | |content | | shared | pure + data + common types
+--------+ +--------+ +---------+
|
+--------+
|runtime | Phaser, browser APIs
+--------+
| Layer | Responsibility |
|---|---|
domain | Pure state + behaviors. No engine. No wall-clock. No storage. |
features | Orchestrate domain + ports. Emit events. |
runtime | Phaser scenes, entities, input, audio, adapters for shared ports. |
content | Zod-validated definitions, levels, balance. |
shared | Leaf utilities — types, event bus, test fakes. |
app | Composition root. Wires everything for the web entrypoint. |
Full story: docs/ai/architecture.md.
Phaser 4 · TypeScript 6 (strict + verbatimModuleSyntax + noUncheckedIndexedAccess) · Vite 8 · Vitest 4 · ESLint 10 (flat) · dependency-cruiser · Playwright · Zod · husky + lint-staged · pnpm 10 · Node 22 LTS.
| Script | What it does |
|---|---|
pnpm dev | Start Vite dev server |
pnpm build | Typecheck, then production build |
pnpm test | Vitest unit + integration |
pnpm test:smoke | Playwright smoke against a built bundle |
pnpm check | The gate: typecheck + lint + format + dep-cruise + test |
pnpm check:arch | Just architectural checks (lint boundaries + dep-cruiser) |
pnpm catalog | Regenerate docs/ai/catalog.md from src/ |
| Script | Generates |
|---|---|
pnpm new:module <Name> | Domain module under src/domain/<name>/ |
pnpm new:scene <Name> | Phaser scene |
pnpm new:feature <Name> | Feature orchestrator + test |
pnpm new:port <Name> | Port interface stub + matching fake |
pnpm new:content <Name> | Zod schema + sample JSON + validated loader |
pnpm new:adr "<Title>" | Numbered ADR in docs/adr/ |
| Project commands | Spec Kit commands (/speckit:*) |
|---|---|
/check | /speckit:specify |
/new-module | /speckit:clarify |
/new-feature | /speckit:plan |
/new-scene | /speckit:tasks |
/review-slice | /speckit:analyze |
/verify-boundaries | /speckit:implement |
/speckit:checklist | |
/speckit:constitution |
Every push/PR runs:
ci — typecheck, lint, format, dep-cruise, testscodeql — static security analysis with security-and-quality queriessecurity — pnpm audit on production deps + OpenSSF Scorecard (SARIF uploaded)arch-invariants — grep-based banned-pattern guard (phaser/Math.random/Date.now/localStorage in src/domain)On push to main, release-please opens/updates a release PR using conventional commits. Merge it to tag a release. Dependabot opens grouped weekly PRs for npm and GitHub Actions updates.
MIT — see LICENSE.