Migration Guide 2.0

See Changelist 2.0 for changes.

1. First Steps

• create a backup of your config files:
  • change the name of your config.yml to config-17.yml to back it up.
    • we will let the new ChestCleaner version generate the new default config, and manually change the new file. The config-17.yml will be used as reference of your server settings, so you can set them correctly again.
  • if it exists, copy and paste the playerdata.yml and rename it to playerdata-17.yml
    • Note: you will change the playerdata.yml in the next step, the playerdata-17.yml is purely as backup if you mess up the next step. Then you can retry it, without losing all your player's settings.

2. playerdata.yml

• replace every occurrence of sortingpattern to pattern (use the replace all function of your text editor)
• delete every line starting with evaluatortyp
  • evaluators have been replaced by categories. players must define their own category order again.

Now you can add the new ChestCleaner jar to the plugins folder, to generate the new config.yml

3. new config.yml

Notice how the structure changed a bit.

• the default value for openEvent changed from false to true. See here what that means.

3.1 Strings

The Strings have been relocated into their own file, which is language specific. That means you can now configure a "locale" in your config, to define which language, so which resource file, is used. Notice the specific names of these files. You can add your own languages, but their files must have the exact same syntax. Meanining ChestCleaner_2-0_<lang>_<country>.properties. The File Encoding is ANSI (windows-1252).

There is no concrete migration guide for the strings, you will have to find the ones you modified in the new resources file. You will see the strings are now assigned to keys, so in the future we will be able to give a concrete guide. However you can't just copy paste your string if you found it, you must also replace all %variables with %s, if the string contains any.

3.2 config

Perhaps you are able to copy over your previous settings from config-17.yml on your own, nevertheless here is a list of all old config keys and their respective new ones. Note that the keys are written with dot notation. In the config, every dot represents a new line, which is indented a bit more than the previous line.

Old Key	New Key
defaultautosort	default.autosort
defaultsortingpattern	default.pattern
defaultevaluator	replaced by Categories (default.categories)
cleaningitem	cleaningitem.item
active	cleaningitem.active
durability	cleaningitem.durability
openinventoryeventmode	cleaningitem.openEvent
consumablesrefill	refill.consumables
blockrefill	refill.blocks
timer.time	cooldown.time
cleanInventorypermissionactive	removed. All players have the permission by default.

3.3 Permissions

Some permissions have changed. If you have given players any of the following permissions, you will have to give them the new one instead. If you do not find the permission in this list, it means it hasn't changed and you mustn't do anything.

Old Permission	New Permission
chestcleaner.timer.noeffect	chestcleaner.cooldown.immune
chestcleaner.cmd.blacklist	chestcleaner.cmd.admin.blacklist
chestcleaner.cmd.cleaningitem.setitem	chestcleaner.cmd.admin.cleaningitem.setitem
chestcleaner.cmd.cleaningitem.rename	chestcleaner.cmd.admin.cleaningitem.rename
chestcleaner.cmd.cleaningitem.setlore	chestcleaner.cmd.admin.cleaningitem.setlore
chestcleaner.cmd.cleaningitem.setactive	chestcleaner.cmd.admin.cleaningitem.setactive
chestcleaner.cmd.cleaningitem.setdurabilityloss	chestcleaner.cmd.admin.cleaningitem.setdurabilityloss
chestcleaner.cmd.cleaningitem.seteventdetectionmode	chestcleaner.cmd.admin.cleaningitem.setopenevent
chestcleaner.cmd.timer	chestcleaner.cmd.admin.cooldown
chestcleaner.cmd.sorting.config.admincontrol	chestcleaner.cmd.admin.config
chestcleaner.cmd.sortingconfig.evaluator	chestcleaner.cmd.sortingconfig.categories

There are also a couple of new parent permissions, to ease permission configuration:

• chestcleaner.autorefill.*
  • chestcleaner.autorefill.blocks
  • chestcleaner.autorefill.consumables
• chestcleaner.cmd.sortingconfig.*
  • chestcleaner.cmd.sortingconfig.categories
  • chestcleaner.cmd.sortingconfig.pattern
  • chestcleaner.cmd.sortingconfig.setautosort
• chestcleaner.cmd.admin.*
  • chestcleaner.cmd.cleaningitem.get
  • chestcleaner.cmd.cleaningitem.give
  • chestcleaner.cmd.cleaninventory
  • chestcleaner.cmd.admin.config
  • chestcleaner.cmd.admin.cooldown
  • chestcleaner.cmd.admin.blacklist
  • chestcleaner.cmd.admin.cleaningitem.*
• chestcleaner.cmd.admin.cleaningitem.*
  • chestcleaner.cmd.admin.cleaningitem.rename
  • chestcleaner.cmd.admin.cleaningitem.setactive
  • chestcleaner.cmd.admin.cleaningitem.setdurabilityloss
  • chestcleaner.cmd.admin.cleaningitem.setopenevent
  • chestcleaner.cmd.admin.cleaningitem.setitem
  • chestcleaner.cmd.admin.cleaningitem.setlore

4 Commands

The syntax of some commands have changed. As a player you don't have to do anything, as there is tabcompletion for all the commands, and you will just tab complete the changed commands. However, if you have CommandBlocks that run a ChestCleaner command, you may have to change them. Here is short list of things that changed.

• new /sortingadmin command, replaces /sortingconfig adminConfig
• merged cooldown command into new /sortingadmin command
• new commands for Categories, replacing the evaluator
• the input for item names for the blacklist is now lowercase and tabcompletion is provided.
• changed /blacklist sorting to /blacklist stacking
• /cleaningitem subcommands changed slightly. See Cleaningitem
• /blacklist subcommands changed slightly. See Blacklist
• /sortingconfig subcommands changed slightly.

See Commands for an Overview of all Commands.