Skip to content

RTP Documentation Index

Canonical entry point. One-line purpose per doc, plus a task → file(+anchor) router so agents can fetch slices instead of whole documents.

Task router (fetch this file + anchor, not the whole tree)

Task Open
New-dev walkthrough by behavior / symptom CODE_TOUR.md
Plugin startup / onEnable ordering ../architecture/06-plugin-setup-lifecycle.md
/rtp command → world / region / permission decision tree ../architecture/07-rtp-command-region-selection.md
Location selection — per-attempt pipeline (shape → chunk → vert → biome → safety) ../architecture/08-location-selection-per-attempt.md
Configuration load / /rtp reload data flow ../architecture/09-configuration-load-and-reload.md
Shutdown / onDisable flush + chunk-ticket release ordering ../architecture/10-shutdown-and-flush-lifecycle.md
Configuration write / /rtp config save path (atomic rename, audit, rollback) ../architecture/11-configuration-write-and-persist.md
Network model diagrams (multi-server / multi-proxy topology, /rtp sequence, reservation-token state machine) ../architecture/12-network-model.md
/rtp config command semantics + save mechanics (target spec) CONFIG_COMMAND_SPEC.md (ADR-037 decision, ADR-041 implementation)
What absolute rules apply? REQUIREMENTS.md §3 (S-001 … S-007)
Where does my code go? ARCHITECTURE.md
Threading / Folia / chunk I/O DESIGN.md#threading
Memory lifecycle DESIGN.md#memorytracker
Domain term meaning GLOSSARY.md
REQ-* → class → test TRACEABILITY.md
Prior pitfalls / reproduction notes LESSONS_LEARNED.md
Requirement-authoring style (shall, no temporal framing) RULES.md
Commenting an option in a shipped YAML config CONFIG_COMMENT_STYLE.md
A decision (why something is the way it is) ../adr/README.md
How a developer ought to work in this repo, and why (full lifecycle: intake, planning, read-document-modify, design records, verification, divergence handling, communication, self-maintenance, optional AI tooling) ../adr/ADR-000-development-workflow.md
Fabric status / blockers MULTI_PLATFORM_PLAN.md
Multi-server / proxy (Velocity, BungeeCord) plan MULTI_SERVER_PLAN.md (D-005 gated; admin stub: ../admin/proxies/INDEX.md)
Why network mode (multi-server, multi-proxy) is in scope ../adr/ADR-036-network-mode-multi-server-multi-proxy.md (umbrella; subproject refinements under ../../platforms/rtp-proxy/docs/adr/)
Runtime metrics SPI (TPS / MSPT / heap / pipeline samples) METRICS_PLAN.md
Why Fabric is in scope (and Forge / NeoForge are not) ../../platforms/rtp-fabric/docs/adr/rtp-fabric-ADR-002-platform-in-scope.md (renumbered from ADR-022)
Why legacy MC / Java are out of scope ../adr/ADR-021-legacy-mc-and-java-support-scope.md
Adding or updating a locale / translation TRANSLATION_GUIDE.md
Spiral 1D math ../adr/ADR-001-archimedean-spiral-1d-mapping.md
Anvil prefilter / biome / shared module ../adr/ADR-016-anvil-subsystem.md
Block tags / state predicates in safety lists ../adr/ADR-017-block-tags-and-state-predicates-in-safety-lists.md
Coverage targets COVERAGE_PLAN.md
Server-admin docs ../FOR_SERVER_ADMINS.md../admin/ (CONFIGURATION.md, REGIONS.md, CORE_CONFIG.md, PERFORMANCE.md, ECONOMY.md, SAFETY.md)
Addon author docs ../FOR_ADDON_DEVELOPERS.md
Build a destination menu / GUI on rtp-api ADDON_MENUS.md
Offer remote (network-mode) destinations from an addon ADDON_CROSS_SERVER.md
How to load / deploy an addon (ServiceLoader, classpath, lifecycle) ADDON_LOADING.md (ADR-057)
Flat map of every doc ../MAP.md
Hazards and failure modes ../admin/HAZARDS.md
Failure detection and responses ../admin/HAZARDS.md#failure-modes
External hooks (claim verifiers, economy, placeholders, world border, anvil prefilter) EXTERNAL_HOOKS.md (ADR-026)
How and why AI tooling is used in this repository AI_USAGE.md

Normative (read before writing code)

Doc Purpose
REQUIREMENTS.md Absolute laws: threading, memory, command contexts, safety prohibitions (REQ-* IDs, S-00x prohibitions).
ARCHITECTURE.md Module separation and ArchUnit-enforced import boundaries.
DESIGN.md Threading model, MemoryTracker lifecycle, region caching, chunk-reservation flow.
GLOSSARY.md Canonical domain terms; overloaded-word disambiguation.
RULES.md Requirement/ADR authoring rules (shall phrasing, absolute state, no temporal framing) and the document type catalog.
../adr/README.md ADR index.
../../rtp-<module>/REQUIREMENTS.md Module-level requirement files.

Reference (consult on demand)

Doc Purpose
CONCEPTS.md Archimedean spiral math; see ADR-001 for the decision.
TRACEABILITY.md REQ-* → class/method → test mapping.
COVERAGE_PLAN.md JaCoCo baseline and targets.
MULTI_PLATFORM_PLAN.md Active Fabric frontier status.
MULTI_SERVER_PLAN.md Proxy / multi-server (Velocity, BungeeCord) roadmap; D-005 gated.
METRICS_PLAN.md Runtime metrics SPI (TPS/MSPT/heap/queue/pipeline); implementation eligible.
ROADMAP.md Forward-looking work.
STAKEHOLDERS.md Roles and review expectations.
LESSONS_LEARNED.md Dated engineering notes.

Plans that shipped or were superseded are removed; the ADR is the durable record. Pre-deletion state is recoverable from git.

Agent / contributor entry points

Doc Purpose
../../.junie/AGENTS.md Top-level operational guide. Start here.
../../CONTRIBUTING.md Human contributor workflow.
../../CHANGELOG.md Release notes.