Built-in Modules
Reference for all modules included in the framework.
Infrastructure Modules
init
Core initialization and player profile management.
| Property | Value |
|---|---|
| Dependencies | None |
| Services | None |
| UI | None |
Responsibilities:
- Database index creation on startup
- Player profile management (create/load by license)
- First module to start, foundational for all others
prometheus
Metrics telemetry for monitoring.
| Property | Value |
|---|---|
| Dependencies | None |
| Services | PrometheusService |
| UI | None |
Responsibilities:
- Camera heading sync from client to server
- Player position export for live map
- Metrics server lifecycle
Core Modules
characters
Character creation, loading, and state management.
| Property | Value |
|---|---|
| Dependencies | init |
| Services | CharacterService |
| UI | None |
Responsibilities:
- Character loading on player connect
- Active character tracking per player
- Character data persistence with
patchCharacterData() - Character cache for quick lookups
banking
Banking and account management.
| Property | Value |
|---|---|
| Dependencies | characters |
| Services | None |
| UI | None |
Responsibilities:
- Account balance management
- Transaction processing
- Account creation for new characters
Feature Modules
spawning
Player spawn and position persistence.
| Property | Value |
|---|---|
| Dependencies | characters |
| Services | SpawnService |
| UI | None |
Responsibilities:
- Initial spawn position selection
- Position persistence on disconnect
- Spawn point management
needs
Player vitals (hunger, thirst, health, armor).
| Property | Value |
|---|---|
| Dependencies | characters |
| Services | NeedsService |
| UI | huds/status |
Responsibilities:
- Vital decay over time (server-authoritative)
- Bidirectional sync with observables
- Status HUD display
notifications
In-game notification system.
| Property | Value |
|---|---|
| Dependencies | None |
| Services | NotificationService |
| UI | huds/notifications |
Responsibilities:
- Toast-style notifications
- Queue management
- Notification HUD rendering
atm
ATM interface for banking.
| Property | Value |
|---|---|
| Dependencies | banking, characters |
| Services | AtmService |
| UI | pages/atm-interface |
Responsibilities:
- ATM interaction trigger
- Balance display
- Withdrawal/deposit operations
Debug Modules
debug
Development and debugging tools.
| Property | Value |
|---|---|
| Dependencies | None |
| Services | DebugService |
| UI | huds/debug |
Responsibilities:
- Debug overlay with player info
- Development commands
- State inspection tools
Module Load Order
Modules are sorted by dependencies using topological sort:
Independent modules (notifications, debug) can load in any order relative to other independent modules.