Installation

Installation Guide

Setting up PixelRTPPool is a straightforward process, but strictly relies on specific dependencies to function efficiently.

Requirements

• Server Software: Paper 1.21.11+ (or its high-performance forks like Purpur, Pufferfish).
• Java: Java 21 or higher.

Dependencies

Required Dependencies

1. WorldGuard (v7+): Used for defining the physical RTP pool boundaries.
2. WorldEdit: Required by WorldGuard to function.

Optional Dependencies

• PlaceholderAPI: Enables the use of %pixelrtppool_cooldown% and other dynamic variables in your server's scoreboards, chat, and TAB.
• RTP Plugin: By default, PixelRTPPool executes a command (like /rtp). You will need an actual RTP plugin installed (e.g., BetterRTP, SimpleRTP) to handle the actual teleportation math if using the default CommandProvider.

Installing the Plugin

1. Download the latest PixelRTPPool-1.0.0.jar from the Releases page.
2. Download WorldGuard and WorldEdit.
3. Place all downloaded .jar files into your server's plugins/ directory.
4. Restart your server. Do not use /reload or plugman to load it for the first time.

First Startup

Upon successful startup, the server console will display a branded log confirming the plugin is ready:

================================================

PixelRTPPool v1.0.0

Developed by PG
Pixel Productions

================================================

✔ WorldGuard Hooked
✔ PlaceholderAPI Hooked
✔ Teleport Mode: PLAYER
✔ Loaded RTP Regions: 1
✔ Configuration Loaded
✔ Ready

================================================

Folder Structure

After the first startup, a new configuration folder will be generated:

plugins/
└── PixelRTPPool/
    └── config.yml

You will use config.yml to define all behaviors, which is covered in the Configuration Guide.

Common Mistakes

• Spigot Server: PixelRTPPool relies on the Adventure API (MiniMessage) bundled with Paper. It will crash on standard Spigot.
• Java 17: Ensure your host is running Java 21. Java 17 will result in an UnsupportedClassVersionError.
• Missing WorldGuard: The plugin will aggressively disable itself if WorldGuard is missing, as it relies on its Session API.

---

🏡 Home | 📖 Read Next: Configuration