Skip to content

RTP Addons Requirements

This document details the requirements and constraints for any external addons integrating with the RTP plugin.

1. Strict Architectural Requirements

1.1 Fault Encapsulation and Isolation

  • Strict Isolation: External addons (e.g., LeafRTPCountdownAddon) must execute within strict isolation. Listeners and validation checks must wrap their logic in try-finally blocks to guarantee that third-party database timeouts or API errors do not fail the parent RTP queue pipelines. The claim-plugin integrations formerly shipped as RTP_ClaimPluginIntegrations now ship as the bundled LeafRTPClaimAddon (see ADR-069, superseding ADR-019); the standalone RTP_Glide addon was folded into effects-api as the GLIDE effect (effects-api-ADR-001); the experimental RTP_Iris_integration addon has been removed (the Iris world generator works against the standard org.bukkit.World API without dedicated integration); third-party addons should consult LeafRTPCountdownAddon as the canonical template.

1.2 Non-Blocking Operations

  • Strict Adherence to Non-Blocking IO: Addons interacting with land-protection or biome APIs must perform verifications asynchronously. Pausing the main thread or halting a teleport queue while waiting on a synchronous third-party claim check is strictly prohibited.

1.3 Memory Management

  • Scoped Memory Bounding: Addons must not maintain unbounded collections of active teleport states. They must limit their footprint by dynamically querying the core MemoryTracker or leveraging scoped, lock-free caches to maintain performance consistency.

1.4 Bundled Addons

  • Removable and Replaceable: An addon bundled inside the RTP distribution jar (e.g., LeafRTPGuiAddon, LeafRTPClaimAddon, LeafRTPCountdownAddon, LeafRTPActionAddon) shall depend only on rtp-api, shall not be required for core teleportation to function, and shall be removable by deleting its extracted jar from plugins/RTP/addons/. A third-party addon implementing the same SPI (e.g., the ADR-056 bare-/rtp root action for GUIs) shall be able to replace it without core changes. Operator-facing behaviour is documented in docs/admin/ADDONS.md.