Guide

uxmLevels gives players experience and levels on as many tracks as a server wants: a global one, a mining one, a combat one, or any other. Events decide what pays into which track, every track has its own ladder and rewards, and a finished track can be prestiged for a permanent bonus.

Install

1. Put the jar in plugins/.
2. Start the server once. The plugin writes its files into plugins/uxmLevels/, with three example tracks (global, mining, combat) and their events. The examples are written only while tracks/ or events/ does not exist: once the folder is there it is yours, and a file you delete stays deleted.
3. Edit the files under tracks/ and events/, then run /uxmlevels reload.

PlaceholderAPI and the economy plugins are optional.

Files

Tracks

A track id is lower-case letters, digits and hyphens, without underscores. Renaming a file renames the track, and events that name the old id then pay nothing and say so in the console.

With base-cost = 100 and growth = 2.0, levels cost 100, 200, 400 and so on. A curve whose totals would overflow is refused with the level where it happens.

A reward has a level, icon, name, lore, actions and claim: manual waits for the player to click it in the rewards window, automatic runs at once. Actions are [console] <command>, [player] <command> or [message] <text>; {player}, <player> and %player% are the player's name.

rewards {
  veteran {
    level = 50
    icon = "DIAMOND"
    name = "@track.global.veteran.name"
    lore = ["@track.global.veteran.lore"]
    actions = ["[console] give {player} diamond 8"]
    claim = "automatic"
  }
}

Events

Each block under events in any file of events/ is one rule. An event id must be unique across every file, because its cooldown is kept under it.

Two events may fire for the same action, each with its own cooldown: a broad rule for every block and a bonus for ores, for example.

Experience rules

The final multiplier is global times permission times temporary (from /uxmlevels boost) times prestige, rounded down.

anti-abuse.mark-player-placed-blocks marks placed blocks in chunk data so breaking them pays nothing, keeping up to marks-per-chunk marks per chunk.

Prestige

A player at prestige.required-level (or the track's maximum, if lower) can prestige that track with /levels prestige <track> or the prestige window. Their experience on the track goes back to zero and their prestige count rises, up to maximum.

Prestiging needs uxmlevels.prestige, which only operators have by default.

Leaderboard and HUD

leaderboard keeps a snapshot of size places per track, rebuilt every refresh-seconds (an older refresh-ms is carried over on start); chat-lines is how many /levels top prints. periods, time-zone, week-starts and keep-windows work as in the other UXM plugins: all time ranks by level, a month, week or day by experience earned in it. hud.refresh-ms repaints the surfaces and gain-notice-ms is how long a gain holds the action bar.

Commands

The names and aliases come from commands.conf. The reference lists the default aliases and every permission.

Every player earns on every track by default. To stop a player or a group earning on one track, set uxmlevels.track.<id> to false in the permission plugin, for example uxmlevels.track.mining; set uxmlevels.track.* to false to stop every track and then grant the ones they keep. A track's own node wins over the wildcard. An admin give or set is not held to these permissions, and a change is read when the player joins again or on /uxmlevels reload.

Placeholders

Written %uxmlevels_<track>_<what>%:

The boards use the shared grammar: %uxmlevels_top_<track>_<period>_<n>_name|value|head%, %uxmlevels_rank_<track>_<period>%, %uxmlevels_value_<track>_<period>% and %uxmlevels_resets_<period>%. leaderboard.empty-head is the head for a place nobody holds.

Troubleshooting

• An event pays nothing. Its track names a track that does not exist; the console says so on reload.
• Mining a placed block pays nothing. That is the anti-abuse mark.
• Playtime stops paying. The player has been still for idle-timeout-ms.
• A prestige is refused for everyone. prestige.money-cost is set and economy.currency names an economy the server does not run.