CompassTeleport · Administrator configuration

Installation and first start

1. Stop the server and back up the worlds, the plugins/ directory, and the server log.
2. Download a JAR from CompassTeleport GitHub Releases.
3. Put the JAR in the server’s plugins/ directory. Keep only one CompassTeleport JAR there.
4. Start the server and confirm in the console that the plugin enabled successfully.
5. On first enable, inspect plugins/CompassTeleport/config.yml. Restart the server after editing it. The plugin has no configuration reload command.
6. Test binding, renaming, and teleporting with a non-OP account before opening the feature to ordinary players.

Configuration

The default configuration is:

cooldown-sec: 15
delay-sec: 5
cost-level: 1

Key	Default	Purpose
cooldown-sec	15	Seconds each player must wait after a teleport task completes before using another one.
delay-sec	5	Seconds between the air right-click and the teleport. At 0, a short internal scheduler wait still remains.
cost-level	1	Experience-level cost for renaming the lodestone compass in an anvil, not an experience cost per teleport.

If the server already has a config.yml, the plugin keeps the values in that file. Use that file as the source of truth.

Permission node

Node	Default	Controls
compassteleport.use	true	Allows a player to use an already prepared teleport compass.

The plugin checks this node when a player right-clicks the air to teleport. It does not prevent binding a compass to a lodestone. It does not prevent renaming the compass in an anvil. To limit teleport use to one group, disable default inheritance for ordinary groups. Then grant this node to the selected group.

Operational checks and troubleshooting

• Test with a non-OP account. OP can bypass the rules from a permission manager.
• If no teleport message appears, confirm that the item is an anvil result created by the plugin. Also confirm that the player has compassteleport.use.
• If the compass is invalid, check that the lodestone exists, that the compass tracks it, and that the target world is loaded.
• If a teleport starts but does not complete, record the server core, configuration values, and full console log. Reproduce the problem on a test server.
• The plugin stores the cooldown and pending teleport tasks in memory. A restart clears a player’s previous cooldown.