Upstream/MobArena
1
0
Fork 0
mirror of https://github.com/garbagemule/MobArena.git synced 2024-11-29 14:15:46 +01:00
Code Issues Projects Releases Wiki Activity

Updated Setting up the config file (markdown)

garbagemule 2011-06-29 04:32:37 -07:00
parent f8c8795f10
commit 722347100f
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Setting-up-the-config-file.md

@ -37,10 +37,9 @@ The config-file consists of 3 sections: **global-settings**, **classes**, and **
Note about notation: `[true|false]` means the setting can take the values "true or false", either or. `<time>` means the setting can take an amount (either seconds or server ticks), always a whole number, and always `0` or greater. `<amount>` is similar to time.
## Global Settings ##
`global-settings`
## global-settings ##
The global settings are few, but important. Note that if **enabled** is set to false, no arenas can be joined, no matter what their individual **enabled** status is.
The global settings are few, but important. Note that if `enabled: false`, no arenas can be joined, no matter what their individual `enabled` status is.
* `enabled: [true|false]` - This determines if MobArena is enabled or not. If set to `false`, players will not be able to join any arenas at all, regardless of what the arenas' individual statuses are.
* `update-notification: [true|false]` - If true, MobArena will send a message to ops when they log on if a new version of MobArena is available.
@ -51,7 +50,7 @@ I recommend keeping `update-notification: true` and `repair-delay: 5` for normal
## classes ##
The classes section is slightly more complicated. It is divided into _class-branches_, where each branch denotes the _name of the class_, and each branch has an `items`-node and an `armor`-node. These nodes specify which items and armor pieces each class has, respectively.
The items can be written as either their [data value/type id](http://www.minecraftdatavalues.com/js.php), or as their [Material name/type](http://jd.bukkit.org/apidocs/org/bukkit/Material.html). The items are written in the notation `<item>:<amount>`. If the colon and amount are left out, the amount will default to 1. In this example, the _Archer_ gets a wooden sword, a bow, 128 arrows and a grilled porkchop from his `items`-node (in Material names), and leather armor from his `armor`-node (in data values). Conversely, the _Knight_ gets a diamond sword and 2 roasted porkchops, written in data values, as well as iron armor, written in Material names.
The items can be written as either their [data value/type id](http://www.minecraftdatavalues.com/js.php), or as their [Material name/type](http://jd.bukkit.org/apidocs/org/bukkit/Material.html). The items are written in the notation `<item>:<amount>`. If the colon and amount are left out, the amount will default to 1. In this example, the **Archer** gets a wooden sword, a bow, 128 arrows and a grilled porkchop from his `items`-node (in Material names), and leather armor from his `armor`-node (in data values). Conversely, the **Knight** gets a diamond sword and 2 roasted porkchops, written in data values, as well as iron armor, written in Material names.
classes:
Archer:
@ -68,7 +67,7 @@ I recommend using the data values, because it is much less prone to error. It is
### Pet classes ###
For every bone (Material name: `bone`, data value: `352`) in a class' items-list, one wolf pet will spawn upon arena start. In the example above, every player that picks the _Wolf Master_ class will have 2 wolves spawn upon arena start. The wolves are invincible, but deal less damage than normal wolves.
For every bone (Material name: `bone`, data value: `352`) in a class' items-list, one wolf pet will spawn upon arena start. In the example above, every player that picks the **Wolf Master** class will have 2 wolves spawn upon arena start. The wolves are invincible, but deal less damage than normal wolves.
## arenas ##
This section is by far the largest, and it is divided into several smaller branches. In the above example, `default` denotes the _name_ of the default arena. This name can be altered, but it must contain no spaces (use underscores instead). The arena name is significant when a server has multiple arenas and no Master Lobby (will be featured later). Let's go over the different branches: