ABOUT
RegionTeleport is a plugin for teleporting all players within one or more WorldGuard regions to one or more spawn location. This is handy for a bunch of occasions, like hosting custom events and wanting to teleport everyone out at the end or teleporting the victor(s) out of the arena.
FEATURES
- Spawn locations to teleport players from specified region(s) to.
- Teleporting all players from specified region(s) to the specified location(s).
- Stop certain players from being teleported.
SETUP
- Download the RegionTeleport.jar.
- Make sure your server is running Java 17 or higher.
- Download WorldGuard (Must be version 7.0.0 or higher).
- Upload all files to your plugins folder.
- Reload/Restart your server.
DEPENDENCIES
- WorldGuard (7.0.0+) - Required for the entire plugin to work.
SOFT DEPENDENCIES
CMI (9.0.0.0+) - Adds the ability to use cmi warps as spawn locations. Enabled through config.
Usage: /regiontp tp <region> cmi:<warp>
EssentialsX - Adds the ability to use essentials warps as spawn locations. Enabled through config.
Usage: /regiontp tp <region> ess:<warp>
PlaceholderAPI - Adds a few placeholders (see below)
COMMANDS & PERMISSIONS
<> = required, () = optional, -s = hide message
Command: /regiontp help - Shows all commands
Permission: regiontp.command.help
---
Command: /regiontp teleport/tp <region1,region2,...> <spawn1,spawn2,...> (-s) - Teleports all players within the region to the specified location. Use comma to separate multiple regions & spawns.
Permission: regiontp.command.teleport
---
Command: /regiontp reload - Reloads the plugin
Permission: regiontp.command.reload
---
Command: /regiontp setspawn <name> - Creates a spawn location where you're standing
Permission: regiontp.command.setspawn
---
Command: /regiontp delspawn <name> - Deletes the specified spawn location
Permission: regiontp.command.delspawn
---
Command: /regiontp spawnlist - Shows all spawn locations
Permission: regiontp.command.spawnlist
---
Command: /regionclear <region(s)> <type(s)> (-s) (-w:[worldname]) - Remove all specified entities from all specified regions
Permission: regiontp.command.clear
Available Types:
-all (Removes all monsters/animals/ambient/items/vehicles that aren't named, tamed or an npc)
-monsters
-animals
-ambient (bat)
-items( :<item name(s)>) (separate different item types with commas)
-vehicles (Doesn't include living vehicles like horses, use -animals for those)
-specific:<entity name(s)> (separate different entity types with commas)
-displays (Only 1.19.4+)
-named(-only:[name])
-tamed(-only)
-npcs(-only) (Will also remove any entities that have the metadata "NPC". Usually this would be CitizensNPCs)
Using -only will remove only those entities. So, "-named-only" would only remove named entities, and "-named-only:Steve" would only remove entities named Steve.
Examples:
/regionclear __global__ -animals -named-only:dave -w:world1 (Would remove any animals named dave in world1)
/regionclear example1,example2 -items:diamond,dirt -animals -tamed (Would remove all animals, all tamed animals & any dropped diamonds/dirt items from the regions example1 & example2)
/regionclear example1 -specific:sheep,ender_crystal (Would remove any sheep & end crystals in the region example1)
---
Permission: regiontp.teleport.bypass
- Does so the player doesnt get teleported if he is within the region.
---
Permission: regiontp.*
- Gives you all permissions except teleport bypass.
CONSOLE COMMANDS
(Most commands work in the console, however any not listed here work as listed above)
Command: /regiontp teleport/tp <region> <spawn> <world> (-s) - Teleports all players within the region to the specified location
---
Command: /regiontp setspawn <name> <x> <y> <z> <world> - Creates a spawn location where you're standing
PLACEHOLDERS
%regionteleport_player_count_w:<world>_r:<region>% - Counts amount of players in that region in that world. use __global__ for entire world.
---
%regionteleport_player_count_exclude_bypass_w:<world>_r:<region>% - Counts amount of players except for players with teleport bypass permission in that region in that world. use __global__ for entire world.