Quick Start

Install the plugin to the server

• After downloading the plugin, place its Zaphkiel.jar file into the server's plugins folder
• Restart the server to load the plugin
• Once the plugin is loaded, it will generate the default Zaphkiel configuration under the plugins folder

Verify the plugin is loaded successfully

[07:09:27] [Server thread/INFO]: [Zaphkiel] Loading server plugin Zaphkiel v2.1.0
...
[07:09:33] [Server thread/INFO]: [Zaphkiel] Enabling Zaphkiel v2.1.0

Check the generated folder structure

The following directory structure will be created automatically when the plugin starts:

Create your first item

Create a my_items.yml file in the plugins/Zaphkiel/item/ directory:

magic_sword:
  icon: diamond_sword
  name:
    item_name: '&6Magic Sword'
  lore:
    item_type: '&9Legendary Weapon'
    item_description:
      - '&fA divine weapon filled with magic'
      - '&7Right-click to unleash magic skills'
  data:
    damage: 100
    level: 5
  data-mapper:
    damage: it
    level: it
  event:
    interact:
      script: "tell '&aYou unleashed magic! Dealt &c<damage> &adamage!'"

Reload the configuration and test the item

/zaphkiel reload

After a successful reload, you will see output similar to the following:

[Zaphkiel] Loaded 1 items (0 models)  
[Zaphkiel] Loaded 1 display plans

Obtain and test your item

Join the server and use the following command to get the item:

/zaphkiel give magic_sword

Right-click the item to test the event function—you should see the following message displayed in the chat:

You unleashed magic! Dealt 100 damage!