Repository navigation
Kits
Kits are packs of items that players claim, with a waiting time between claims and, if you want, a permission. They can contain books, random books, special items, set pieces and any other item.
Each kit is a file in plugins/MetaEnchants/kits/. The name of the file is the id of the kit: kits/starter.yml is the kit starter. Kits reload with /metaenchants reload. Turn them all off in config.yml:
kits:
enabled: falsename: "<green>Starter Kit"
cooldown: 1d
permission: false
icon:
material: CHEST
name: "<green>Starter Kit"
lore:
- "<gray>A few books and dust to begin."
items:
- "metaenchants:random-book/common 2"
- "metaenchants:random-book/rare"
- "metaenchants:item/magic-dust 2"
- "metaenchants:item/white-scroll"
- "BREAD 16"
- item:
material: IRON_SWORD
name: "<white>Starter Sword"
enchantments:
sharpness: 1| Option | Meaning |
|---|---|
name |
The name shown in messages. |
cooldown |
Time between two claims of the same player: 30s, 10m, 12h, 1d, 1w, or a mix like 1d12h. A plain number is seconds. 0 or nothing means no wait. |
permission |
true needs metaenchants.kit.<id> (like metaenchants.kit.starter). false lets everyone claim it. Any other text is the permission it needs. true by default. |
icon |
The item that shows the kit in the menu. Without it, a chest with the name of the kit. |
items |
What the kit gives. |
Each line of items is one of these:
- An item id, optionally followed by an amount:
"metaenchants:random-book/rare","BREAD 16","oraxen:ruby 3". The ids are the same as in boxes. - A section with
giveandamount:{give: "metaenchants:item/soul-gem", amount: 2}. - A section with a full
item(same format as any item; see Items) and an optionalamount.
Random books are rolled one by one, so "metaenchants:random-book/common 2" normally gives two different books; stackable books may be identical. If the inventory is full, the rest drops at the player's feet.
| Command | What it does |
|---|---|
/metaenchants kit |
Opens the kit menu. |
/metaenchants kit <kit> |
Claims a kit directly. |
Both need metaenchants.command.kit (everyone by default), and each kit can need its own permission. The waiting time is saved on the player, so it survives restarts.
Administrators (metaenchants.command.admin) have two more commands:
| Command | What it does |
|---|---|
/metaenchants givekit <players> <kit> |
Gives the kit without waiting time or permission, and without starting the waiting time. |
/metaenchants resetkit <players> <kit> |
Lets the players claim the kit again right away. |
The menu is menus/kits.yml, a shaped menu. Kits appear where it has content: kits, each with its icon. Clicking one claims it, and the menu refreshes to show the new waiting time.
kit-lore:
- ""
- "<gray>Every <white>%value%"
- "<gray>Status: %time%"
- "<yellow>Click to claim"kit-lore is added under the icon of every kit:
| Word | Replaced by |
|---|---|
%kit% |
The name of the kit. |
%time% |
The time left until it can be claimed again, or the kit-ready or kit-locked message. |
%value% |
The waiting time between claims. |
| Message | When | Replaced words |
|---|---|---|
kit-claimed |
A kit was claimed. | %kit% |
kit-cooldown |
The kit cannot be claimed yet. |
%kit%, %time%
|
kit-permission |
The player does not have the permission of the kit. | %kit% |
kit-unknown |
A kit id that does not exist. | %name% |
kit-ready |
The %time% of a kit that can be claimed now. |
|
kit-locked |
The %time% of a kit the player cannot claim. |
|
kit-reset |
After resetkit. |
%kit%, %count%
|
Kits of EssentialsX or CMI also work with MetaEnchants enchantments, because they are real enchantments. Use these kits when you want random books, special items or set pieces.