Enchantment packs

Enchantment packs, or just packs, are multiple enchantments bundled into one file.

`pack_metadata.json`

Every enchantment pack is defined by a metadata file. It stores various information like the author of the pack, the name, etc.

Here's an example metadata file:

{
  "name": "Best pack",
  "authors": [ "Roughly_" ],
  "description": [],
  "website": "",
  "version": "1.0",
  "item": "DIAMOND"
}

Field specification

`name`

Mandatory field

The name field defines the pack both internally and for users to identify.

Example:

"name": "Pack name"

`version`

Mandatory field

The version field is used to make updating packs easier. When you download a pack from the repository, you download the latest version of it automatically. The pack author can update the pack at anytime and if they do, they should bump up the version. It's planned to add some functionality to allow the plugin to fetch the latest version of all downloaded packs on startup and see if they are all up-to-date and if not, notify the administrator (not yet added, but will be soon). As such, please use this field responsibly and bump up the version whenever you update your pack and upload the update to the repository.

Example:

"version": "1.0.0"

`authors`

Optional field

This field is a list of strings that indicate the authors of this pack.

Example:

"authors": [ "Notch", "Dinnerbone" ]

`description`

Optional field

This field is a list of strings that serve as your pack description.

Example:

"description": [ "Hi!" ]

`website`

Mandatory field

This field is a link to your website or the website of your pack. If you don't have one, please do not leave it blank, instead link your Discord server or anything that can help to identify you in case the pack users need support.

Example:

"website": "runderscore.com"

`worldBlacklist`

Optional field

This field is a list of world names in which none of the pack enchantments will work. They will work in all the other worlds (unless specified otherwise in the enchantments).

Example:

"worldBlacklist": [ "spawn_nether" ]

`worldWhitelist`

Optional field

This field is a list of world names in which the pack enchantments will work. They will NOT work in any of the other worlds (unless specified otherwise in the enchantments).

Example:

"worldWhitelist": [ "spawn" ]

`item`

Mandatory field

This field is the item type that will be shown in the browsing GUI for your pack.

Example:

"item": "DIAMOND"

Creating the pack

After you have created a metadata file, gather all your enchantment files and the metadata file and put them in a .tar archive. Most archive programs know how to do this; it's also available in most Linux distribution terminals. The final .tar file is your pack.