MUD Documentation

This directory contains all documentation for the MUD game server.

Documentation Structure

Game Design

Complete game design documentation for our MUD inspired by "He Who Fights With Monsters":

• Core systems and mechanics
• Character progression and combat
• World systems and lore
• Multiplayer features
• User interface design

Code Documentation

Technical documentation for developers:

• Architecture and system design
• API documentation
• Development guidelines
• Testing procedures

Quick Links

• Game Overview - Start here to understand the game
• Commands Reference - Complete command list for players

Technical Documents

Commands Reference

• Complete command list
• Category organization
• Shortcuts and aliases
• Advanced commands

Architecture

• Overall system architecture and design decisions
• Server infrastructure
• Database design

Networking

• Network protocols and communication patterns
• WebSocket implementation
• Real-time updates

Commands

• Player command reference
• Command parsing
• Help system

Development

• Development setup and guidelines
• Testing procedures
• Deployment

Quick Reference

• Genre: Multi-User Dungeon (MUD)
• Inspiration: "He Who Fights With Monsters" by Shirtaloon
• Key Features: Procedural generation, deep magic system, passive/active progression
• Platform: Text-based with modern web interface

Contributing to Documentation

When adding new features or modifying existing ones:

1. Update relevant documentation files
2. Create new documentation files for major features
3. Keep examples up-to-date with code changes
4. Use clear, concise language
5. Include code examples where helpful