Custom C++20 hockey game and engine project targeting a real-time 4v4 hockey experience with a Vulkan renderer, SDL3 platform layer, Unity-style editor, ECS scene/prefab workflow, physics, gameplay simulation, and an eventual authoritative networking stack.
Current status: phases 1-7 are substantially implemented, covering foundation/core through local and headless hockey gameplay. Phase 8 networking/lobbies and Phase 9 animation/audio/UI/polish are still future work.
- Project structure - module layout, target graph, app list, scripts, build/run commands, and screenshot workflow.
- Phase status index - per-phase checkbox status files with finished, started, and remaining work.
- Agent instructions - architecture boundaries, dependency rules, phase order, and coding expectations.
- AI docs - onboarding, workflow, tooling, debugging, and focused hockey guidance for AI-assisted work.
- AI rule fragments, phase rules, and phase plans - supporting guidance for tools and phase-owned work.
Dependencies are managed with vcpkg manifest mode through vcpkg.json. Set VCPKG_ROOT to your vcpkg install before configuring.
Preferred command surface when just is installed:
just tools-check
just ai-ready
just configure-debug
just build-debug
just test
just verifyDirect platform scripts remain supported.
Windows:
.\scripts\windows\configure_debug.ps1
.\scripts\windows\build_debug.ps1
.\scripts\windows\test.ps1Linux:
./scripts/linux/setup.sh
./scripts/linux/configure_debug.sh
./scripts/linux/build_debug.sh
./scripts/linux/test.shRun helpers:
.\scripts\windows\run_editor.ps1
.\scripts\windows\run_client.ps1
.\scripts\windows\run_server.ps1Linux equivalents live in scripts/linux.
apps/ Executables: client, editor, server, tools, tests
libs/ Engine libraries: core, ecs, assets, renderer, physics, gameplay, editor
data/ Config, raw/cooked assets, shaders, editor state
scripts/ Windows and Linux build/run/test helpers
docs/ Project documentation, phase status, AI workflow docs
ai/ AI onboarding, workflow, tooling, debugging, and hockey guides
ai-rules/ Shared AI project rules
phase-rules/ Compact phase-specific constraints
phase-plans/ Detailed phase implementation plans
justfile Shared build/test/run/verify command recipes
agents.toml Shared Codex agent-tool declarations
For the detailed dependency graph and subsystem notes, use docs/project-structure.md.
HockeyGameClient- playable windowed client path.HockeyMapEditor- Unity-style map editor and authoring workflow.HockeyDedicatedServer- headless authoritative server path.HockeyAssetTool- asset discovery/import/cook/validate CLI.- Test apps cover core, ECS, renderer, editor, assets, physics, and gameplay.
Development is phase-based. Each subsystem should be completed in order and architecture boundaries should stay clean. The short version:
- Foundation/core
- ECS, scene, prefab
- Vulkan renderer
- Unity-style editor
- Asset pipeline
- Physics
- Hockey gameplay
- Networking/lobbies
- Animation/audio/UI/polish
Use docs/phase-status for current phase details before starting work.
MIT License - Copyright (c) 2026 Peter Farber.