Updated Setting up the config file (markdown)

garbagemule 2011-07-15 17:10:35 -07:00
parent 1559dc75c8
commit 786ec5599f

@ -56,14 +56,14 @@ 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 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). 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 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). 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.
classes:
Archer:
items: wood_sword, bow, arrow:128, grilled_pork
armor: 298,299,300,301
Knight:
items: 276, 320:2
items: '276'
armor: iron_helmet, iron_chestplate, iron_leggings, iron_boots
Wolf Master:
items: stone_sword, grilled_pork, bone:2
@ -103,6 +103,9 @@ The settings-branch is quite extensive, and besides the `world`-node, it is basi
* `pvp-enabled: [true|false]` - If true, players can damage each other in the arena.
* `monster-infight: [true|false]` - If false, monsters will no longer damage each other.
* `allow-teleporting: [true|false]` - If false, all warping to and from the arena region is blocked. Useful for preventing players from summoning other players into the arena for help.
* `spectate-on-death: [true|false]` - If false, players will not get warped to the spectator area, but instead be "kicked" from the arena (essentially a forced /ma leave).
* `share-items-in-arena: [true|false]` - If false, players will not be able to drop items in the arena.
* `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.
* `player-limit: <amount>` - Specifies the upper limit of how many players may join the arena. The default of `0` means no limit.
* `max-join-distance: <distance>` - The maximum distance (in blocks) from which players can join or spectate the arena. If 0 (default), there is no limit. Note that the distance is calculated from every corner of the arena region, and that players not in the arena world won't be able to join or spectate.
* `repair-delay: <time>` - The time in _server ticks_ (20 ticks = 1 second) between explosions and block reparation. If set to `0`, explosions are completely cancelled out (meaning there will be no explosion animation, and no blocks will get destroyed at all), which also means player-placed blocks will not be blown up. Furthermore, `soft-restore: true` will be ignored.
@ -129,9 +132,11 @@ Note that Ghasts and Giants are a bit wonky. Ghasts' fireballs are known to brea
### rewards ###
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. 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). Note that **only one reward** is picked at random from the list.
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>`.
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), and a diamond sword on wave 19 (only on wave 19):
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). 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:
rewards:
waves:
@ -141,6 +146,7 @@ In the following example, players will receive either four arrows or a gold bar
after:
'7': iron_spade, iron_hoe, iron_axe, iron_pickaxe
'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.