Regions

Files in the regions/ directory define the target areas players land in. Each region keeps its own spatial memory, location cache, and tasks. There is one file per region (e.g. regions/default.yml); new regions are copied from default.yml. Do not delete default.yml.

A region mainly controls its shape (the x/z distribution) and vert (how a Y level is chosen). See the Shapes page for shape types.

Brackets signify a placeholder, e.g. [region] -> nether.

Setup

A main goal of this plugin is intuitive interaction. When using parameters that don't map to a known region, the plugin instantiates a single-use region and starts searching from scratch; if used for general teleportation, this can lead to unexpectedly long teleport times. The steps below patch that knowledge gap.

Inspecting regions and worlds

With the rtp.info permission, you can check region and world settings for any regions and worlds you have access to:

/rtp info
/rtp info region=[]
/rtp info world=[]

Single world, single region

The simplest configuration: one place you want people to go when they teleport randomly. There's already a default region, and you can adjust it to your needs by editing regions/default.yml, or more simply with /rtp config regions default [setting]=[value] (any/all settings, in any order).

Single world, multiple regions

More regions means more configuration. Create a new region by adding a file in the regions/ directory (copy default.yml), or more simply with /rtp config regions add=[new region name].

To delete a region, remove its file from the regions directory after shutdown.

Only one region can be selected by default when using /rtp. Change that region mapping in worlds/[world name].yml or with /rtp config worlds [world name] region=[]. If a world added at runtime is not being recognized, it should be available on next restart.

Multiple worlds, multiple regions

As above, there is one default region, so you need to make more (follow the instructions above for creating regions).

To create regions in other worlds, modify world in regions/[].yml or specify world=[] in your /rtp config regions commands. To call regions from other worlds, modify worlds/[world name].yml or use /rtp config worlds [world name] region=[].

Keys

Key	Default	Purpose
world	"[0]"	Target world. [0] = the server's primary world.
worldBorderOverride	false	Use the vanilla /worldborder radius as the shape if true.
shape	(CIRCLE block)	Shape name plus its parameters (radius, centerRadius, centerX, centerZ, weight, uniquePlacements, expand, ...). The available sub-keys update with the chosen shape.
vert	(JUMP block)	Vertical adjustor name plus parameters (minY, maxY, step, requireSkyLight).
requirePermission	false	If true, the player needs rtp.regions.<name>.
override	default	Region to redirect to when the player lacks permission. Infinite override loops are detected and broken.
cacheCap	50	Max pre-calculated safe locations kept warm for this region.
backlogCacheCap	1000	L3 backlog buffer capacity (unverified candidates pre-filtered by the anvil pre-filter); 0 disables it.
activeChunkCap	10	Max chunks kept loaded for zero-latency teleports.
price	0.0	Per-region economy cost override.
spatialResolution	3	Precision for bad-location tracking (1-5).
biomeWhitelist / biomes	(from safety.yml)	Optional per-region biome whitelist/blacklist override. See Biome Controls.
displayName	(region name)	Optional cosmetic display name; does not change the region's identity.
version	1.0	Internal schema version. Do not edit.

Changing a region's shape clears its learned spatial memory, since the old bad-location data no longer matches. Finalize region settings before running /rtp scan.

Editing

Edit the file on disk and run /rtp reload regions, or change keys at runtime:

/rtp config regions <region> radius=512
/rtp config regions add=<new region name>