HubParkour Guide¶
HubParkour is a lightweight parkour plugin for Bukkit, Spigot, and Paper hub/lobby servers. Players start a course by walking into an invisible start zone, pass optional checkpoints, and finish by touching an end zone. The plugin tracks best times, completions, falls, and displays leaderboards through both a command and in-game ArmorStand holograms.
At a glance:
- Hub-local parkour courses with no BungeeCord messaging.
- In-game course creation with configurable wand items.
- Invisible start, checkpoint, and end zones using single-block or cuboid volumes.
- Live timer via action bar or boss bar.
- Per-player best times, completions, and fall counts.
- Leaderboard command and per-course ArmorStand holograms.
- PlaceholderAPI support for custom holograms, scoreboards, and TAB.
- Configurable sounds, particles, and GUI click sounds.
- Full admin GUI accessible with
/parkour adminor/parkour gui. - Launch pads with automatic arc calculation and per-pad tuning.
- Per-course start permission
hubparkour.course.<courseId>. - Flight, elytra, mount, item, command, hunger, and damage protections while running.
Install¶
- Put
HubParkour-1.0.0.jarinto your server'splugins/folder. - Restart the Minecraft server.
- The plugin will create:
plugins/HubParkour/config.ymlplugins/HubParkour/messages.ymlplugins/HubParkour/courses.ymlplugins/HubParkour/holograms.ymlplugins/HubParkour/playerdata/<uuid>.yml
Quick Start¶
Create a simple course in-game:
- Run
/parkour create lobby_tower. - Left-click the block under the start area with the Start Wand.
- Left-click checkpoint blocks with the Checkpoint Wand, if wanted.
- Left-click the block under the finish area with the End Wand.
- Run
/parkour save. - Walk into the start zone to begin.
The plugin treats the block above the clicked block as the zone. This lets you click the floor and create a zone where the player stands.
Admins can also use /parkour admin or /parkour gui to create and edit courses through the in-game menu.
Commands¶
Main command: /parkour (aliases: /pk, /pkr)
Player Commands¶
| Command | Permission | Description |
|---|---|---|
/parkour |
hubparkour.command.base |
Show help. |
/parkour stats [course] |
hubparkour.command.stats |
Show your stats. |
/parkour leaderboard <course> |
hubparkour.command.leaderboard |
Show top times. |
/parkour top <course> |
hubparkour.command.leaderboard |
Alias for /parkour leaderboard. |
/parkour quit |
hubparkour.command.quit |
Leave your current run. |
/parkour restart |
hubparkour.command.restart |
Restart your current course. |
Admin Commands¶
| Command | Permission | Description |
|---|---|---|
/parkour create <courseId> |
hubparkour.admin.create |
Start creating a course. |
/parkour save |
hubparkour.admin.save |
Save the current creation session. |
/parkour cancel |
hubparkour.admin.cancel |
Cancel the current creation session. |
/parkour delete <courseId> |
hubparkour.admin.delete |
Delete a course and its hologram. |
/parkour edit <courseId> |
hubparkour.admin.edit |
Load a course into creation mode. |
/parkour setname <courseId> <name> |
hubparkour.admin.setname |
Set the course display name. |
/parkour setdifficulty <courseId> <difficulty> |
hubparkour.admin.setdifficulty |
Set EASY, MEDIUM, HARD, or EXPERT. |
/parkour setfallthreshold <courseId> <blocks> |
hubparkour.admin.setfallthreshold |
Set the Y-drop fall threshold. |
/parkour setfallmode <courseId> <mode> |
hubparkour.admin.setfallmode |
Set Y_DROP, OUT_OF_BOUNDS, or DISABLED. |
/parkour setquitlocation <courseId> |
hubparkour.admin.setquitlocation |
Set the quit teleport location. |
/parkour setfinishlocation <courseId> |
hubparkour.admin.setfinishlocation |
Set the finish teleport location. |
/parkour setlaunchpower <courseId> <number> <multiplier> |
hubparkour.admin.setlaunchpower |
Set a launch pad's forward power. |
/parkour setlaunchheight <courseId> <number> <multiplier> |
hubparkour.admin.setlaunchheight |
Set a launch pad's upward power. |
/parkour setlaunchoffset <courseId> <number> <blocks> |
hubparkour.admin.setlaunchoffset |
Set a launch pad's landing offset. |
/parkour listlaunches <courseId> |
hubparkour.admin.listlaunches |
List a course's launch pads. |
/parkour removelaunch <courseId> <number> |
hubparkour.admin.removelaunch |
Remove a launch pad by number. |
/parkour toggle <courseId> |
hubparkour.admin.toggle |
Enable or disable a course. |
/parkour hologram <courseId> |
hubparkour.admin.hologram |
Create a leaderboard hologram. |
/parkour hologram movehere <courseId> |
hubparkour.admin.hologram |
Move a hologram to your location. |
/parkour hologram remove <courseId> |
hubparkour.admin.hologram |
Remove a hologram. |
/parkour hologram list |
hubparkour.admin.hologram |
List all configured holograms. |
/parkour resetstats <player> <courseId> |
hubparkour.admin.resetstats |
Reset a player's stats on one course. |
/parkour admin or /parkour gui |
hubparkour.admin.gui |
Open the admin GUI. |
/parkour reload |
hubparkour.admin.reload |
Reload configs, messages, courses, and schedulers. |
Permissions¶
Player Permissions¶
| Permission | Default | Description |
|---|---|---|
hubparkour.command.base |
true | Use /parkour. |
hubparkour.command.stats |
true | Use /parkour stats. |
hubparkour.command.leaderboard |
true | Use /parkour leaderboard and /parkour top. |
hubparkour.command.quit |
true | Use /parkour quit. |
hubparkour.command.restart |
true | Use /parkour restart. |
Course Permissions¶
| Permission | Default | Description |
|---|---|---|
hubparkour.course.<courseId> |
OP | Start the named course. |
hubparkour.admin.bypass |
OP | Start any course without the per-course permission. |
Admin Permissions¶
| Permission | Default | Description |
|---|---|---|
hubparkour.admin.create |
op | Start course creation. |
hubparkour.admin.save |
op | Save a creation session. |
hubparkour.admin.cancel |
op | Cancel a creation session. |
hubparkour.admin.delete |
op | Delete a course. |
hubparkour.admin.edit |
op | Edit an existing course. |
hubparkour.admin.setname |
op | Set a course display name. |
hubparkour.admin.setdifficulty |
op | Set a course difficulty. |
hubparkour.admin.setfallthreshold |
op | Set a fall threshold. |
hubparkour.admin.setfallmode |
op | Set a fall mode. |
hubparkour.admin.setquitlocation |
op | Set a quit location. |
hubparkour.admin.setfinishlocation |
op | Set a finish location. |
hubparkour.admin.setlaunchpower |
op | Set launch pad forward power. |
hubparkour.admin.setlaunchheight |
op | Set launch pad upward power. |
hubparkour.admin.setlaunchoffset |
op | Set launch pad landing offset. |
hubparkour.admin.listlaunches |
op | List launch pads. |
hubparkour.admin.removelaunch |
op | Remove a launch pad. |
hubparkour.admin.toggle |
op | Enable or disable a course. |
hubparkour.admin.hologram |
op | Manage holograms. |
hubparkour.admin.resetstats |
op | Reset player stats. |
hubparkour.admin.gui |
op | Open the admin GUI. |
hubparkour.admin.reload |
op | Reload configs and schedulers. |
Wildcard permissions hubparkour.command.* and hubparkour.admin.* are provided in plugin.yml.
Course Creation Tools¶
Default tools:
| Tool | Default item | Purpose |
|---|---|---|
| Start Wand | FLINT |
Sets the start zone. |
| Checkpoint Wand | STICK |
Adds a checkpoint zone. |
| End Wand | FEATHER |
Sets the end zone. |
| Info Wand | BOOK |
Shows zone info at a clicked block. |
| Launch Wand | BLAZE_ROD |
Sets a launch pad. |
Tool behavior:
- Left-click a block: set a single-block zone above the clicked block.
- Right-click once: set the first cuboid corner above the clicked block.
- Right-click another block with the same wand: create a cuboid zone between both corners.
- Tools are disposable and can be dropped or moved like normal items.
- The Launch Wand is a two-click tool: click the launch block, then click the landing target.
Config Files¶
config.yml¶
Main settings file.