📚 FireMUD Microservices Documentation
This directory contains detailed design documents for each core microservice in the FireMUD Game Platform. These documents outline the responsibilities, APIs, data models, and interactions of each service.
🧩 Core Microservices
| Microservice | Purpose |
|---|---|
| Account Service | Manages user accounts, authentication, profiles, and sessions. |
| Automation & Scripting Service | Handles AI behaviors, event scripting, and dynamic interactions. |
| Entity Management Service | Controls player characters, NPCs, items, and inventory management. |
| Game Design Service | Provides tools for designing worlds, actions, items, and game events. |
| Game Logic Service | Implements core gameplay mechanics, command parsing, and actions. |
| Game Session Service | Orchestrates live gameplay sessions and tick execution. |
| Logging & Admin Service | Provides centralized logging, analytics, and administration tools. |
| Social & Groups Service | Manages chat, guilds, and cross-game social networking features. |
| Spring Cloud Gateway | Routes WebSocket and HTTP traffic to backend services. |
| TCP Proxy Service | Bridges Telnet clients into the WebSocket-based backend. |
| World Management Service | Handles world maps, regions, pathfinding data, and procedural generation. |
| Service Template | Template for creating new microservice docs. |
All services share the same cluster and databases. Each table stores a tenantId and Redis keys use a matching prefix so data stays isolated between games. See Multi-Tenancy for details.
🧭 Usage
Each microservice document follows a consistent structure, covering:
- Service Overview
- Architecture and Key Responsibilities
- Key Features, Data Models, and APIs
- External and Internal Dependencies
- Future Enhancements and Roadmap
For cross-service systems (e.g., networking, infrastructure), refer to:
See Infrastructure Overview for shared architecture, deployment environments, and networking patterns.
All gRPC schema files are organized under the top-level
protos/ directory. Individual service documents link to their
corresponding versioned proto folders.