Update README with comprehensive feature descriptions and latest enhancements

- Enhanced feature descriptions to reflect current capabilities
- Added new sections for Modern Web Features and expanded Technical Features
- Updated Core Gameplay and Advanced Systems with recent additions
- Highlighted 8-category leaderboards, team builder, inventory management
- Mentioned security audit, rate limiting, and backup systems
- Updated item count to 17+ items including new Coin Pouch treasure
- Emphasized responsive design and PIN-verified team management

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
megaproxy 2025-07-15 20:48:29 +00:00
parent 88e352ee79
commit 6cd25ab9b1

View file

@ -1,31 +1,45 @@
# PetBot - IRC Pokemon-Style Pet Game Bot
A feature-rich IRC bot that brings Pokemon-style pet collecting and battling to your IRC channel! Players can catch pets, explore locations, battle wild creatures, earn achievements, and more.
A comprehensive IRC bot that brings Pokemon-style pet collecting and battling to your IRC channel! Players can catch pets, explore locations, battle wild creatures, earn achievements, and manage their collections through an integrated web interface.
## 🎮 Features
### Core Gameplay
- **Pet Collection**: Catch and collect different species of pets
- **Exploration**: Travel between various themed locations
- **Battle System**: Engage in turn-based battles with wild pets
- **Team Management**: Activate/deactivate pets, manage team composition
- **Achievement System**: Unlock new areas by completing challenges
- **Item Collection**: Discover and collect useful items during exploration
- **Pet Collection**: Catch and collect different species of pets with varying rarities
- **Exploration**: Travel between various themed locations with unique spawns
- **Battle System**: Engage in turn-based battles with wild pets and gym leaders
- **Team Management**: Build teams with drag-and-drop web interface and PIN verification
- **Achievement System**: Unlock new areas by completing challenges and milestones
- **Item Collection**: Discover 17+ useful items including healing potions, battle boosters, and treasure
### Advanced Systems
- **Dynamic Weather**: Real-time weather system affecting spawn rates
- **Web Interface**: Modern web dashboard for player stats and pet collections
- **Location-Based Spawns**: Different pets spawn in different locations
- **Level Progression**: Pets gain experience and level up
- **Dynamic Weather**: Real-time weather system affecting spawn rates and pet encounters
- **Web Interface**: Modern responsive web dashboard with unified navigation
- **Enhanced Leaderboards**: 8 different ranking categories (levels, experience, wealth, achievements, etc.)
- **Interactive Team Builder**: Drag-and-drop team management with numbered slots (1-6)
- **Location-Based Spawns**: Different pets spawn in different locations with weather modifiers
- **Level Progression**: Pets gain experience, level up, and can be nicknamed
- **Type Effectiveness**: Strategic battle system with type advantages
- **Item System**: 16+ unique items with rarity tiers and special effects
- **Gym Battle System**: Challenge gym leaders and earn badges
- **Global Item Spawn Control**: Admin-configurable spawn rates with global multipliers
### Modern Web Features
- **Unified Navigation**: Consistent navigation bar across all web pages
- **Player Profiles**: Comprehensive player statistics and pet collections
- **Team Builder**: Secure PIN-verified team changes with IRC delivery
- **Inventory Management**: Visual item display with usage commands
- **Multi-Category Leaderboards**: Interactive leaderboard switching
- **Responsive Design**: Mobile-friendly interface design
### Technical Features
- **Modular Architecture**: Clean, extensible codebase
- **Async Database**: SQLite with async operations
- **Background Tasks**: Automated weather updates
- **PM Flood Prevention**: Web-based responses for large data sets
- **Persistent Data**: Player progress survives bot restarts
- **Robust IRC Connection**: Auto-reconnecting IRC client with health monitoring
- **Rate Limiting System**: Token bucket rate limiting to prevent spam and abuse
- **Automated Backups**: Comprehensive database backup system with retention policies
- **Security Monitoring**: Security audit completed with 23 vulnerabilities identified
- **Modular Architecture**: Clean, extensible codebase with proper separation of concerns
- **Async Database**: SQLite with async operations and proper transaction handling
- **Background Tasks**: Automated weather updates and system monitoring
- **Error Handling**: Comprehensive error handling and user feedback
## 🚀 Quick Start