Configuration

Rutger Kok edited this page Jan 4, 2016 · 12 revisions

The config file is located in plugins/BetterEnderChest/config.yml. The default config file looks like this:

BetterEnderChest:
  lastModifiedByVersion: 2.3
  language: en
  useUUIDs: true
  drop: OBSIDIAN
  dropSilkTouch: ITSELF
  dropCreative: NOTHING
  enderChestCompatibilityMode: true
  showDebugMessages: false
  lockChestsOnError: true
  manualWorldgroupManagement: false
AutoSave:
  autoSaveIntervalSeconds: 5
IllegalItems: []
PrivateEnderChest:
  rankUpgrades: 2
  defaultSlots: 27
  slotsUpgrade1: 27
  slotsUpgrade2: 27
PublicEnderChest:
  showOnOpeningUnprotectedChest: false
  showOnUsingCommand: false
  defaultSlots: 27
Database:
  enabled: false
  host: localhost
  port: 3306
  databaseName: minecraft
  username: root
  password: ''
  useUtf8: true

BetterEnderChest.lastModifiedByVersion

Currently used for debugging purposes, so that people can be sure they actually have the correct version of BetterEnderChest installed. May be used in the future for other purposes, for example to make sure people aren't accidentally downgrading BetterEnderChest.

BetterEnderChest.language

Which language file to use. For example, en will make BetterEnderChest read translations-en.yml and nl will make BetterEnderChest read translations-nl.yml.

BetterEnderChest.useUUIDs

Set this to false to save chest files by player names instead of UUIDs. When set to false, BetterEnderChest won't make calls to api.mojang.com.

Setting this to false is discouraged, as it serves only to support offline mode, or to punish players for changing their name. The only reason it's here, is that the BukkitDev guidelines require plugins to have an option to disable all network access. There is no conversion available between names and UUIDs.

BetterEnderChest.drop

Allows you to change the drop of the Ender Chest. Names are case-sensitive. Possible values:

  • OBSIDIAN - let it drop 8 obsidian
  • ITSELF - let it drop itself
  • OBSIDIAN_WITH_EYE_OF_ENDER - let it drop 8 obsidian and an Eye of Ender
  • OBSIDIAN_WITH_ENDER_PEARL - let it drop 8 obsidian and an Ender Pearl
  • EYE_OF_ENDER - let it drop just an Eye of Ender
  • ENDER_PEARL - let it drop just an Ender Pearl
  • NOTHING - let it drop absolutely nothing

BetterEnderChest.dropSilkTouch

Allows you to change the drop of the Ender Chest when it is mined using a tool enchanted with the Silk Touch enchantment. You can use the same values as for BetterEnderChest.drop.

BetterEnderChest.dropCreative

Allows you to change the drop of the Ender Chest when a player in creative mode destroys it. You can use the same values as for BetterEnderChest.drop.

BetterEnderChest.enderChestCompatibilityMode

When another plugin shows the standard Ender Chest to a player, BetterEnderChest will close that inventory and show it's own, correct, inventory instead. This setting won't help if other plugins are changing the standard Ender Chest. Plugin developers, click the Source link at the top of this page, I have put some instructions there on how to get the BetterEnderChest inventory.

BetterEnderChest.showDebugMessages

Shows debug messages when an Ender Chest doesn't save or load. Most of the time this is harmless (in example an Ender Chest cannot be loaded because the user has never opened his/her Ender Chest before). If you want to help me debugging something, please turn this on.

BetterEnderChest.lockChestsOnError

This will disable all Ender Chests when a chest fails to load or save. Most of the time, there is a serious problem going on when reads and writes are failing. However, when you want to force BetterEnderChest to continue loading and saving chests, you can do so by setting this to false.

BetterEnderChest.manualWorldgroupManagement

By default, BetterEnderChest will make sure that it follows your MultiInv/Multiverse-Inventories/MyWorlds inventory settings: when inventories are separated between worlds, the Ender Chests will be separate too. BetterEnderChest will also convert the Ender Chests automatically from the various formats of those plugins to its own format.

You can disable this, if you want. This allows for some interesting possibilities, like sharing Ender Chest inventories between different world groups and even servers, so that players can transport items. See the multiworld guide for more information

AutoSave.autoSaveIntervalSeconds

During each autosave, the plugin adds all loaded Ender Chests to the autosave queue. This settings controls the frequency of the autosave. The autosave queue unloads the unused inventories, so make sure there are still frequent autosaves. For server networks it is recommend to set this to a low value, like 2 seconds. Chests are only saved when there are actually changes made to the chest, so this shouldn't cause lag.

IllegalItems

Note: the IllegalItems feature was added in BetterEnderChest 2.3.

Used to block certain items from being placed in the chest. The following example makes it impossible to place End Stone in Ender Chests:

IllegalItems:
- check: itemType
  for: end_stone

See the IllegalItems page for more information.

PrivateEnderChest.rankUpgrades

The number of upgrades that are available. More permission checks have to be done when this made higher, so don't make this higher than necesarry.

PrivateEnderChest.defaultSlots

The slots in the private chest. Recommend: 1-54. Lower this if you think the chest is overpowered. If you use higher values than 54, you will see glitches (but the chest still functions):

Too many rows

Using 180 slots...

PrivateEnderChest.slotsUpgrade1

Players with the permission betterenderchest.slots.upgrade1 will see this number of slots instead of the number in PrivateEnderChest.defaultSlots.

PrivateEnderChest.slotsUpgrade2/3/etc.

Works the same as PrivateEnderChest.slotsUpgrade1 but with another number in both the config node and permission node. If the player has multiple upgrade nodes, the highest number will win.

PublicEnderChest.showOnOpeningUnprotectedChest

If this is set to false, players who open an unprotected Ender Chest will see their own Ender inventory.

If this is set to true, players who open an unprotected Ender Chest will see the public (server-wide) Ender inventory.

PublicEnderChest.showOnUsingCommand

If this is set to true, the public Ender Chest will be opened when /bec openinv, /bec viewinv or /enderchest is called without any parameters. When your players have the correct permission node, (not only the node ending with .self) they can still bypass this.

If this is set to false, the Ender Chest of the player will be opened when /bec openinv, /bec viewinv or /enderchest is called without any parameters.

PublicEnderChest.defaultSlots

The number of slots for the public Ender Chest. Works like the PrivateEnderChest.defaultSlots.

Database

If enabled is set to true, BetterEnderChest will try to connect to the specified MySQL database. If you already have some chests saved as flatfile, set the importer for all groups (see below) to betterenderchest-flatfilenbt.

Imports

Normally, this section won't event exist. You need to set BetterEnderChest.manualWorldGroupManagement to true first. After you have done that, this section will appear after the first server restart or plugin reload (/bec reload).

For each group (see below) you can specify from which source it can import. Valid sources are vanilla, none, multiinv, multiverse-inventories, worldinventories, my-worlds betterenderchest-flatfilenbt and betterenderchest-mysqlnbt.

none is used to start with empty chests, even if players had already put items in their Ender Chests before installing this plugin.

vanilla will import the chest contents from the player data files. Only one group should import from vanilla, otherwise items will be duplicated. You can use none for the other groups.

multiinv, multiverse-inventories, my-worlds and worldinventories are used to import from that plugin. The group name in BetterEnderChest must match the group name of that plugin (names are case-insensitive).

See the multiworld guide for an extensive tutorial about world groups.

The importer betterenderchest-flatfilenbt is useful when migrating from flatfile to MySQL: it will automatically import chests from the files if no chest is found in the database. Make sure that the group names are the same as the group names you used when you were using flatfile. betterenderchest-mysqlnbt is for the opposite situation.

###Groups Normally, this section won't event exist. You need to set BetterEnderChest.manualWorldGroupManagement to true first. After you have done that, this section will appear after the first server restart or plugin reload (/bec reload).

Here you can seperate the Ender Chest between worlds. Worlds in the same group have the same Ender Chest inventories, worlds in different groups have different Ender Chest inventories. You can't have multiple groups with the same name, and you can't have the same world in two or more groups. Missing worlds are automatically added to the group default. Every name will automatically be converted to lowercase.

See the multiworld guide for an extensive tutorial about world groups.