Updated Setting up the config file (markdown)

garbagemule 2013-08-10 07:55:44 -07:00
parent 7267afd277
commit 58f42c7a69

@ -67,7 +67,7 @@ I recommended leaving the update notifications on, and disabling commands like `
## 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, 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 `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 mandatory nodes `items` and `armor`, as well as optional nodes `permissions`, `lobby-permissions` (v0.96+), `unbreakable-weapons` (v0.96+), and `unbreakable-armor` (v0.96+).
**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!
@ -78,6 +78,9 @@ The `classes`-section is slightly more complicated. It is divided into _class-br
permissions:
- EffectiveArrows.use.*
- -mobarena.use.leave
Tank:
items: iron_sword
armor: 310,311,312,313
Knight:
items: '276'
armor: iron_helmet, iron_chestplate, iron_leggings, iron_boots
@ -85,9 +88,15 @@ The `classes`-section is slightly more complicated. It is divided into _class-br
items: stone_sword, grilled_pork, bone:2
armor: 298,299,300,301
### Unbreakable items/armor (v0.96+)
The optional `unbreakable-weapons` and `unbreakable-armor` nodes can be used to toggle on or off the unbreakability of class items and armor. The nodes _default to true_, so they are really only necessary if you want to toggle OFF the feature, i.e. if you want items to deteriorate and break! If that's what you want, set the nodes to false.
### Per-class 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).
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).
(v0.96+) The optional `lobby-permissions`-node gives players special permissions while they are in the lobby _after they have picked a class_. This feature can be used e.g. in combination with a shop plugin and a base class that perhaps has nothing but a few potions.
### Pet classes
@ -137,7 +146,10 @@ The settings-branch is quite extensive, and besides the `world`-node, it is basi
* `display-waves-as-level: [true|false]` - When set to true, the players' level counter (above the experience bar) will be used to display the current wave number. If the wave announcements in the announcements-file are silenced, this can be used to make a much less "spammy" MobArena experience. NOTE: Do not use this if `keep-exp` is set to true!
* `display-timer-as-level: [true|false]` - When set to true, the players' level counter (above the experience bar) will be used to display the auto-start timer in the lobby. NOTE: Do not use this if `keep-exp` is set to true!
* `auto-ready: [true|false]` - When set to true, players are automatically flagged as ready when they pick a class. Useful for arenas with many players where hitting an iron block becomes difficult.
* `global-end-announce: [true|false]` - When set to true, MobArena will announce the `ARENA_END_GLOBAL` (see [[Setting up the announcements-file]]) message to all players on the server when an arena ends.
* (v0.96+) `isolated-chat: [true|false]` - When set to true, all chat messages sent by arena players will be seen only by other arena players in the same arena. The arena players will still be able to see chat messages from other players on the server who aren't in an arena.
* (v0.96+) `global-end-announce: [true|false]` - When set to true, MobArena will announce the `ARENA_END_GLOBAL` message (see [[Setting up the announcements-file]]) to all players on the server when an arena ends.
* (v0.96+) `global-first-join-announce: [true|false]` - When set to true, MobArena will announce the `ARENA_JOIN_GLOBAL` message (see [[Setting up the announcements-file]]) to all players on the server when the first player joins an arena.
### waves