Content generated with AI — it may contain mistakes.

ExyliaTotemTrainer/ReferenceUpdated in v1.2.0

Configuration

config.yml key by key, the language folders, messages.yml, the menu files and where the database is set.

Page 15 of 2313 min read

Everything is generated in plugins/ExyliaTotemTrainer/ on first boot, with comments. Edit the files there, never the copies in the jar. Times are seconds with decimals unless a key says ticks; twenty ticks are one second. Colours use palette tokens such as {primary} or {success}; see Colours.

After editing a file, run /totemtraineradmin reload (permission exyliatotemtrainer.admin): it re-reads the configuration, the language folders and the menus without a restart. Arenas, profiles and records are in the database, not in these files, so a reload never touches them.

What most owners change#

  • Training speeds and countdown: training.ticks, training.default-ticks, training.countdown. default-ticks and countdown are also buttons in /totemtraineradmin → Settings → Training.
  • Duel length and timing: match.formats, match.round-delay, match.duel-request-expiry. In game (Settings → Matches): base format, even formats, the delays, request expiry and cooldown, matches per arena. Guide: Set up duels.
  • How strict grading is: performance.defaults, fail-penalty, speed-weights. In game (Settings → Scoring): the four thresholds, the fail penalty, full-credit pops and the reference speed. Guide: Tune the grading.
  • Leaderboard and history size, chat isolation: leaderboard.entries, history.entries, history.retention-days, chat.isolation. In game: Settings → Records and chat.
  • Your own modes: training.modes, config-only. Guide: Choose and tune the modes.
  • Language, messages, sidebar and menus: language plus the lang/<language>/ folder. See Messages and languages and Edit menus.
  • Database: database.yml, written by ExyliaLib. See Database.

config.yml#

The whole file as generated
plugins/ExyliaTotemTrainer/config.yml
yaml
language: default
 
training:
  modes:
    normal:
      display-name: Normal
      totems: 0
      refill: false
      close-inventory: false
      icon: CHEST
      description: One full inventory of totems. When it runs out, you are done.
    infinite:
      display-name: Infinite
      totems: 0
      refill: true
      close-inventory: false
      icon: TOTEM_OF_UNDYING
      description: A full inventory, refilled forever. It ends when you miss one.
    random:
      display-name: Random
      totems: 1
      refill: false
      close-inventory: false
      icon: ENDER_EYE
      description: A single totem, in a different random slot after every pop.
    chaos:
      display-name: Chaos
      totems: 1
      refill: false
      close-inventory: false
      random-interval:
        min-ticks: 10
        max-ticks: 30
      icon: ENDER_PEARL
      description: Random slot and random timing. Nothing is where you left it.
    acceleration:
      display-name: Acceleration
      totems: 3
      refill: false
      close-inventory: false
      speed-up:
        every: 10
        by: 5
        min-ticks: 5
      icon: SUGAR
      description: Three totems on screen, faster every 10 pops. Find your ceiling.
    blackout:
      display-name: Blackout
      totems: 0
      refill: true
      close-inventory: true
      icon: ENDER_CHEST
      description: A full inventory that slams shut on every pop. Open it again, fast.
  ticks: [25, 20, 15, 10, 5]
  default-ticks: 20
  countdown: 3.0
 
performance:
  defaults:
    perfect: 0.25
    excellent: 0.40
    good: 0.60
    ok: 0.90
  by-ticks: {}
  by-mode: {}
  points:
    perfect: 100
    excellent: 85
    good: 70
    ok: 50
    slow: 25
  fail-penalty: 15
  full-credit-pops: 20
  speed-weights:
    "25": 0.8
    "20": 1.0
    "15": 1.5
    "10": 2.5
    "5": 5.0
  reference-ticks: 20
 
match:
  formats: [1, 3, 5, 7]
  default-format: 3
  allow-even-formats: false
  round-delay: 3.0
  result-delay: 5.0
  duel-request-expiry: 30.0
  duel-request-cooldown: 15.0
  allowed-commands: [totem, tt, totemtrainer, msg, r, tell, w]
 
leaderboard:
  entries: 10
  cache-seconds: 300
 
history:
  entries: 20
  retention-days: 30
  prune-interval-minutes: 60
 
arena:
  max-matches-per-arena: 0
  return-location: ""
  arenas-scope: default
 
chat:
  isolation: true
 
debug: false

language#

Which folder under plugins/ExyliaTotemTrainer/lang/ the menus, messages.yml and scoreboards.yml are read from. default follows the language set in ExyliaLib's own config.yml, so one line there switches every Exylia plugin; en, es, pt, fr, ru or tr set this plugin alone. Each language is a complete folder you can edit:

plugins/ExyliaTotemTrainer/
  config.yml
  lang/es/messages.yml
  lang/es/scoreboards.yml
  lang/es/menus/*.yml

English is the base the others are laid over, so a line not translated yet still arrives in English.

Servers that ran 1.0.0 keep their edits

On the first start of 1.1.0 the old messages.yml, scoreboards.yml and menus/ move to lang/custom/, and config.yml is pointed at it with language: custom, so nothing a server edited is lost. The feedback section moves from config.yml into that messages.yml whole, sounds included. Set language to default or a code to switch to the shipped translations.

training#

KeyDefaultWhat it does
modessix modesOne block per mode; a new key is a new mode, no code involved. The key is the mode id used by commands, records, boards and placeholders. Menus list modes in file order. See Modes.
modes.<id>.display-nameWhat players see. Palette tokens allowed.
modes.<id>.totemsTotems kept in random slots at once; the popped one comes back in another slot. 0 hands out a full inventory instead.
modes.<id>.refillFull-inventory modes only: hand out another inventory once the last totem is gone. false ends the session there.
modes.<id>.close-inventorySlams the inventory shut after every pop, so it has to be opened again before the next totem can be swapped in.
modes.<id>.random-intervalabsentmin-ticks and max-ticks. Every interval is drawn from the window, shifted so the picked speed sits at its centre. max-ticks: 0 turns it off, and the block is left out of the file.
modes.<id>.speed-upabsentevery hits between two speed-ups, by ticks taken off each time, min-ticks the floor. by: 0 or every: 0 turns it off, and the block is left out.
modes.<id>.iconMaterial or head used in menus.
modes.<id>.descriptionOne line shown under the mode in menus.
ticks[25, 20, 15, 10, 5]The intervals between hits a player may pick. Any other value is refused.
default-ticks20The interval used when a command leaves it out and the first time a player opens a picker.
countdown3.0Seconds before the first hit, in training and in every duel round. 0 starts at once.

performance#

KeyDefaultWhat it does
defaults0.25 / 0.40 / 0.60 / 0.90The slowest reaction, in seconds, that still earns perfect, excellent, good and ok. Slower than ok is slow.
by-ticksemptyOverrides by tick interval, keyed by the interval as text. Checked first. Empty on purpose: grading is one standard at every speed, and how hard a speed is belongs to speed-weights.
by-modeemptyOverrides by mode id. Checked after by-ticks.
points100 / 85 / 70 / 50 / 25Points each grade is worth in the 0–100 score.
fail-penalty15Points removed from the score per fail.
full-credit-pops20Pops a session needs before its score counts in full; below that the mean is scaled by how far short it fell. 0 scores the mean alone.
speed-weights25: 0.8, 20: 1.0, 15: 1.5, 10: 2.5, 5: 5.0What a speed is worth on the leaderboard. A session's rating is its 0–100 score times the weight of the interval it was played at, keyed by the interval as text.
reference-ticks20The weight of an interval missing from speed-weights: this interval weighs 1.0 and any other reference-ticks / ticks.

See Grading for the formula.

match#

KeyDefaultWhat it does
formats[1, 3, 5, 7]Best-of lengths offered in the duel screen and accepted by /totem duel.
default-format3The length used when a command leaves it out and the first time a player opens the picker.
allow-even-formatsfalseWhether even lengths in formats are offered at all.
round-delay3.0Seconds between a round ending and the next countdown.
result-delay5.0Seconds the result stays on screen before both players are sent back.
duel-request-expiry30.0Seconds a request stays open. Never less than one.
duel-request-cooldown15.0Seconds a player waits between two requests they sent. Only a request that reached its target starts the wait. 0 removes it.
allowed-commands[totem, tt, totemtrainer, msg, r, tell, w]Command labels a player may still run while training or in a duel. A plugin:command prefix is stripped before the check.

leaderboard#

KeyDefaultWhat it does
entries10Rows shown per board.
cache-seconds300Seconds a board is kept before the database is asked again. Never less than five.

history#

KeyDefaultWhat it does
entries20Duels shown to a player in /totem history.
retention-days30Duels older than this are deleted. 0 keeps everything.
prune-interval-minutes60How often the prune runs. The first sweep is a minute after start.

arena#

KeyDefaultWhat it does
max-matches-per-arena0Simultaneous duels and solo sessions one arena hosts. 0 is unlimited.
return-locationemptyWhere a player is sent after leaving, as world,x,y,z or world,x,y,z,yaw,pitch. Empty sends them back to where they came from.
arenas-scopedefaultWhich servers share the arenas stored in the database. default follows the network group set in ExyliaLib's config.yml (identical servers share; no group means one shared table), server gives each server its own, global shares with every server, any other value is a group name. Read at startup.

chat#

KeyDefaultWhat it does
isolationtrueKeeps a session's or a duel's chat inside it: whoever is in one reads that one and nothing else, and the rest of the server reads none of it. false leaves chat exactly as the server's chat plugin delivers it. Read on every message, so a reload switches it at once.

debug#

false by default. true prints debug lines to the console.

messages.yml#

lang/<language>/messages.yml. Every line the plugin says. %prefix% expands to the prefix value at the top of the file, {primary}&lTOTEM {letters_black}•<reset> by default. Colours are palette tokens, so recolouring the network never means editing this file; MiniMessage tags work too, and the duel request uses <click> and <hover> for its ACCEPT and DECLINE buttons, and [center] to centre each of its lines.

A line may open with an effect tag, which never reaches the screen: [sound:NAME|volume|pitch] plays a sound to whoever receives the line. The defaults use three consistently: ENTITY_VILLAGER_NO for a refusal, ENTITY_EXPERIENCE_ORB_PICKUP for something that worked and BLOCK_NOTE_BLOCK_PLING for something that wants attention.

SectionHolds
no-permission, player-only, player-not-foundThe three command refusals.
reloadstarted, done (%steps%, %ms%), failed.
commonbusy, busy-elsewhere (%plugin%), busy-advice (%reason%), not-in-anything, left, command-blocked, no-arena, and the words yes and no.
trainingstarted, stopped, completed, failed (%pops%), unknown-mode, unknown-ticks. The summary is a screen, menus/training_result.yml.
matchstarting, round-start (%round%, %rounds%), round-won, round-lost, round-draw, ready, opponent-ready, no-arena, unknown-format, cancelled, opponent-left, forfeited; the round-summary list (%round%, %winner%, %pops%, %average%, %best%, %score%, %score_for%, %score_against%) and the match-summary list (%winner%, %loser%, %score_winner%, %score_loser%, %format%, %mode%, %ticks%, %pops%, %best%, %average%, %duration%).
duelrequest-sent, request-cooldown (%time%, %seconds%), the request-received list (%player%, %mode%, %ticks%, %format%, %time%, %seconds%), accepted, expired, expired-sent, no-pending, target-busy, target-not-ready (%target%, %reason%), self-duel, denied, denied-by.
adminWhat the admin screens confirm: arena created, removed, exists, not found, renamed, spawn set, enabled, disabled, duel cancelled, statistics reset, cancelled; the titles and descriptions of the three confirmation screens (%arena%, %player%); and what the arena prompts and the spawn wizard ask (%spawn%).
menuWords menus need that are not a whole line: the victory and defeat titles, none (—), loading, the empty texts of each list, the three state labels, reason-self, reason-busy, set, not-set, categories, ticks-label, all-speeds (the leaderboard speed button before it is narrowed), the mode rule lines, and grades, how each grade is named.
feedbackThe effects of every pop, fail, countdown and duel moment. See feedback below.

menu.categories names and iconises the five leaderboard categories:

plugins/ExyliaTotemTrainer/messages.yml
yaml
menu:
  categories:
    rating:
      name: Rating
      icon: NETHER_STAR
    best_pops:
      name: Most pops
      icon: TOTEM_OF_UNDYING
    fastest_average:
      name: Fastest average
      icon: CLOCK
    best_streak:
      name: Best streak
      icon: BLAZE_POWDER
    longest_run:
      name: Longest run
      icon: FEATHER

feedback#

What a player sees and hears, in messages.yml since 1.1.0 so it is translated with the rest. Every entry is an ExyliaLib effect: title, action-bar, boss-bar, sound, particle and firework, each optional. A sub-section that does nothing is left out of the file, and removing a section keeps that channel quiet.

KeyFires whenPlaceholders
perfect, excellent, good, ok, slowA pop earned that grade. Each has an effect and a chat line, empty for none.%grade% (PERFECT…), %reaction% in seconds, %pops%, %streak%
failNo totem in hand when a hit landed.—
countdownCounting down before the first hit; the title and action bar are refreshed with the time left.%time% (the seconds), %time_precise% (the same with its unit)
match-foundBoth duellists arrived in the arena.—
round-won, round-lostA round was decided.—
round-drawBoth sides dropped their totem in the same tick; the round is replayed.—
match-won, match-lostThe duel was decided.—
training-completeA full-inventory mode without refill used its last totem.—

The effect keys are ExyliaLib's: title { text, subtitle, fade-in, stay, fade-out, time-style }, action-bar { text, duration, time-style }, sound { name, volume, pitch, category }. See the library's effects page for boss-bar, particle and firework.

scoreboards.yml#

lang/<language>/scoreboards.yml. Two sidebars, training and match, driven entirely by placeholders. See Scoreboard.

Every screen is a YAML file under lang/<language>/menus/:

FileScreen
main.ymlThe hub /totem opens. Under the SCREEN menu style it is the native screen in screens/main.html (solo, duels, boards and profile in one app), with its words in lang/<language>/screens/main.yml.
training.ymlMode rows over the tick picker.
opponents.ymlWho is online and free to duel.
duel.ymlMode, speed and format for one request.
profile.yml, records.yml, history.ymlA player's numbers, their bests per mode and speed, their recent duels.
leaderboard_modes.yml, leaderboard.ymlThe mode picker and one mode's board.
result.ymlThe screen shown after a duel, with the rematch button (screens/result.html under the SCREEN style).
training_result.ymlThe screen shown after a solo session, with Play again and Back ▸ Solo training.
admin/main.yml, admin/arenas.yml, admin/arena.yml, admin/duels.yml, admin/players.yml, admin/settings.yml, admin/settings_training.yml, admin/settings_matches.yml, admin/settings_scoring.yml, admin/settings_records.ymlThe staff screens, the settings hub and its pages. Deleting an arena, cancelling a duel and resetting a player ask first through a confirmation dialog.

The player files follow the release without overwriting you: a missing file is written, a new key is added, and a changed default waits in /exylialib updates instead of replacing your edit. The admin/ folder is rewritten from the jar on every start, so a button added in a release reaches you; nothing you are meant to edit lives there.

A broken menu file does not take the plugin down

A file that fails to parse is reported in the console with its path and the reason, and that one screen does not open until it is fixed. Everything else keeps working.

The format is ExyliaLib's declarative menu YAML; see the library's menus page. Click actions live under the totemtrainer namespace, for example totemtrainer:open training.

database.yml#

Written by ExyliaLib the first time the plugin starts: H2 by default, with MySQL, MariaDB, PostgreSQL and MongoDB as alternatives. Arenas, profiles, training records and duel history all live there. See the library's database page.

Something missing on this page? Tell us on Discord