From 4d531c23dea1f8ebda8e677b52b4158901fb7670 Mon Sep 17 00:00:00 2001 From: Matthew Mone Date: Fri, 2 Jan 2026 12:14:15 -0800 Subject: [PATCH] feat: Add initial game content including missions, narrative sequences, and NPC personality specifications. --- README.md | 79 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 52 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 9d363d5..cba6479 100644 --- a/README.md +++ b/README.md @@ -43,41 +43,55 @@ A tactical turn-based roguelike strategy game built with Three.js, featuring pro ## Project Structure ``` +specs/ # Detailed feature specifications and design docs src/ ├── assets/ │ ├── data/ │ │ ├── classes/ # Character class definitions (JSON) -│ │ ├── missions/ # Mission configurations -│ │ └── narrative/ # Dialogue sequences -│ └── images/ # Character portraits and assets +│ │ ├── effects/ # Status effects and abilities +│ │ ├── missions/ # Mission configurations +│ │ ├── narrative/ # Dialogue sequences +│ │ ├── skill_trees/ # Class skill tree templates +│ │ └── skills/ # Individual skill definitions +│ └── images/ # Character portraits and assets ├── core/ │ ├── GameLoop.js # Main game loop and Three.js setup │ ├── GameStateManager.js # Application state management │ ├── InputManager.js # Input handling (keyboard/gamepad) │ └── Persistence.js # Save/load system +├── factories/ +│ └── SkillTreeFactory.js # Skill tree generation logic ├── generation/ -│ ├── BaseGenerator.js # Base class for world generators -│ ├── CaveGenerator.js # Cave biome generator -│ ├── RuinGenerator.js # Ruin biome generator -│ └── textures/ # Procedural texture generators +│ ├── BaseGenerator.js # Base class for world generators +│ ├── CaveGenerator.js # Cave biome generator +│ ├── RuinGenerator.js # Ruin biome generator +│ └── textures/ # Procedural texture generators ├── grid/ -│ ├── VoxelGrid.js # 3D voxel grid data structure -│ └── VoxelManager.js # Voxel rendering and mesh management +│ ├── VoxelGrid.js # 3D voxel grid data structure +│ └── VoxelManager.js # Voxel rendering and mesh management ├── managers/ -│ ├── MissionManager.js # Mission progression and objectives -│ ├── NarrativeManager.js # Dialogue and story sequences -│ ├── RosterManager.js # Character roster management -│ └── UnitManager.js # Unit lifecycle and combat state +│ ├── InventoryManager.js # Equipment and inventory +│ ├── ItemRegistry.js # Item definitions +│ ├── MarketManager.js # Shop and trading logic +│ ├── MissionManager.js # Mission progression and objectives +│ ├── NarrativeManager.js # Dialogue and story sequences +│ ├── ResearchManager.js # Tech tree and upgrades +│ ├── RosterManager.js # Character roster management +│ ├── SkillRegistry.js # Skill definitions map +│ └── UnitManager.js # Unit lifecycle and combat state ├── ui/ -│ ├── deployment-hud.js # Pre-battle deployment interface -│ ├── team-builder.js # Squad composition screen -│ ├── game-viewport.js # 3D game viewport component -│ └── dialogue-overlay.js # Narrative dialogue display +│ ├── deployment-hud.js # Pre-battle deployment interface +│ ├── team-builder.js # Squad composition screen +│ ├── game-viewport.js # 3D game viewport component +│ └── dialogue-overlay.js # Narrative dialogue display ├── units/ -│ ├── Unit.js # Base unit class -│ ├── Explorer.js # Player-controlled units -│ └── Enemy.js # Enemy AI units -└── index.js # Application entry point +│ ├── Unit.js # Base unit class +│ ├── Explorer.js # Player-controlled units +│ └── Enemy.js # Enemy AI units +├── utils/ +│ ├── SeededRandom.js # Deterministic RNG +│ └── SimplexNoise.js # Noise generation +└── index.js # Application entry point ``` ## Getting Started @@ -157,6 +171,15 @@ npm run test:watch - **Narrative**: Intro and outro sequences that advance the story - **Campaign Progression**: Unlock new missions as you complete objectives +## Documentation + +For detailed specifications of game systems, please see the `specs/` directory: +- [Character Sheet](specs/Character_Sheet.spec.md) +- [Combat System](specs/CombatState.spec.md) +- [Skill Trees](specs/Skill_Tree.spec.md) +- [Inventory](specs/Inventory.spec.md) +- [Procedural Missions](specs/Procedural_Missions.spec.md) + ## Development Status This is an active development project. Current features include: @@ -168,14 +191,16 @@ This is an active development project. Current features include: - ✅ Mission system foundation - ✅ Basic world generation - ✅ Save/load system +- ✅ Turn-based combat system +- ✅ AI behavior +- ✅ Skill tree implementation +- ✅ Equipment system -Planned features: +Planned features / In Progress: -- 🔄 Turn-based combat system -- 🔄 AI behavior -- 🔄 Skill tree implementation -- 🔄 Equipment system -- 🔄 Additional biomes and missions +- 🔄 Additional biomes (Crystal Spires) +- 🔄 Advanced AI behavior (Pack tactics, Retreat) +- 🔄 Endgame campaign content ## License