Updated Setting up the config file (markdown)

garbagemule 2013-08-07 01:44:43 -07:00
parent d82a5fc3e6
commit 28064a4f4f

@ -57,7 +57,7 @@ I recommended leaving the update notifications on, and disabling commands like `
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, an `armor`-node, and an optional 'permissions'node. These nodes specify which items and armor pieces each class has, as well as any extra permissions.
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). They are written in the form `<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 only a diamond sword (note how if there is only _one_ item, that item _must_ be enclosed in apostrophes!), written in data values, as well as iron armor, written in Material names.
**Note:** YAML is picky about how you type your items. Make sure you read the short [[Item Syntax]]-page and fully understand it before you attempt to modify the config file!
classes:
Archer:
@ -73,8 +73,6 @@ The items can be written as either their [data value/type id](http://www.minecra
items: stone_sword, grilled_pork, bone:2
armor: 298,299,300,301
I recommend using the data values, because it is much less prone to error. It is very easy to miss a letter or type a wrong name when using Material names.
### Class-based permissions ###
Using the optional 'permissions'-node, you can give classes special permissions to customize them even more. Each permission must be listed with a dash (-) in front of it. If you want a class to _not_ have a permission, put a dash/minus at the very beginning of the permission node. In the example above, the **Archer** class will be able to use the EffectiveArrows plugin, but won't be able to use `/ma leave` (meaning it's impossible to leave the arena without dying).
@ -83,10 +81,6 @@ Using the optional 'permissions'-node, you can give classes special permissions
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.
### Subtypes (cocoa beans, bone meal, colored wool) ###
For items like cocoa beans, which are a _subtype_ of `ink_sack` (both items are dyes), an extra piece of data is required. Using the [data values](http://www.minecraftdatavalues.com/)-link, cocoa beans appear to have the data value 351. They also appear to have a _metadata value_ of 3 (subscripted to the right of 351). To grant cocoa beans to a class, use the notation `<item>:<metadata>:<amount>`, i.e. for 10x cocoa beans: `ink_sack:3:10` or `351:3:10` or even `ink_sack:brown:10`. Note that the amount is _required_ when using this notation.
## 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:
@ -97,7 +91,7 @@ The settings-branch is quite extensive, and besides the `world`-node, it is basi
* `enabled: [true|false]` - If false, players cannot join the arena.
* `protect: [true|false]` - If false, the arena will not be protected from explosions and players breaking the blocks.
* `logging: [true|false]` - **This setting is currently bugged, do not set to true!** If true, at every arena end, relevant information about the arena session will be appended to a file `plugins/MobArena/logs/<arena>.log`. Note that there is no sort of limit on how big this file can become, so keep an eye on it.
* `entry-fee: [$<amount>|<item>:<amount>]` - Follows the exact same notation as the class items and rewards. `$20` will subtract 20 of whatever currency you use from the players upon joining. `$5, stick:2` will require the player to have 5 currency units and 2 sticks to join the arena. The entry-fee will be refunded if the player leaves before the arena starts.
* `entry-fee: [$<amount>|<item>:<amount>]` - Follows the exact same notation as the class items and rewards (read the [[Item Syntax]]-page). `$20` will subtract 20 of whatever currency you use from the players upon joining. `$5, stick:2` will require the player to have 5 currency units and 2 sticks to join the arena. The entry-fee will be refunded if the player leaves before the arena starts.
* `clear-wave-before-next: [true|false]` - If true, no monsters will spawn before all monsters of the previous wave have been killed.
* `clear-boss-before-next: [true|false]` - If true, no new waves will spawn before the current boss (if any) is dead.
* `clear-wave-before-boss: [true|false]` - If true, a boss wave will not spawn until all previous monsters have been killed.
@ -141,6 +135,8 @@ Please go to [[setting up the waves]] for more information.
The rewards-section denotes which rewards the arena players can win in the arena. It uses the exact same item system as the classes-section does, so nothing new there. You can also specify monetary rewards if you use a major economy plugin (iConomy, BOSEconomy, Essentials Eco) in the notation `$<amount>`.
**Note:** YAML is picky about how you type your items. Make sure you read the short [[Item Syntax]]-page and fully understand it before you attempt to modify the config file!
The waves-branch is broken into `every`- and `after`-branches. The `every`-branch denotes rewards that the players can receive _every_ x waves (repeated). The `after`-branch denotes rewards that the player can receive _after_ wave x (only once) has started. Note that **only one reward** is picked at random from the list.
In the following example, players will receive either four arrows or a gold bar every 3 waves (3, 6, 9, 12, etc.), and a diamond every 10 waves (10, 20, 30, etc.), as well as an iron tool on wave 7 (only on wave 7), a diamond sword on wave 19 (only on wave 19), and 200 currency units on wave 20:
@ -155,7 +151,7 @@ In the following example, players will receive either four arrows or a gold bar
'19': diamond_sword
'20': $200
Note that the wave numbers **must be enclosed by apostrophes** (e.g. `'7': ...`), or MobArena will throw YAML-errors. If you aren't sure how to do it, just copy one of the other lines and change the wave number and the items.
**Note:** The wave numbers **must be enclosed by apostrophes** (e.g. `'7':`, not `7:`), or YAML will throw errors. If you aren't sure how to do it, just copy one of the other lines and change the wave number and the items.
### coords ###