Run boosts
Multiply drops, experience or money in some mines or all of them, by command or on a weekly schedule.
A boost multiplies what mining pays for a while: the items a block gives, the experience, the money. It
may cover every mine or a list of them, it is started by an admin or by the schedule in boosts.yml, and
it survives a restart with the time it had left.
Before you start#
You need exyliamines.admin (or the console) and at least one mine. The two example boosts, gold_rush and happy_hour, are already in boosts.yml.
Steps#
Define the boost
Open plugins/ExyliaMines/boosts.yml and edit or add an entry under boosts: its multipliers, its duration and the mines it covers (empty means every mine). Run /minesadmin reload.
Start it
Run /minesadmin boost start gold_rush. Players are told in chat and a boss bar shows inside the boosted mines.
Or schedule it
Add an entry under schedule with the boost, the days, the times and a min-players threshold, then /minesadmin reload. It then starts by itself.
Check that it works#
Run /minesadmin boost list. The running boost appears with its time left, and clicking it stops it after a confirmation. Break a block in a boosted mine to see the multiplied drops.
boosts.yml#
boosts:
gold_rush:
name: '{highlight}&lGOLD RUSH'
drops: 2.0
experience: 1.5
money: 2.0
duration: 900
mines: []
happy_hour:
name: '{accent}&lHAPPY HOUR'
drops: 1.2
experience: 1.2
money: 1.2
duration: 3600
mines: []
schedule:
weekend_rush:
boost: gold_rush
days:
- SATURDAY
- SUNDAY
times:
- '20:00'
min-players: 5| Key | What it does |
|---|---|
name | What players read in chat, in menus and on the boss bar. |
drops | Multiplier of the items a block gives: its vanilla drop, the items of its loot table and item lucky rewards. |
experience | Multiplier of the vanilla experience a block gives. |
money | Multiplier of the money loot tables and lucky rewards pay. |
duration | How long it lasts: 900, 15m, 1h. |
mines | The mine ids it applies to. Empty means every mine. |
A multiplier may be any number: 2 doubles, 1.2 adds a fifth, 1 leaves it alone. A fraction is
rolled per drop, so one item at ×1.2 is two items a fifth of the time. Boosts running at the same time
multiply together: Gold Rush and Happy Hour at once give drops ×2.4.
Starting one by hand#
| Command | What it does |
|---|---|
/minesadmin boost start <id> | Starts a boost from boosts.yml. One already running starts over with its full duration. |
/minesadmin boost custom <multiplier> <duration> [mines] | Starts a boost with its numbers typed out: one multiplier for drops, experience and money alike. Mine ids are separated by commas; none means every mine. |
/minesadmin boost give <player> <id> | Gives one online player a boost from boosts.yml. |
/minesadmin boost give-custom <player> <multiplier> <duration> [mines] | boost custom for one online player. |
/minesadmin boost stop <id> [player] | Ends a running boost now. With a player, ends the one given to them. all ends every one, personal ones included. |
/minesadmin boost list | Opens the running boosts menu, the soonest to end first; clicking one stops it after a confirmation. From the console, lists them in chat. The same menu is the Running boosts button of /minesadmin. |
/minesadmin boost custom 1.5 30m gold,iron boosts the gold and iron mines by half for thirty minutes.
Its name comes from boosts.custom-name in messages.yml, "BOOST x1.5", and its id is written out from
its numbers, custom-1.5-gold+iron, which is what boost stop takes. A multiplier of zero or less, or a
duration under a second, is refused.
All of them need exyliamines.admin and also work from the console.
Personal boosts#
A boost given with give or give-custom multiplies only what that player breaks, in the mines it names.
It runs beside the boost of the same id on everyone, and beside the same boost given to someone else:
giving it again to the same player starts theirs over. Its start and end lines go to that player alone,
never announced, and the boss bar shows for them only. Whoever gave it is told boosts.given. In boost list,
%player% names the player, or boosts.everyone for a boost on everyone.
The schedule#
Each entry under schedule starts its boost at every time of times, on the days listed:
| Key | What it does |
|---|---|
boost | The id of a boost in boosts.yml. |
days | MONDAY to SUNDAY. Empty means every day. |
times | HH:mm, 24-hour. Several are allowed. |
min-players | That start is skipped while fewer players are online. 0 never skips. |
Times follow the timezone set in ExyliaLib's settings, not the machine's. A time or a day that cannot be
read is named in the console and left out, and an entry left with no time at all does nothing. The entry's
name — weekend_rush — is yours to choose; only the boost it points at matters. /minesadmin reload
applies an edited schedule at once.
What players see#
- When it starts and ends, the
boosts.startedandboosts.endedlines go to whomannouncements.boostsinconfig.ymlsays:SERVERby default,NEARBYfor players withinannouncements.radiusblocks of any boosted mine, orOFF. - Inside a boosted mine, a boss bar,
boosts.bossbar, names the boost and the multipliers and empties as it runs out. With several boosts on one mine it names the one that ends last and shows the multipliers of all of them combined. - In menus, the
/minesmenu and the mine's Rewards section show the drop multiplier and the time left. - In placeholders,
%mine_boost_<id>%,%mine_boost_name_<id>%and%mine_boost_time_<id>%. See Placeholders.
Every boost line may use %boost%, %id%, %player%, %drops%, %experience%, %money%, %time% (left),
%duration% and, in the start announcement, %mines% — the mines' names, or boosts.all-mines, "every
mine". The boss bar also takes %mine_name%.
Restarts and networks#
A running boost is stored in the database (mines_boosts) with when it started and when it ends. After a
restart it carries on with the time it had left; one that ran out while the server was off is cleared
without an announcement.
A boost belongs to the server it was started on, as the mines it boosts do. On a network sharing one database, starting Gold Rush on one server leaves the others alone.
And boosters from other plugins?#
They stack. A mine's boosts reach every break through ExyliaLib's modifiers under the mines source, and
are multiplied there with the boosters other plugins register — ExyliaSurvivalCore's among them — and with
permission modifiers. Money in a currency other than the default one takes only the mine's own boosts. See
Integrations.
Something missing on this page? Tell us on Discord