How danburen/velochatx works
VeloChatX is a Velocity proxy chat plugin for communication across backend servers. Its principal workflow handles player chat events, filters and formats messages, checks channel membership, and sends messages to eligible players; player join/server-switch events also trigger broadcasts and tab-list updates. The graph includes channel/server/player state, persistence, and documented capabilities such as timed broadcasts, localization, permissions, and tab-list customization. Some subsystems are represented from README statements or the source index; those sources do not establish every runtime connection.
Main entry points: VCXEventHandler.java Event handling · BasicMethods.java Shared proxy state · PlayerManager.java Player management · PlayerServiceImpl.java Player data
Components 20
Runtime events
- Event handling
src/main/java/org/nitrowater/velochatx/domain/event/handler/VCXEventHandler.java - Game events
src/main/java/org/nitrowater/velochatx/domain/event/VeloChatXGameEventHandler.java - Plugin setup
src/main/java/org/nitrowater/velochatx/VeloChatX.java - Player commands
src/main/java/org/nitrowater/velochatx/commands
Chat and channels
- Chat formatting
src/main/java/org/nitrowater/velochatx/domain/chat/ChatServiceImpl.java - Channel rules
src/main/java/org/nitrowater/velochatx/domain/channel/ChannelServiceImpl.java - Channel state
src/main/java/org/nitrowater/velochatx/entity/Channel.java - Channel and broadcasts
src/main/java/org/nitrowater/velochatx/manager/ChannelManager.java
Players and servers
- Server registry
src/main/java/org/nitrowater/velochatx/domain/server/ServerServiceImpl.java - Proxy server state
src/main/java/org/nitrowater/velochatx/utils/SubServer.java - Player data
src/main/java/org/nitrowater/velochatx/domain/player/PlayerServiceImpl.java - Player attribution
src/main/java/org/nitrowater/velochatx/utils/PlayerAttribution.java - Player persistence
src/main/java/org/nitrowater/velochatx/mapper/PlayerMapper.java - Shared proxy state
src/main/java/org/nitrowater/velochatx/manager/BasicMethods.java - Player management
src/main/java/org/nitrowater/velochatx/manager/PlayerManager.java
Additional features
- Broadcasts
src/main/java/org/nitrowater/velochatx/domain/broadcast/BroadcastServiceImpl.java - Tab-list updates
src/main/java/org/nitrowater/velochatx/domain/tablist/TabListServiceImpl.java - Tab-list task
src/main/java/org/nitrowater/velochatx/domain/tablist/TabListUpdateTask.java - Documented integrations
Other components
- Players
Connections 20
- Event handling → Chat formatting: filters and formats
src/main/java/org/nitrowater/velochatx/domain/event/handler/VCXEventHandler.java - Event handling → Channel rules: checks channels
src/main/java/org/nitrowater/velochatx/domain/event/handler/VCXEventHandler.java - Event handling → Player data: looks up players
src/main/java/org/nitrowater/velochatx/domain/event/handler/VCXEventHandler.java - Event handling → Server registry: reads server
src/main/java/org/nitrowater/velochatx/domain/event/handler/VCXEventHandler.java - Event handling → Broadcasts: broadcasts joins
src/main/java/org/nitrowater/velochatx/domain/event/handler/VCXEventHandler.java - Event handling → Tab-list updates: queues updates
src/main/java/org/nitrowater/velochatx/domain/event/handler/VCXEventHandler.java - Tab-list updates → Tab-list task: processes tasks
src/main/java/org/nitrowater/velochatx/domain/tablist/TabListServiceImpl.java - Channel and broadcasts → Plugin setup: loads configuration
src/main/java/org/nitrowater/velochatx/manager/ChannelManager.java - Shared proxy state → Channel and broadcasts: initializes
src/main/java/org/nitrowater/velochatx/manager/BasicMethods.java - Shared proxy state → Player management: initializes
src/main/java/org/nitrowater/velochatx/manager/BasicMethods.java - Shared proxy state → Proxy server state: creates state
src/main/java/org/nitrowater/velochatx/manager/BasicMethods.java - Player management → Player persistence: persists player data
src/main/java/org/nitrowater/velochatx/manager/PlayerManager.java - Player management → Player attribution: reads attribution
src/main/java/org/nitrowater/velochatx/manager/PlayerManager.java - Player data → Player persistence: delegates persistence
src/main/java/org/nitrowater/velochatx/domain/player/PlayerServiceImpl.java - Proxy server state → Channel state: tracks membership
src/main/java/org/nitrowater/velochatx/utils/SubServer.java - Players → Event handling: trigger events
- Documented integrations → Chat formatting: permissions and filtering
- Documented integrations → Broadcasts: timed broadcasts
- Documented integrations → Tab-list updates: customizes tab list
- Documented integrations → Player data: localization and language