add README.md

README.md

@@ -0,0 +1,88 @@
+# Wowngeon
+
+A blockchain-based roguelike dungeon crawler built on the Wownero network.
+
+## Project Overview
+
+Wowngeon is a web-based roguelike game that integrates with the Wownero blockchain for a unique gaming experience. Players enter a randomly generated dungeon with the goal of escaping before the next block is discovered on the network.
+
+### Key Features:
+
+- **Blockchain-linked gameplay**: Players enter when one block is found and must escape before the next block (approximately 5 minutes in Wownero)
+- **Permadeath mechanics**: If a player fails to escape before the next block is found, they die
+- **Random dungeons**: Each game features procedurally generated maps using ROT.js
+- **Monster AI**: Evade monsters as you navigate the dungeon
+- **Treasure hunting**: Find treasure for bonus rewards
+- **Wownero integration**: Players pay an entrance fee (10-100 WOW) and can win rewards
+
+### Technology Stack:
+- Backend: Node.js with Express and Socket.io
+- Frontend: HTML5, CSS, and JavaScript with ROT.js for rendering
+- Blockchain: Wownero RPC integration for block monitoring and transactions
+
+## File Structure
+
+### Server Files
+
+**index.js**  
+The main server file that handles HTTP requests, WebSocket connections, game lifecycle management, and blockchain monitoring. Coordinates the entire application.
+
+**game.js**  
+Contains the Game class and logic for dungeon generation, player movement, monster AI, field-of-view calculations, and game state management.
+
+**user.js**  
+Manages user registration, authentication, game association, and payment tracking. Maintains a registry of all active users.
+
+**dbcalls.js**  
+Handles database operations for storing user data, game history, and payment records.
+
+**rpccalls.js**  
+Contains functions for interacting with the Wownero blockchain via RPC, including checking block height and verifying transactions.
+
+### Client Files
+
+**html/index.html**  
+The main HTML file served to clients, containing the structure for the game UI and chat interface.
+
+**html/js/game.js**  
+Client-side game logic handling keyboard input, rendering the game state using ROT.js, and managing socket communication.
+
+**html/styles/stylesheet.css**  
+Styling for the game interface, ensuring proper layout and visual appeal.
+
+**html/js/rot.js**  
+The Roguelike Toolkit library that provides dungeon generation, field-of-view calculations, and display capabilities.
+
+## To-Do List
+
+### High Priority
+- [ ] Fix monster collision detection to properly end game when monster catches player
+- [ ] Improve chat system to correctly broadcast messages between all clients
+- [ ] Add visual indicators for block time status (when you're in danger)
+- [ ] Implement proper payment verification through Wownero RPC
+- [ ] Add score tracking and leaderboard functionality
+
+### Medium Priority
+- [ ] Improve monster AI with more sophisticated pathfinding
+- [ ] Add multiple dungeon layouts and difficulty levels
+- [ ] Implement different monster types with varying behaviors
+- [ ] Create persistent user accounts with game history
+- [ ] Add sound effects and basic animations
+
+### Low Priority
+- [ ] Implement additional power-ups or items in the dungeon
+- [ ] Add achievements system
+- [ ] Create detailed statistics tracking
+- [ ] Optimize performance for mobile devices
+- [ ] Add difficulty settings with corresponding reward multipliers
+
+## Running the Game
+
+1. Install dependencies: `npm install`
+2. Configure Wownero RPC settings in `config.js` or environment variables
+3. Start the server: `node index.js`
+4. Access the game at `http://localhost:3000`
+
+## Development Mode
+
+The game includes a DEBUG_MODE setting that simulates block discovery every 30 seconds for easier testing. Set `DEBUG_MODE = true` in `index.js` to enable this feature.