Configuration

The configuration file for Nexal Boat Racing. Located at plugins/Nexal Boat Racing/config.yml.

config.yml

# Nexal Boat Racing Configuration
# Most of these settings can also be changed in game: /br admin > Configuration

# Storage type: "json" or "sql"
# To move your data: /br admin export, change the type, restart, /br admin import
storage:
  type: json

  # SQL settings (used when type is "sql")
  sql:
    host: localhost
    port: 3306
    database: minecraft
    username: root
    password: ""

# Settings a new arena starts with. Each arena changes its own in /br admin info <arena>.
defaults:
  min-players: 4
  max-players: 8             # At most 8: an arena has up to 8 start positions
  laps: 3
  lobby-countdown: 30        # Seconds to wait before teleporting to start
  warmup-countdown: 10       # Seconds boats are frozen before race starts
  finish-timeout: 30         # Seconds to wait for remaining racers after first finishes

# Boat settings
boat:
  type: OAK                  # OAK, SPRUCE, BIRCH, JUNGLE, ACACIA, DARK_OAK, MANGROVE, CHERRY, BAMBOO, PALE_OAK (1.21.4+)
  invincible: true           # Boats can't break during race
  step-height: 1.5           # How high boats can climb (1.0 = one block, 1.5 for smoother climbing)

# Spectator settings
spectator:
  enabled: true              # Finished racers watch the rest of the race instead of waiting in their boat
  allow-join: true           # Anyone can watch a running race with /br spectate <arena>
  gamemode: SPECTATOR        # SPECTATOR, or ADVENTURE (flying and invisible)

# Fireworks on finish
fireworks:
  enabled: true
  amount: 5                  # Fireworks per podium finisher
  # Colour names (YELLOW, ORANGE, WHITE, SILVER, RED, LIME, AQUA...) or hex (#CD7F32)
  colors:
    first:
      - YELLOW
      - ORANGE
    second:
      - WHITE
      - SILVER
    third:
      - "#CD7F32"
      - ORANGE
    other:
      - WHITE

# Broadcast settings
broadcast:
  race-start: true           # Broadcast when race lobby opens
  race-end: true             # Broadcast race results
  scope: GLOBAL              # Race results: GLOBAL (everyone) or LOCAL (only racers and spectators)

# Scoreboard (the lines are in messages.yml, under scoreboard)
scoreboard:
  enabled: true
  title: "<#5DADE2><bold>BOAT RACING"
  update-interval: 10        # Ticks between updates (20 ticks = 1 second)

# Anti-cheat
anti-cheat:
  require-checkpoints: true  # A lap only counts after every checkpoint, in order
  respawn-on-skip: true      # Crossing a later checkpoint than the next one sends the racer back to the last one passed

# Command blocking during races
# Players in active races can only use /br leave (and admin commands for admins)
# Add additional allowed commands to this whitelist: whole command names, without the /
command-whitelist: []
# Example:
# command-whitelist:
#   - "msg"
#   - "r"
#   - "tell"

# Checkpoint holograms
checkpoint-holograms:
  enabled: true
  height-above-ground: 4.0
  lines:
    - "<gradient:#5DADE2:#73B9E8><bold>Checkpoint #%number%</bold></gradient>"
    - "<gray>%number% / %total%</gray>"

Configuration Options

Below is a reference of the main configuration sections:

storage

Nexal Boat Racing Configuration Most of these settings can also be changed in game: /br admin > Configuration

Storage type: "json" or "sql" To move your data: /br admin export, change the type, restart, /br admin import

defaults

Settings a new arena starts with. Each arena changes its own in /br admin info <arena>.

boat

Boat settings

spectator

Spectator settings

fireworks

Fireworks on finish

broadcast

Broadcast settings

scoreboard

Scoreboard (the lines are in messages.yml, under scoreboard)

anti-cheat

Anti-cheat

command-whitelist

Command blocking during races Players in active races can only use /br leave (and admin commands for admins) Add additional allowed commands to this whitelist: whole command names, without the /

checkpoint-holograms

Example: command-whitelist:

• "msg"
• "r"
• "tell"

Checkpoint holograms