Welcome!

By registering with us, you'll be able to discuss, share and private message with other members of our community.

SignUp Now!

DonutRTPzone - Automatic Random Teleport Plugin - Documentation

ShyamSai

ShyamSai

๐€๐๐ฆ๐ข๐ง๐ข๐ฌ๐ญ๐ซ๐š๐ญ๐จ๐ซ๐ฌ
Jan
21
3
๐ƒ๐„๐•๐„๐‹๐Ž๐๐„๐‘ & ๐€๐ƒ๐Œ๐ˆ๐
๐…๐จ๐ฎ๐ง๐๐ž๐ซ
๐Œ๐ž๐ฆ๐›๐ž๐ซ
DonutRTPzone is a premium Minecraft plugin that creates designated zones where players are automatically teleported to random locations after a configurable countdown. Perfect for PvP arenas, loot zones, or any area where you want to add unpredictability and excitement.​


Features​

  • WorldGuard Integration: Define specific regions as RTP zones using WorldGuard
  • Configurable Countdown Timer: Set custom countdowns before teleportation occurs
  • Group or Individual Teleport Modes: Teleport players together or to separate locations
  • Biome & Block Filtering: Control where players can be teleported to
  • Visual & Audio Feedback: Custom titles, subtitles, and sound effects
  • PlaceholderAPI Integration: Display countdown timer anywhere
  • Folia Support: Fully compatible with Folia server implementation
  • Safe Teleportation: Ensures players land on safe blocks
  • Multi-region Support: Configure multiple RTP zones with the same settings

Installation​

  1. Download the DonutRTPzone.jar file
  2. Place it in your server's plugins folder
  3. Ensure you have the required dependencies:
    • WorldGuard
    • PlaceholderAPI
  4. Restart your server
  5. Get your license key from our Discord server
  6. Add your license key to the config.yml file
  7. Define your RTP zones in the config.yml file
  8. Reload the plugin with /donutrptzone reload

Commands​


Admin Commands​

CommandDescriptionPermission
/donutrptzone reloadReloads the plugin configurationdonutrptzone.admin

Permissions​

PermissionDescriptionDefault
donutrptzone.adminAllows the use of admin commandsop

Configuration​

The main configuration file config.yml allows you to customize all aspects of the plugin:

Code: 
# Get your license key from our discord server
# This key is required to use the plugin
License: ""

# List of WorldGuard regions where the RTP functionality will be active
# You can add multiple regions by adding new lines with a dash (-)
regions:
  - rtpzone

# Random Teleport (RTP) settings
rtp:
  # Teleportation mode: "GROUP" or "INDIVIDUAL"
  # GROUP: Players will teleport close to each other (original behavior)
  # INDIVIDUAL: Each player gets their own random location
  mode: "GROUP"

  # The world where players will be teleported
  world: world
 
  # The minimum and maximum X coordinates for teleportation
  MinX: -1000
  MaxX: 1000
 
  # The minimum and maximum Z coordinates for teleportation
  MinZ: -1000
  MaxZ: 1000
 
  # List of block types that players should not be teleported onto
  blacklist:
    - LAVA
    - WATER
    - POWDER_SNOW
    
  # List of biomes that players should not be teleported into
  biomes:
    - OCEAN
    - LUKEWARM_OCEAN
    - DEEP_OCEAN
    - DEEP_LUKEWARM_OCEAN
    - DEEP_WARM_OCEAN
    - WARM_OCEAN
    - COLD_OCEAN
    - FROZEN_OCEAN
    - DEEP_COLD_OCEAN

# The prefix that will be shown in messages and titles
# You can use hex color codes (&#RRGGBB) and regular color codes (&a, &b, etc.)
prefix: "&#d00000ส€แด›แด˜ แดขoษดแด‡"

# The countdown time in seconds before players are teleported
timer: 30

# Customizable messages shown to players
subtitles:
  # Message shown during the countdown, %donutrtp_zone% will be replaced with the time left
  timer: "&fTeleporting in: %donutrtp_zone%"
  # Message shown after teleportation
  teleported: "&fFight players and steal their loot"

# Sound effects for different events
sounds:
  # Sound played when a player enters the RTP region
  enter_region:
    sound: "BLOCK_BEACON_POWER_SELECT"
    pitch: 0.5
  # Sound played during the countdown
  countdown:
    sound: "BLOCK_BEACON_AMBIENT"
    pitch: 0.5
  # Sound played when a player exits the RTP region
  exit_region:
    sound: "BLOCK_BEACON_DEACTIVATE"
    pitch: 0.5
  # Sound played when a player is teleported
  teleported:
    sound: "BLOCK_END_GATEWAY_SPAWN"
    pitch: 0.5


Configuration Sections Explained​


Regions​

List all WorldGuard regions where players will be affected by the plugin. Players entering these regions will trigger the countdown timer and eventually be teleported.


Example:
Code: 
regions:
  - rtpzone
  - pvp_arena
  - loot_area

RTP Settings​


Teleport Mode​

  • GROUP: All players teleport to locations near each other (good for team events)
  • INDIVIDUAL: Each player gets their own random location (good for PvP scenarios)

World and Coordinate Settings​


Define the world and area where players will be teleported to:
Code: 
world: world  # The world name
MinX: -1000   # Minimum X coordinate
MaxX: 1000    # Maximum X coordinate
MinZ: -1000   # Minimum Z coordinate
MaxZ: 1000    # Maximum Z coordinate


Blacklisted Blocks​


Prevent players from being teleported onto dangerous blocks:
Code: 
blacklist:
  - LAVA
  - WATER
  - POWDER_SNOW

Biome Filtering​


Prevent players from being teleported into specific biomes:

Code: 
biomes:
  - OCEAN
  - DEEP_OCEAN
  # Add any biome names here


Timer Settings​


Set the countdown time in seconds before players are teleported:

Code: 
timer: 30  # 30 seconds countdown

Message Customization​


Customize all messages shown to players:

Code: 
prefix: "&#d00000ส€แด›แด˜ แดขoษดแด‡"  # Title shown to players
subtitles:
  timer: "&fTeleporting in: %donutrtp_zone%"  # Shows countdown
  teleported: "&fFight players and steal their loot"  # After teleport

Sound Effects​


Configure sounds for different events:

Code: 
sounds:
  enter_region:
    sound: "BLOCK_BEACON_POWER_SELECT"
    pitch: 0.5
  countdown:
    sound: "BLOCK_BEACON_AMBIENT"
    pitch: 0.5
  exit_region:
    sound: "BLOCK_BEACON_DEACTIVATE"
    pitch: 0.5
  teleported:
    sound: "BLOCK_END_GATEWAY_SPAWN"
    pitch: 0.5

PlaceholderAPI Integration​


DonutRTPzone includes PlaceholderAPI integration with the following placeholders:

PlaceholderDescription
%donutrtp_zone%Shows the current countdown timer

You can use this placeholder in the subtitle message or with other plugins that support PlaceholderAPI.

​


Technical Information​

  • Dependencies: WorldGuard, PlaceholderAPI
  • API Version: 1.20
  • Folia Support: Yes
  • Server Requirements: Paper, Spigot, or Folia

Support​

If you need help with the plugin:

FAQ​


Q: How do I get a license key?​

A: Join our Discord server at discord.gg/KXE2fabH to obtain your license key.

Q: Can I have multiple RTP zones with different settings?​

A: Currently, all RTP zones share the same settings. Future updates may include per-region configuration.

Q: Does this plugin work on Folia servers?​

A: Yes, DonutRTPzone has full Folia support with optimizations specific to the Folia environment.

Q: How does the GROUP teleport mode work?​

A: In GROUP mode, all players are teleported to locations near each other, with a small offset to prevent overlapping.

Q: Can I change the countdown time?​

A: Yes, you can set the countdown time in the config.yml file using the timer option.

Q: How do I show the countdown timer to players?​

A: The timer is automatically shown to players via subtitles. You can also use the %donutrtp_zone% placeholder with other plugins.
 
You must log in or register to reply here.
Top