Documentation/Configuration file

Configuring the plugin's settings


Where can I find the config.yml?

The plugin's configuration file, the config.yml, can be found inside your server's plugin folder, in a folder named 'UndroppableItem'. Open the config.yml with either Notepad or Notepad Plus Plus, but I recommend using Notepad Plus Plus, which can be downloaded here.

How do I configure the plugin?

When you open the config file, it should look like this:

# Disable or enable the storage of an Undroppable item in a specific container type
containers:
  chest: false
  ender_chest: true
  shulker_box: false
  workbench: true
  furnace: false
  dispenser: false
  dropper: false
  enchantment_table: true
  brewing_stand: false
  villager: true
  beacon: false
  anvil: true
  hopper: false
  unidentified: false
keepUponDeath: true
setLore: true
lore: '&6Undroppable;&7This item is bound to you.'

To configure these settings, just simply edit the values after the ':'. I will explain the settings for you:

Containers

In this configuration section you can allow or deny storage of Undroppable items in specific container types. To deny storage in a specific container, use the value 'false'. To allow storage, use the value 'true'.

KeepUponDeath

This value represents the option to keep Undroppable items upon death. Having this on 'true' will cause Undroppable items to not be dropped upon death, and given back upon respawn.

SetLore

This value represents the option to have Undroppable items have special lore. Having this on 'true' will set the custom defined lore (definable with the 'lore' setting) to Undroppable items.

Lore

This value will be the lore of an Undroppable item. You can have several lines in the lore. You can define the end of a line with ';'. You can use color codes in this value (e.g. &6 for Gold).

Troubleshooting


There is no config.yml in the folder/There is no UndroppableItem folder. What do I do now?

Be sure you have run your server at least once with the plugin installed, so it can create all the required files for you. After that, a folder named 'UndroppableItems' with a file named config.yml in it should be generated. If it doesn't, please report this error to me, by creating a ticket on the Issues page.

After I configured the plugin's settings (config.yml), it gives errors. What do I do now?

Be sure you have set the settings of the config.yml to a valid value. For valid values, check above. If you still experience errors, please report this error to me, by creating a ticket on the Issues page.