main/Documentation

RandomBox is highly customizable, almost every part of the plugin can be changed.

Note: to understand meaning of words "key", "section" and "list", read first about YAML language.

Note: in some cases (to make config more compact or to make list of sections) sections may be written like this:

section: {key1: value1, key2: value2}

This definition of section is equivalent to:

section:
  key1: value1
  key2: value2

config.yml

Main config of the plugin contains several settings:

'locale'

The plugin is translated on four languages: English (en), Russian (ru), Chinese (zhcn), Deutch (de), Spanish (es). You can select the translation by changing this setting to the short name of the needed translation. Default value is 'en'.

'useInfinitePermission'

If set to true, permission 'randombox.infinitebox' will be enabled. If player has this permission, boxes will be not disappear after opening.

'dropBoxWhenNotEnoughSpace'

If set to true, boxes will be dropped onto ground near player, if the player has no free space in inventory. This works when giving boxes with /givebox command.

'disableDamageFromBoxFirework'

If set to true, players will not receive damage from fireworks launched due to box effects. This is enabled by default, if not present in the config.

Configuring Boxes

Every box is stored in its own config in /RandomBox/boxes/ directory. Box format is described here.

Translation

Translations are stored in /RandomBox/locales/ directory as YAML configs that have only String values. Every string in it can be colored using '&' character.

If you've translated plguin into your language or have noticed a mistake, write me a PM.

Configuration Examples

Plugin contains ready to use box 9901 "Warrior Box". In most cases all you need is change the box name and drop items, and you will get a working box.


Comments

Posts Quoted:
Reply
Clear All Quotes