OlaQueue

Configuration

The config.yml file is automatically generated in plugins/OlaQueue/config.yml. It comes pre-loaded with extensive comments to help you understand every feature.

# ============================================================================ #
#                                  OlaQueue                                    #
#                 The Ultimate Redis-Backed Proxy Queue Engine                 #
# ============================================================================ #

# ---------------------------------------------------------------------------- #
# Redis Connection Settings
# ---------------------------------------------------------------------------- #
# OlaQueue uses Redis to perfectly sync the queue across ALL your proxies.
# If you only have one proxy, you still need Redis installed locally!
redis:
  host: "127.0.0.1"
  port: 6379
  password: ""
  use-ssl: false

# ---------------------------------------------------------------------------- #
# Queue Targets
# ---------------------------------------------------------------------------- #
# Define the backend servers you want to have queues for.
# The name MUST match the server name exactly as defined in your velocity.toml
queues:
  survival:
    max-players: 100
  skyblock:
    max-players: 150

# ---------------------------------------------------------------------------- #
# Fairness & Mechanics
# ---------------------------------------------------------------------------- #
fairness:
  # The "Time Multiplier". 
  # To prevent regular players from being permanently stuck behind VIPs who
  # keep joining, players earn this many priority points for every second 
  # they wait in the queue.
  points-per-second: 10
  
  # If a player's Minecraft crashes while they are in the queue, their exact 
  # queue position and score will be saved for this many seconds. If they 
  # reconnect in time, they get their exact spot back!
  grace-period-seconds: 300

# ---------------------------------------------------------------------------- #
# LimboAPI Settings
# ---------------------------------------------------------------------------- #
# When a player joins the proxy for the very first time and the server is full,
# they are dropped into a virtual "Limbo" void inside the proxy's memory.
limbo:
  # If you want them to spawn in a custom-built room instead of an empty void,
  # place a .schematic file inside the plugins/OlaQueue/limbo/ folder and
  # type the file name here (e.g., "waiting_room.schematic").
  # Leave blank ("") to use the default empty void.
  schematic-file: ""

# ---------------------------------------------------------------------------- #
# Messages
# ---------------------------------------------------------------------------- #
# All messages support MiniMessage formatting (e.g., <red>, <bold>, <gradient>)
messages:
  # The actionbar message shown to players while they are in the queue.
  # Available placeholders: %position%, %score%, %ewt% (Estimated Wait Time)
  queue-position: "<yellow>Position: <green>#%position%</green> | Est. Wait: <gold>%ewt%</gold> | Score: %score%"
  
  # The message sent to them in chat when it is their turn to join.
  # Available placeholders: %server%
  joining: "<green>You are being sent to %server%!"
  
  # The message shown in the actionbar if an Admin pauses the queue.
  paused: "<red>The queue is currently paused by an administrator."

# ---------------------------------------------------------------------------- #
# Permission Tiers
# ---------------------------------------------------------------------------- #
# This dictates a player's starting "Base Score" when they enter the queue.
# Higher scores are placed at the front of the queue!
#
# IMPORTANT: Tiers are automatically sorted by base-score. You can add as 
# many custom tiers as you want here.
tiers:
  default:
    base-score: 0
    permission: "olaqueue.tier.default"
  vip:
    base-score: 1000
    permission: "olaqueue.tier.vip"
  mvp:
    base-score: 2500
    permission: "olaqueue.tier.mvp"