Bukkit

Arable uses a conventional YAML configuration file to specify and apply rules. Please note that all configuration options are case-sensitive.

Sections

There are four top-level sections: rules, defaults, worlds, and advanced.

rules

The rules section is the meat of your configuration file, it's where you list out all of the arable rules that you want to use. In fact, for single-world setups, the rules section is the only section you'll need to use. Rules listed here can also optionally be used in the defaults and worlds sections. The section has the following basic structure:

rules:
    <rule-name>:
        <condition>: <value>
        ...
        <effect>: <value>
        ...
    ...

There can be any number of rules, and each rule can contain as many of the possible conditions and effects as you want.

Here is a complete listing of (case-sensitive) conditions, effects, and values:

defaults

By default, all rules in the "rules" section apply to all game worlds. If this is what you want, then you're already done! If, however, you want to override the default rule list, you need to create a "defaults" section. The format is simply a list of the default rule names:

defaults:
    - <rule-name>
    - ...

worlds

The worlds section lets you override the default rule list for specific worlds. You only need this section if you want to have worlds with unique rule lists. If a world is not listed here, it receives the default rule list. Each entry is a list of rules named after the affected world:

worlds:
    <world-name>:
        - <rule-name>
        - ...
    ...

advanced

The advanced section is for modifying how the plugin does its job. This is a section that you will most likely never need to deal with, but it's here in case you need to exercise extreme control over Arable. Here is a complete list of advanced options: