Skip to main content

Configuration

RallyPoint has a single configuration file, plugins/RallyPoint/config.yml, created with sensible defaults on first run. Apply changes with /rally reload; a restart is not needed.

Settings​

KeyDefaultMeaning
default-opt-infalseWhether players count as opted in until they say otherwise. Leave this false unless your whole server has agreed to be teleported.
save-interval-seconds30Backstop flush interval for opt-in state. State is also written immediately on every opt-in or opt-out, so this only covers unusual shutdowns.
allow-cross-worldtrueAllow rallying to a destination in another world. When false, players in other worlds are skipped and told why, and a host in a different world to the destination is refused outright.
cooldown-seconds5Minimum gap between rallies. Guards against a double-fired command.
countdown-seconds5Countdown before a rally teleports anyone. 0 fires immediately.
scatter-radius4Radius in blocks that arrivals are spread over. 0 puts everyone on the destination block.
safety-checkstrueRefuse unsafe destinations and keep scattered landing spots on solid ground.
teleports-per-tick10How many players are moved per server tick. Lower is gentler on the server for very large crowds.
history-size20How many past rallies /rally history keeps.
stage.modespectatorspectator puts the held crowd into spectator mode; freeze leaves their game mode alone but blocks movement. An unrecognised value logs a warning and falls back to spectator.
arrival.titletrueShow a title on arrival.
arrival.sound-enabledtruePlay a sound on arrival.
arrival.soundENTITY_PLAYER_LEVELUPWhich sound. Any Bukkit Sound name.
countdown-sound-enabledtruePlay a tick sound during the countdown.
countdown-soundBLOCK_NOTE_BLOCK_HATWhich sound.
messages.*see belowEvery user-facing string.

Tuning notes​

Countdown length. Five seconds fits a spoken sentence, which is the point of it: the crowd is not yanked mid-conversation and the host can talk over it. Three is snappier for a fast-moving show. Zero is for scripted moments only.

Scatter radius. Four to eight works well for a crowd. Too small and everyone stacks on one block; too large and the back of the group cannot see what you brought them to look at. With safety-checks on, scattered spots are validated and fall back to the destination itself if nothing nearby is usable, so a large radius never drops someone into a wall.

Teleports per tick. The default of 10 is comfortable for most servers. If the server hitches noticeably when a rally fires, halve it: arrivals take slightly longer but the tick spike flattens out.

Cross-world. Leave allow-cross-world: true for a tour that crosses into the Nether or End. Set it false if you want rallies confined to whatever world the host is in.

Messages​

Every player-facing string lives under messages: and can be rewritten. Colour codes use &, and the strings are rendered through Paper's Adventure API, so titles and chat both support them.

messages:
opt-in: "&aYou have opted-in to mass teleports."
teleported: "&6You have been teleported to {target}!"
rally-unsafe: "&cThat destination failed the safety check ({target}). Add &fforce&c to rally anyway."

Placeholders​

PlaceholderMeaning
{target}The rally destination name: a waypoint name, a player name, or the host's location.
{count}Number of players affected.
{player}A player name.
{name}A waypoint name.
{world}A world name.
{seconds}Seconds remaining, on countdown and cooldown messages.
{time}Timestamp, on history entries.
{x} {y} {z}Coordinates, on waypoint listings.

Only the placeholders a given message is given at send time are substituted. Removing a placeholder from a message is fine; inventing one that the message is not passed leaves the literal text in place.

Message groups​

The messages block is organised by area, and the defaults are worth reading as documentation in their own right:

  • Status and errors - opt-in, opt-out, status-in, status-out, no-permission, player-not-found, unknown-command, player-only.
  • Rally control - rally-cooldown, rally-already-running, rally-failed, rally-nobody, rally-unsafe, cross-world-denied, cross-world-skipped.
  • Countdown - countdown, countdown-title, countdown-subtitle.
  • Arrival - teleported, teleport-success, arrival-title, arrival-subtitle.
  • Return - returned, returned-late, return-success.
  • Cancelling - cancelled, cancelled-player, cancel-nothing, cancel-too-late.
  • Catch-up - missed-rally, catchup-none, catchup-not-opted-in.
  • Roster and history - roster-header, roster-entry, roster-empty, history-header, history-entry, history-empty.
  • Waypoints - waypoint-set, waypoint-removed, waypoint-not-found, waypoint-list-header, waypoint-list-entry, waypoint-list-empty.
  • Stage mode - stage-on, stage-off, stage-already-on, stage-already-off, stage-status-on, stage-status-off, stage-on-player, stage-off-player.
  • Misc - config-reloaded, help-header, help-line, and the usage-* strings.