RaceLine

v1.0.0 // Spigot · Paper 1.18.2 – 26.3 // Java 17+

requires: nothing

RaceLine marks out a start line, ordered checkpoints and a finish line on any course with a wand, then times every run. It is for survival, minigame and community servers whose builders make parkour, elytra or horse courses. Checkpoints only count in order, racers who fall go back to their last checkpoint, and every fastest time keeps its splits, with no dependency.

Spoiler: Features, text version

• Wand setup — Select the start line, each checkpoint in order and an optional finish line, then set 1 to 100 laps.
• Time trials — /race start puts the player at the start, counts down and runs the chrono in the action bar.
• Multiplayer races — Waiting room with min and max players, starting grid, frozen countdown, live positions and a closing timer after the first finisher.
• Checkpoints in order — A checkpoint counts only after the one before it, so a shortcut validates nothing.
• Back to the last checkpoint — A fall below the track's fall height, lava, a forbidden zone or /race reset sends the racer back.
• Three travel modes — On foot, with an elytra and rockets lent at the start and taken back at the end, or on the racer's own mount.
• Splits and gaps — Each checkpoint and lap shows the gap to the racer's own fastest time and to the track record.
• Leaderboards — /race top, an inventory menu with records and state, and [Race] signs redrawn each time the times change.
• Rewards by place — Console commands per place and for every finisher, given only with a minimum number of racers.
• Inventory safety — Inventory, game mode and position are saved to disk and given back on leave, death, logout, stop or crash.
• Fair play — Ender pearls and chorus fruit are blocked, other teleports and game mode changes end the run, flying is never allowed.
• Admin tools — Open or close a track, force start or stop a race, clear times or remove one player's time.
• Track check — Every track is checked at startup and on reload: missing start, world not loaded, lines that touch, positions below the fall height.
• Translatable — English and French files included; every message, title, menu line, sign line and the prefix is editable.

Players use /race (alias /rl), staff use /raceadmin (alias /rladmin). Every command has tab completion and only lists what the sender may use.

Code (Text):

/race menu                   Track menu: left click time trial, right click join a race

/race list                   Tracks, their record and your fastest time

/race top <track> [page]     Fastest times of a track

/race start <track>          Start a time trial

/race join [track]           Join the waiting room of a multiplayer race

/race reset                  Back to the last checkpoint passed

/race leave                  Stop your run or leave your race

/raceadmin wand              Wand: left click corner 1, right click corner 2

/raceadmin create <name>     Create a track in your world

/raceadmin info <track>      Setup of a track and its problems

/raceadmin reload            Reload config, tracks, signs and messages

Spoiler: All commands

Code (Text):

/race help                                          raceline.player   This help

/race menu                                          raceline.menu     Track menu with state and records

/race list                                          raceline.list     Tracks, record, your fastest time, race waiting

/race top <track> [page]                            raceline.top      Fastest times of a track, your place

/race start <track>                                 raceline.start    Start a time trial (again from zero if racing)

/race join [track]                                  raceline.join     Join a waiting room (the fullest one if no track)

/race reset                                         raceline.reset    Back to the last checkpoint passed

/race leave                                         raceline.leave    Stop your run or leave your race

/raceadmin help                                     any admin node    This help

/raceadmin wand                                     raceline.setup    Wand to select zones

/raceadmin create <name>                            raceline.setup    Create a track in your world

/raceadmin setstart <track>                         raceline.setup    Selected zone = start line, your position = start

/raceadmin addcheckpoint <track>                    raceline.setup    Selected zone = next checkpoint, your position = respawn

/raceadmin delcheckpoint <track> <number|last|all>  raceline.setup    Remove checkpoints

/raceadmin setfinish <track>                        raceline.setup    Selected zone = finish line

/raceadmin delfinish <track>                        raceline.setup    No finish line: the start line ends each lap

/raceadmin setlaps <track> <laps>                   raceline.setup    Laps of a run (1-100)

/raceadmin setmode <track> <walk|elytra|mount>      raceline.setup    On foot, lent elytra, or on a mount

/raceadmin addforbidden <track>                     raceline.setup    Selected zone = forbidden (64 per track)

/raceadmin delforbidden <track> <number|last|all>   raceline.setup    Remove forbidden zones

/raceadmin setfallheight <track> [y|auto]           raceline.setup    Height below which racers are sent back

/raceadmin setlobby <track>                         raceline.setup    Your position = waiting room (any world)

/raceadmin dellobby <track>                         raceline.setup    No waiting room: players wait at the start

/raceadmin addgrid <track>                          raceline.setup    Your position = next starting grid slot

/raceadmin delgrid <track> <number|last|all>        raceline.setup    Remove grid slots

/raceadmin setplayers <track> <min> <max>|default   raceline.setup    Players of a race on this track

/raceadmin info <track>                             raceline.setup    Setup, record, race and problems of a track

/raceadmin delete <track>                           raceline.setup    Delete a track and its times

/raceadmin forcestart <track>                       raceline.manage   Start the waiting race now

/raceadmin stoprace <track>                         raceline.manage   Stop the race, everyone is sent back

/raceadmin enable <track>                           raceline.manage   Open a closed track

/raceadmin disable <track>                          raceline.manage   Close a track, its runs and race end

/raceadmin resettimes <track> confirm               raceline.times    Clear every time of a track

/raceadmin deltime <track> <player>                 raceline.times    Remove the time of one player

/raceadmin reload                                   raceline.reload   Reload config, tracks, signs and messages

Players get raceline.player by default, which covers every /race command; give raceline.admin to your staff, or only the nodes they need.

Spoiler: All permissions

Code (Text):

raceline.admin              op     Every RaceLine command, administration included

raceline.player             true   Every player command (the 7 nodes below)

raceline.menu               true   /race menu

raceline.list               true   /race list

raceline.top                true   /race top, right click on a leaderboard sign

raceline.start              true   /race start, left click in the menu

raceline.join               true   /race join, right click in the menu

raceline.reset              true   /race reset

raceline.leave              true   /race leave

raceline.setup              op     Wand and every track setup command, info, delete

raceline.manage             op     forcestart, stoprace, enable, disable

raceline.times              op     resettimes, deltime

raceline.sign               op     Make and break leaderboard signs

raceline.reload             op     /raceadmin reload

raceline.disabled.bypass    op     Race on a closed track, to test it before opening it

config.yml is commented line by line. The settings most servers change:

• language — en or fr, or any messages_xx.yml you add. Default: en.
• race.countdown-seconds — Countdown before a time trial starts (0-10). Default: 3.
• multiplayer.min-players / max-players — Players needed to start the countdown, and the most per race. Default: 2 and 8, or per track with /raceadmin setplayers.
• multiplayer.clear-inventory — Empty the inventory for the race; it is saved first and given back. Default: true.
• rewards.places — Console commands per place, with {player} {uuid} {place} {time} {track} {racers}. Default: none.
• modes.elytra.rockets — Rockets lent with the elytra (0-64). Default: 16.

Sounds, titles, the action bar, the menu items, the wand item, the leaderboard sign tag and the automatic grid are set in the same file. Every message is in messages_en.yml and messages_fr.yml. /raceadmin reload applies the changes; a YAML error keeps the previous settings and is shown in chat and console.

Spoiler: config.yml

Code (Text):

==========================================================================

 RaceLine - by Matricks

#

 Timed checkpoint races on any course built on your server. Players

 race each track against the clock; the chrono runs in the action

 bar and every best time is kept.

#

 Build a track:

   1. /raceadmin wand - a wand to select zones: left click a block

      for the first corner, right click a block for the second.

   2. /raceadmin create <name> - in the world you stand in.

   3. Select the start line, stand just behind it facing the course:

      /raceadmin setstart <name>. Runs start where you stand.

   4. Select each checkpoint, in the order they must be passed, and

      stand where a racer who falls after it comes back:

      /raceadmin addcheckpoint <name>. At least one is needed.

   5. Optional: select a finish line and stand next to it:

      /raceadmin setfinish <name>. Without one, the start line is the

      finish line and the track is a loop.

   6. Optional: /raceadmin setlaps <name> <laps>.

   7. Optional: /raceadmin setmode <name> <walk|elytra|mount>.

      walk: on foot, no elytra flight, no mount (the default).

      elytra: an elytra and rockets are lent at the start and

      taken back at the end (modes.elytra below).

      mount: racers start on their own mount and stay on it

      (modes.mount below).

   8. Optional: select a zone racers must not touch (a shortcut,

      the outside of a wall) and /raceadmin addforbidden <name>.

      Touching it sends them back to their last checkpoint.

   9. Optional: /raceadmin setfallheight <name> [y|auto].

 Players then type /race start <name> for a time trial, or

 /race join <name> for a multiplayer race.

#

 Multiplayer races (optional, per track):

   - /raceadmin setlobby <name> - the waiting room, where you stand

     (any world). Without one, players wait at the start.

   - /raceadmin addgrid <name> - one starting grid slot where you

     stand, pole position first. Without any, the grid is placed

     behind the start (multiplayer.grid below).

   - /raceadmin setplayers <name> <min> <max> - players of a race

     on this track, instead of the values below.

#

 A zone counts as passed as soon as the body of the racer touches

 it, even at elytra speed. Make lines that cover the whole width of

 the course, so nobody can go around them.

#

 Running the tracks:

   - /raceadmin disable <name> closes a track (the runs and the race

     on it end), /raceadmin enable <name> opens it again. Players

     with raceline.disabled.bypass may still race a closed track.

   - /raceadmin info <name> lists the problems of a track. Every

     track is also checked at startup and on /raceadmin reload: a

     missing start or checkpoint, a world not loaded, two