Configuration

This plugin is highly user-configarable. After version 3.0.0 special attention was paid to the ability of all users to configure all aspects of the plugin.

### What you can edit

* Item names
* Item lore
* Item enchantments
* Item attributes (like Attack speed or Armor toughness)
* Ability details (like cooldown, damage dealt, size of explosion, etc.)
* Whether an item is unbreakable or not
* Max charm equipment slots available per player
* Whether the enchantments are displayed or not
* Whether items are protected from despawning and/or burning/lava or not

### What you cannot edit

* What an ability does fundamentally (e.g. thunder axe will always strike lightning, this cannot be changed)

## How the configuration works

The configuration is accessed by navigating to  `(server folder)/plugins/GodItems` . There you will see a file `config.yml` and two folders `items` and `playerInventories`.

### config.yml

This is the file containing plugin-wide configuration. It should have the following content by default:

```
goditems:
 spawn\_in\_chest\_chance: 10 # percentage, spawn GodItems in naturally generated chests
 protect\_items: true # whether goditems dropped on ground should be protected from burning or cactus(they will still despawn after a period of time)
 items\_despawn: false # false -> stop goditems from despawning(might reduce performance), true -> goditems despawn
 show\_enchantments: false # true -> you can see the enchantments of the items; false -> you can not
 custom\_textures: true #true -> textures on; false -> textures off (Patreon version required!)
 boss\_spawn\_chance: 10 # Chance to spawn a boss when spawning normal monster. We recommend setting spawn\_in\_chest to 0
 use\_party\_scoreboard: true #true-> you will see a sidebar scoreboard with all members of your party; false -> no scoreboard, view members with /party show (removes clashes with other plugins with scoreboards)
 charm\_slots: 5 # min 1 max 8

```

### items

This folder contains all item configuration. Every item has its own config file created and they follow the naming convention `(code name).yml`. All files follow the same structure:

* ability fields - configuration fields specific to the item ability
* appearance - name, lore and model data(excluding charms). Separate lore lines with a '/'
* enchantments - all enchantments applicable to the item (eg. Protection is not an applicable enchantment for a sword)
* attributes - all applicable attributes(eg. attack speed for weapons or knockback resistance for armor)

Charms have slightly different configuration file structure:

* ability fields - each ability parameter has 3 separate fields for the different levels of the charm
* appearance - item name and lore. Separate lore lines with a '/'
* enchantments - enchantments applicable to the item (Unbreaking and curse of vanishing)
* level appearance - each level can have different prefix to the name, addition to the lore(separate lines with '/') and different model data

### playerInventories

This folder contains a file for every player on the server where their equipment and charm equipment are stored. In this way charms are saved even when the server is down. YOU SHOULD NOT TOUCH THIS FOLDER! It is made to be only written and read by the plugin and if you change anything you may cause an error.