Create kits and item spawners
Build kits with cooldowns and previews that players claim with /kit, and set up item spawners that drop a glowing item on a timer. Crates and loot chests live in ExyliaCrates and ExyliaWarzone.
You will have a kit players claim with /kit, with a cooldown and a preview, and optionally an item spawner
that drops a glowing item every few minutes. Everything is built from menus; there is no kit file.
Crates are now ExyliaCrates and loot chests are part of ExyliaWarzone. This page covers kits and item spawners.
Before you start#
The module kits must be on in config.yml (Switch modules on and off).
Kits are stored in the database, so every server on the network sees the same kits.
Create a kit#
Open the kit editor
Run /kitadmin (permission exyliasurvivalcore.kits.admin) and click Create ▸ Kit.
Name it and give it items
Click Kit ▸ Display name, then Kit ▸ Items to fill it with ExyliaLib's loadout editor. Kit ▸ Bonuses adds console commands that run with the items; named ones show in the preview.
Choose who can claim it and how often
Kit ▸ Permission limits who sees and claims it. Kit ▸ Cooldown is typed as a duration such as 1d
or 12h (default 24 hours). Kit ▸ Max uses is -1 for unlimited.
Turn it on
Click Kit ▸ Status so the kit is enabled. A disabled kit does not exist for players.
The other buttons of the editor: Icon, Description, Sort order (where it sits in the list), Equip armour (armour goes on instead of into the bag), Drop when full, First join kit, Preview, Clone and Delete.
Check that it works#
Run /kit. You should see your kit in one of four states: ready, on cooldown, used up or locked. Click it
to preview, then claim it. A second /kit <id> straight away is refused until the cooldown ends.
Going further#
Give a kit to new players#
Turn on Kit ▸ First join kit. It is handed over the first time a player joins, as long as the kit is enabled.
Choose what happens when the bag is full#
With Kit ▸ Drop when full on, a claim goes through and what does not fit is kept in ExyliaLib's pending reward queue and handed over the next time the player joins; nothing is dropped on the floor. With it off, a claim that would not fit is refused before anything is given.
Let staff skip the rules#
exyliasurvivalcore.kits.bypass skips cooldowns and use limits. Staff can also run
/kitadmin give <player> <kit> (gives it whether or not the player has waited), /kitadmin reset <player> <kit> (forgets that player's cooldown and use count) and /kitadmin preview <kit> (previews it without the
kit's permission). Another plugin can do the same through the API.
Previews open containers#
A shulker box or bundle inside a kit can be opened in the preview, so a player sees what is inside before
claiming. preview.container-hint in modules/kits/messages.yml is the lore added to those containers.
Kit counters#
Claims count kits.claimed and kits.<kit>.claimed in the
stat counters, so a mission can
ask for them.
| Command | What it does | Permission |
|---|---|---|
/kit [id] | Bare, opens the kit list; with an id, claims that kit | exyliasurvivalcore.kits |
/kit preview [id] | Shows what a kit contains | exyliasurvivalcore.kits.preview |
/kit claim [id] | Claims a kit | exyliasurvivalcore.kits |
/kitadmin | Opens the kit editor | exyliasurvivalcore.kits.admin |
/kitadmin give <player> <kit> | Gives a kit to a player | exyliasurvivalcore.kits.admin |
/kitadmin preview <kit> | Previews a kit | exyliasurvivalcore.kits.admin |
/kitadmin reset <player> <kit> | Forgets one player's cooldown and use count for one kit | exyliasurvivalcore.kits.admin |
| Permission | Who has it | What it allows |
|---|---|---|
exyliasurvivalcore.kits | Everyone | `/kit` and claiming kits |
exyliasurvivalcore.kits.preview | Everyone | `/kit preview` |
exyliasurvivalcore.kits.bypass | Admins (op) | A kit's cooldown and use limit |
Kit settings (modules/kits/config.yml, under settings:)
| Setting | Default | What it does |
|---|---|---|
default-cooldown-ms | 86400000 (24 hours) | Cooldown given to a new kit |
default-max-uses | -1 | Use limit given to a new kit |
show-locked-kits | true | Show kits the player has no permission for, as locked |
Each state of the list has its own template in modules/kits/menus/list.yml. Menu text is in
modules/kits/menus/ and modules/kits/messages.yml.
Item spawners#
A block that drops a glowing item at a random interval, under a countdown hologram. A spawner has a loot table, a minimum and a maximum interval, and a list of locations.
Open the editor
Run /spawnersadmin and click Create ▸ Spawner.
Set the loot and the timing
Use Spawner ▸ Loot table, Spawner ▸ Min interval and Spawner ▸ Max interval.
Add where it drops
Click Spawner ▸ Spawn locations, then Add ▸ Location while standing at the spot.
Turn it on
Click Spawner ▸ Status.
Item spawners belong to the server they were placed on, and each server loads only its own.
When ExyliaSpawners is on the server, this module stays off and ExyliaSpawners provides item spawners.
Item spawner settings (modules/item-spawners/config.yml, under settings:)
| Setting | Default | What it does |
|---|---|---|
detection-radius | 2.0 | How far to look for an item already lying there |
sound-radius | 16.0 | How far the spawn sound carries |
hologram-enabled, hologram-offset-y | true, 2 | The countdown above the spawner |
glow-enabled, glow-color | true, gold | The dropped item's outline; one of the sixteen named text colours |
particle-enabled, particle-type | true, END_ROD | Particles at the spawn |
particle-count, particle-offset, particle-speed | 8, 0.3, 0.05 | Particle burst |
sounds.spawn | ENTITY_ITEM_PICKUP|1.2|0.8 | Sound as NAME|VOLUME|PITCH |
The hologram lines (hologram.ready, hologram.countdown, hologram.disabled, hologram.no-location)
are in modules/item-spawners/messages.yml.
Something missing on this page? Tell us on Discord