Configuration

Files

/aevent reload re-reads all of these except the jar. When a newer jar adds a key to a file, the key is added to your copy on start, with its comment; nothing you changed is touched.

Settings and timing

Under settings in config.yml. Any event can override any of these under its own settings.

Points

points:
  1: 3
  2: 2
  3: 1

Points awarded for each placement in a round. Players who tie share the placement, and every player in a tie gets that placement's points. Placements not listed score nothing. The final ranking adds the points up and uses the event score (kills, catches, ...) to break ties.

Rewards

rewards:
  enabled: true
  final:
    1: ["money give {player} 500"]
    2: ["money give {player} 250"]
    3: []
  participation: ["money give {player} 25"]
  round-win: []

Console commands, run when an event ends. final is by final placement, participation is for everyone who finished the event and round-win is for each round's winner or winners. Placeholders: {player}, {uuid}, {event} (the id), {place} and {points}. A leading / is optional. An event file can replace any of these lists for that event only; rewards.enabled: false there switches rewards off for it.

Protection

spectator.teleport-to-alive-on-elimination (default true) sends an eliminated player to watch a random player who is still alive. Both the lobby prevent-building and prevent-breaking keys and this one are read now; they were ignored before 3.0.

Sounds

One block per moment: event-start, player-join, player-leave, countdown-tick, countdown-3, countdown-go, elimination, round-win, event-end, block-break, each with sound (a Bukkit sound name), volume and pitch. An invalid name is skipped.

Update notice

update-checker:
  enabled: true
  repo: "alpha-m19/alphaevent-plugin"
  notify-ops-on-join: true

Every six hours the plugin asks GitHub for the latest release of repo and logs a line if it is newer than the running version. Operators also get a message when they join. A newer release is a higher version number; running a newer build than the release never warns. If the repo is private or unreachable, nothing happens.

Panel

panel:
  api-url: "https://alphastudio-licensing.onrender.com"
  check-interval-minutes: 10

See Server approval.

Event files

Every events/<id>.yml starts with the same keys, then has the rules of its own event (documented per event on the Events pages).

enabled: true        # false = /aevent start refuses this event
round-time: 90       # seconds, 0 = no limit

settings:            # optional: replaces config.yml for this event only
  rounds: 5
  max-players: 8

points:              # optional
  1: 1

rewards:             # optional
  final:
    1: ["give {player} diamond 3"]

When round-time runs out the round ends and the survivors (or the leaders, for score events) take the placements.

Text files

Everything players read is in lang/. The default look is the AlphaStudio pink theme: accent #E619E6, white body text, #555555 separators, green only for success, red for danger, and &8 menu titles. Static text is in small-caps letters.

Colours are &#RRGGBB (or the old &f, &8 codes). MiniMessage tags work too, for example a clickable <click:run_command:/event join>. Each event has its own block under events: in messages.yml with its name, goal, the line shown under GO and any lines only it uses.

Menus

lang/gui.yml holds two menus, both 27 slots with no filler panes and titles in &8.

The join menu opens for everyone online when joining starts, and for anyone who joins the server during the announcement.

Boss bars

lang/bossbars.yml defines five bars, each with text, color and style:

Tokens: {event}, {countdown}, {round}, {total_rounds}, {alive} and {time} (empty for rounds without a time limit). color accepts PINK, PURPLE, BLUE, GREEN, YELLOW, RED or WHITE (RED if unrecognised). style accepts SOLID or NOTCHED_6, 10, 12 or 20.

Upgrading from 2.x

The first start of 3.x does this, once:

1. Copies messages.yml, gui.yml, bossbars.yml, config.yml and arena.yml to backup/2.x/.
2. Writes the new config.yml, keeping your values for settings, points, protection, spectator, sounds and panel.
3. Moves the Spleef tool, floor blocks and elimination Y into events/spleef.yml. A tool name or lore you never edited is not carried over, so the new pink look applies.
4. Converts arena.yml into arenas/spleef/main.yml.
5. Creates the new lang/ files from the defaults.