Last Updated: 2025-12-30 Version: 1.1
This master index provides a comprehensive guide to all technical documentation for LuminariMUD. Documents are organized by category and purpose to help developers, builders, and administrators quickly find the information they need.
- Setup & Getting Started
- Architecture & Core Systems
- Game Systems
- Development Guides
- Building & Content Creation
- Administration & Operations
- Project Management
- README.md - Project overview, quick start, and essential information
- SETUP_AND_BUILD_GUIDE.md - Complete setup instructions for all platforms
- CONTRIBUTING.md - How to contribute to the project
- CODE_OF_CONDUCT.md - Community guidelines and expectations
- CMAKE_BUILD_GUIDE.md - Alternative build system using CMake
- IMPORT_DB.md - Database import procedures
- LEGACY_README.md - Historical installation notes
- README_HISTORY.md - Evolution of setup procedures
- ARCHITECTURE.md - Overall system design and module organization
- CORE_SERVER_ARCHITECTURE.md - Game loop, networking, and core engine
- DATA_STRUCTURES_AND_MEMORY.md - Memory management and data structures
- COMMAND_SYSTEM_AND_INTERPRETER.md - Command parsing and execution
- FILE_MAP.md - Complete directory and file structure listing
- DATABASE_INTEGRATION.md - MySQL integration and schema
- SAVE_SYSTEMS_BREAKDOWN.md - Save file formats and persistence
- PROTOCOL_SYSTEMS.md - Telnet, MSDP, GMCP, and client protocols
- PROTOCOL_TODO.md - Planned protocol enhancements
- GAME_MECHANICS_SYSTEMS.md - Overview of all game systems
- COMBAT_SYSTEM.md - Combat mechanics and formulas
- SPELL_PREPARATION_SYSTEM.md - Magic and spell preparation
- PLAYER_MANAGEMENT_SYSTEM.md - Character and account management
- VESSEL_SYSTEM.md - Ships, airships, submarines, and land vehicles (carts, wagons, mounts) with wilderness navigation, multi-room interiors, and unified transport interface
- VESSEL_BENCHMARKS.md - Vessel system performance benchmarks and stress test results
- CLAN_SYSTEM.md - Guild and clan functionality
- STAFF_EVENT_SYSTEM.md - Staff-managed game events
- WILDERNESS_SYSTEM.md - Dynamic wilderness generation
- SPATIAL_SYSTEMS_ARCHITECTURE.md - 🆕 ✅ Spatial visual and audio systems with triple strategy pattern
- RESOURCE_SYSTEM_TECHNICAL.md - 🆕 Wilderness resource system with flexible region effects
- RESOURCE_REGENERATION_SYSTEM.md - 🆕 Resource regeneration with seasonal and weather effects
- RESOURCE_REGENERATION_QUICK_REFERENCE.md - 🆕 Quick reference for resource regeneration system
- DYNAMIC_RESOURCE_DESCRIPTIONS_PLAN.md - 🆕 Dynamic environment descriptions based on resource state
- AI_SERVICE_README.md - AI service integration
- skore_system_documentation.md - Skore achievement system
- OLC_ONLINE_CREATION_SYSTEM.md - Online building tools
- SCRIPTING_SYSTEM_DG.md - DG Scripts documentation
- UTILITY_SYSTEMS.md - Helper systems and utilities
- DEVELOPER_GUIDE_AND_API.md - Comprehensive developer reference
- RESOURCE_SYSTEM_REFERENCE.md - 🆕 Resource system player/admin reference
- RESOURCE_REGENERATION_API.md - 🆕 Resource regeneration API for developers
- PHASE_4_INSTALLATION.md - 🆕 Phase 4 region effects system setup and testing guide
- CLAUDE.md - AI assistant guidelines and codebase patterns
- TESTING_GUIDE.md - Testing procedures and frameworks
- RESOURCE_SYSTEM_TESTING.md - Resource system testing guide
- vessel_test_results.md - Vessel system test validation (91 tests, Valgrind clean)
- CuTest_README.md - Unit testing with CuTest
- PERFORMANCE_OPTIMIZATIONS.md - Performance tuning guide
- affect_update_optimization.md - Specific optimization case study
- TROUBLESHOOTING_AND_MAINTENANCE.md - Common issues and solutions
- SYSLOG_ERRORS.md - Error reference and solutions
- Building README - Overview of building tools and processes
- ultimate-mud-writing-guide.md - Writing compelling MUD content
- BUILDERS_TASK_LIST.md - Current building priorities
- armor_information.md - Armor system details
- crafting-notes.md - Crafting system notes
- current_gear_stats_distribution.md - Equipment balance
- stat_distribute_on_gear_drop.md - Loot generation
- stats-by-location-markdown.md - Area-based statistics
- Admin README - Administration overview
- FAQ.md - Frequently asked questions
- Utilities README - External utility programs
- PHP_TOOLS_README.md - PHP-based admin tools
- LICENSE - Project licensing information
- Legal README - Legal considerations
- TASK_LIST.md - Current development priorities
- DOC_AUDIT.md - Documentation audit tracking
- CHANGELOG.md - Recent changes and updates
- AI_TODO_IDEAS.md - AI-related feature ideas
- DO_SKORE_PROJECT.md - Skore system project plan
- WILDERNESS-RESOURCE-PLAN.md - 🆕 Resource system implementation plan (Phases 1-4)
- PHASE_5_DESIGN.md - 🆕 Player harvesting mechanics design
- PHASE_4_COMPLETION_SUMMARY.md - 🆕 Region effects system completion
- CLEANUP_REPORT.md - 🆕 System redesign and cleanup documentation
- IDEA_LIST.md - Feature idea collection
- WILDERNESS_PROJECT.md - Wilderness system development
- Previous Changelogs - Historical development records
- README.md
- SETUP_AND_BUILD_GUIDE.md
- DEVELOPER_GUIDE_AND_API.md
- ARCHITECTURE.md
- CONTRIBUTING.md
- SETUP_AND_BUILD_GUIDE.md
- DATABASE_INTEGRATION.md
- TROUBLESHOOTING_AND_MAINTENANCE.md
- PHP_TOOLS_README.md
- OLC_ONLINE_CREATION_SYSTEM.md
- SCRIPTING_SYSTEM_DG.md
- ultimate-mud-writing-guide.md
- Building guides in building_game-data/
- world/STARTER_AREA.md
- DEVELOPER_GUIDE_AND_API.md
- PERFORMANCE_OPTIMIZATIONS.md
- TESTING_GUIDE.md
- All system documentation
- README.md
- FAQ.md
- CODE_OF_CONDUCT.md
- ultimate-mud-writing-guide.md
- SETUP_AND_BUILD_GUIDE.md
- OLC_ONLINE_CREATION_SYSTEM.md
- GAME_MECHANICS_SYSTEMS.md
- Building guides
- ARCHITECTURE.md
- CORE_SERVER_ARCHITECTURE.md
- DEVELOPER_GUIDE_AND_API.md
- PERFORMANCE_OPTIMIZATIONS.md
- DATABASE_INTEGRATION.md
- SCRIPTING_SYSTEM_DG.md
- COMMAND_SYSTEM_AND_INTERPRETER.md
- PROTOCOL_SYSTEMS.md
- By Feature: Look in
systems/directory - By Task: Check
guides/directory - By Problem: See TROUBLESHOOTING_AND_MAINTENANCE.md
- By Code: Refer to DEVELOPER_GUIDE_AND_API.md
*_SYSTEM.md- System documentation*_GUIDE.md- How-to guides*_README.md- Overview documents*_TODO.md- Planning documents*_TASK_LIST.md- Work tracking
- All docs use Markdown format
- Code examples follow ANSI C90/C89 standard
- Internal links use relative paths
- External links include descriptions
- Documentation reorganized into categorical directories
- Removed redundant
/guides/paths - Updated to reflect ANSI C90/C89 compliance
- Added performance optimization documentation
- Enhanced security documentation
- Need more examples in API documentation
- Combat formulas need detailed breakdown
- Scripting cookbook would be helpful
- Video tutorials for OLC system
- Follow markdown best practices
- Include code examples where relevant
- Keep technical accuracy paramount
- Update this index when adding new docs
- Test all commands and code examples
This index is maintained as part of the LuminariMUD project. For corrections or additions, please submit a pull request or contact the development team.