How alterrsps/alter works
Alter is a modular OSRS-compatible game server: a client connects to the server, which initializes the cache and world, accepts logins, and runs game cycles; plugins provide much of the game content. The tree also shows player interfaces, combat, skills, administrative commands, and auxiliary HTTP/world-list services. Relationships are limited to those visible in excerpts or documented in the README; several plugin subsystems are represented by their enclosing directories because their implementations were not sampled.
Main entry points: PluginRepository.kt Plugin loading · World.kt Game world · Server.kt Server bootstrap · CacheManager.kt Cache definitions
Components 21
Server runtime
- Server bootstrap
game-server/src/main/kotlin/org/alter/game/Server.kt - Game networking
game-server/src/main/kotlin/org/alter/game/Server.kt - Login service
game-server/src/main/kotlin/org/alter/game/service/login/LoginService.kt - Game cycles
game-server/src/main/kotlin/org/alter/game/service/GameService.kt - Service lifecycle
game-server/src/main/kotlin/org/alter/game/service/Service.kt
World and data
- Game world
game-server/src/main/kotlin/org/alter/game/model/World.kt - Cache definitions
plugins/filestore/src/main/kotlin/dev/openrune/cache/CacheManager.kt - Item metadata
game-server/src/main/kotlin/org/alter/game/service/game/ItemMetadataService.kt - Region keys
game-server/src/main/kotlin/org/alter/game/service/xtea/XteaKeyService.kt - Entity identifiers
plugins/rscm/src/main/kotlin/org/alter/rscm/RSCM.kt
Game plugins
- Game API
game-api/src/main/kotlin/org/alter/api - Plugin loading
game-server/src/main/kotlin/org/alter/game/plugin/PluginRepository.kt - Combat system
game-plugins/src/main/kotlin/org/alter/plugins/content/combat - Skills and areas
game-plugins/src/main/kotlin/org/alter/plugins/content/skills - Item behaviors
game-plugins/src/main/kotlin/org/alter/plugins/content/items
Interfaces and services
- Player interfaces
game-plugins/src/main/kotlin/org/alter/plugins/content/interfaces - Commands
game-plugins/src/main/kotlin/org/alter/plugins/content/commands - REST API
game-plugins/src/main/kotlin/org/alter/plugins/service/restapi - World list
game-plugins/src/main/kotlin/org/alter/plugins/service/worldlist/WorldListService.kt - HTTP API client
http-api/src/App.vue
Other components
- OSRS client
Connections 20
- Server bootstrap → Cache definitions: initializes
game-server/src/main/kotlin/org/alter/game/Server.kt - Server bootstrap → Game world: creates
game-server/src/main/kotlin/org/alter/game/Server.kt - Server bootstrap → Game networking: starts
game-server/src/main/kotlin/org/alter/game/Server.kt - OSRS client → Game networking: connects
- Login service → Game world: verifies against
game-server/src/main/kotlin/org/alter/game/service/login/LoginService.kt - Game cycles → Game world: runs tasks on
game-server/src/main/kotlin/org/alter/game/service/GameService.kt - Game world → Plugin loading: runs world init
game-server/src/main/kotlin/org/alter/game/model/World.kt - Item metadata → Cache definitions: loads definitions
game-server/src/main/kotlin/org/alter/game/service/game/ItemMetadataService.kt - Region keys → Cache definitions: reads map data
game-server/src/main/kotlin/org/alter/game/service/xtea/XteaKeyService.kt - Region keys → Game world: sets key service
game-server/src/main/kotlin/org/alter/game/service/xtea/XteaKeyService.kt - Server bootstrap → Service lifecycle: initializes services
game-server/src/main/kotlin/org/alter/game/service/Service.kt - Plugin loading → Game API: uses extensions
- Plugin loading → Combat system: loads content
- Plugin loading → Skills and areas: loads content
- Plugin loading → Item behaviors: loads content
- Plugin loading → Player interfaces: loads content
- Plugin loading → Commands: loads content
- REST API → HTTP API client: serves data to
- Entity identifiers → Cache definitions: names entities from
- World list → Game world: tracks players
game-plugins/src/main/kotlin/org/alter/plugins/service/worldlist/WorldListService.kt