Documentation Index
Fetch the complete documentation index at: https://docs.borntocraftstudio.net/llms.txt
Use this file to discover all available pages before exploring further.
Ghost Extension
Real-time cross-server player visualization using Redis technology.
[!IMPORTANT] Redis and BTC Core are mandatory for this extension to function.
Cross-Server Visibility
Synchronize player positions, skins, and animations across different server instances.
High Performance
Powered by Redis pub/sub and PacketEvents for minimal latency and server tick impact.
Key Features
- Real-Time Synchronization: High-frequency position updates handled outside the main server tick.
- Toggleable Visibility: Players can choose to hide ghosts using simple commands to reduce visual clutter.
- Smart Filtering: Configurable world-based broadcasting and hiding of close-proximity ghosts.
- Client-Side Rendering: Ghosts are rendered as purely virtual entities (Packets), ensuring they don’t interfere with physics or server performance.
- Skin Support: Automatically fetches and maintains player skins for full visual immersion.
Commands & Permissions
Player Commands
| Command | Description |
|---|---|
/ghost toggle | Toggle the visibility of ghost players on your screen. |
Permissions
| Permission | Description |
|---|---|
typewriter.ghost.use | Allows the player to see and interact with ghosts. |
Configuration
The configuration is managed viaghost_player/config.yml.
| Setting | Default | Description |
|---|---|---|
update-rate | 5 | Ticks between position broadcasts. |
server-name | random | Unique identifier for the current server instance. |
allowed-worlds | [] | List of worlds where ghosts should be visible. |
Dependencies
| Extension | Usage |
|---|---|
| BTC Core | Mandatory. Core engine dependency. |
| MySQL/Redis | Mandatory. Required for cross-server data synchronization. |