Operator Documentation Index¶
Welcome to the LeafRTP operator documentation catalog. This index routes server administrators and network operators through all operational guides, command references, configuration specifications, and visual tools.
Getting Started & Operations¶
| Guide | Description |
|---|---|
| Quick Start | 10-minute cold-start guide covering installation, default regions, and essential permissions. |
| Server & Network Design Guide | Complete blueprints for obvious and non-obvious server topologies (single SMP, Folia, Nether/End/cave/ocean worlds, auth lobbies, multi-backend proxies, and LeafRTP + LeafSleep clusters). |
| Web Workspace & Editor Guide | Operational runbook for the browser-based 2D cartography canvas, live staging diff inspector, and ephemeral /rtp editor workflow. |
| Command Reference | Exhaustive reference of every /rtp subcommand, parameter, syntax, and permission node. |
| Operator Runbook | Incident response procedures structured by Symptom → Diagnosis → Resolution. |
| Actions & Arenas | Event triggers, world hooks, and arena boundaries. |
| Prefabs | Ready-to-deploy configuration blueprints for typical server setups. |
| Common Recipes | Practical recipes for popular server configurations and gameplay modes. |
| FAQ | Frequently asked questions regarding performance, claim hooks, and biomes. |
| Migration Guide | Step-by-step upgrade instructions when transitioning from legacy setups or third-party plugins. |
| Addons | Ecosystem addons, GUI menus, and claim integrations. |
Configuration Reference¶
The complete reference suite for all configuration files lives under configuration/:
- Configuration Overview
- Configuration Lifecycle
- Core Settings (
config.yml) - Regions (
regions/*.yml) - Worlds (
worlds/*.yml) - Schematics (
schematics/) - Safety & Hazards (
safety.yml) - Performance & Caches (
performance.yml) - Economy (
economy.yml) - Events & Visual Effects (
events.yml) - Integrations & Claims
- Messages (
messages.yml) - Language & Locales
- Logging
- Metrics & Health Signals
- Spatial Memory TTL
Multi-Server & Proxy Mode¶
Admin guides for multi-backend network setups behind Velocity or BungeeCord proxies live under proxies/: