diff --git a/README.md b/README.md new file mode 100644 index 0000000..16c031a --- /dev/null +++ b/README.md @@ -0,0 +1,92 @@ +# Legends of Coyote Gulch + +A 2D action-adventure platformer game built with Phaser.js, featuring multiple dungeon levels and unique character abilities. + +## Game Overview + +"Legends of Coyote Gulch" is an exciting adventure game where players explore three distinct dungeon environments: +- **Coyote Gulch**: The starting area with basic terrain +- **NN Dungeon**: A challenging underground level +- **Pro Edge**: The final boss arena with complex mechanics + +Players control a hero character who must navigate through these dungeons, defeat enemies, collect items, and progress toward the ultimate goal. + +## Features + +### Character System +- Hero character with movement controls (WASD or arrow keys) +- Health management system with hearts +- Inventory system for collecting items +- Score tracking and progression + +### Enemy Types +#### 99Boy (NN Dungeon Enemies) +- Patrols horizontally within set boundaries +- Follows player when in range +- Fires garbage projectiles at the player +- Takes damage from player attacks + +#### ProEdge (Pro Edge Boss) +- Complex multi-phase combat system +- Patrols and follows the player with advanced movement patterns +- Casts various spells including: + - Fireballs that can be reflected back to enemies + - Lightning floor effects that damage players + - Sword slashes and scythe attacks + - Star projectiles for ranged combat + +### Game Mechanics +- Tile-based level design using Tiled Map Editor files (.tmx) +- Physics-based movement with arcade gravity settings (0,0) +- Health system with maximum hearts tracking +- Score progression through defeating enemies and completing areas +- Inventory management system for collecting items + +### Dependencies + +- **Phaser 3**: HTML5 game framework (v3.90.0 via CDN) +- **Tiled Map Editor**: Level design files (.tmx format) + +## Controls + +### Movement +- **WASD** or **Arrow Keys**: Move character left/right/up/down +- **Spacebar**: Jump (if implemented in current build) + +### Combat +- Mouse click: Attack/Use abilities +- Mouse movement: Aim projectiles + +## Level Design Files + +The game uses Tiled Map Editor files for level design: +- `raw/gulch.tmx` - Coyote Gulch starting area +- `raw/NNDungeon.tmx` - NN Dungeon underground level +- `raw/proedge.tmx` - Pro Edge boss arena + +## Development Notes + +### Global State Management +The game uses a centralized global state system (`GlobalState`) to manage: +- Player health (hearts) +- Score tracking +- Inventory items +- Starting positions for each dungeon area + +### Character Behaviors +Both enemy types implement patrol and follow behaviors with configurable boundaries. The 99Boy focuses on ranged combat while ProEdge has a more complex spellcasting system. + +### Scene Management +The game supports multiple scenes: +1. **MenuScene**: Main menu interface +2. **Gulch**: Coyote Gulch level +3. **NNDungeon**: NN Dungeon level +4. **ProEdge**: Boss arena + +## Future Development Goals + +- Implement full player character abilities and animations +- Add more enemy types with unique behaviors +- Expand inventory system with item effects +- Create additional dungeon levels +- Implement sound effects and music (currently uses placeholder "99Dungeon Lyrics.txt") \ No newline at end of file