Upstream/MobArena
1
0
Fork 0
mirror of https://github.com/garbagemule/MobArena.git synced 2025-02-18 05:21:55 +01:00
Code Issues Projects Releases Wiki Activity

Updated Setting up the config file (markdown)

garbagemule 2014-02-02 06:03:02 -08:00
parent 02002ab87e
commit bd3bac3cbb
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2,10 +2,10 @@
* [Overview](./Setting-up-the-config-file#wiki-an-overview)
* [`global-settings`](./Setting-up-the-config-file#wiki-global-settings)
* [`classes`](./Setting-up-the-config-file#wiki-classes)
* [Unbreakable items](./Setting-up-the-config-file#wiki-unbreakable-weaponsarmor-v096)
* [Unbreakable items](./Setting-up-the-config-file#wiki-unbreakable-weaponsarmor)
* [Per-class permissions](./Setting-up-the-config-file#wiki-per-class-permissions)
* [Pet classes](./Setting-up-the-config-file#wiki-pet-classes)
* [Mounts](./Setting-up-the-config-file#wiki-mounts-v096)
* [Mounts](./Setting-up-the-config-file#wiki-mounts)
* [`arenas`](./Setting-up-the-config-file#wiki-arenas)
* [`settings`](./Setting-up-the-config-file#wiki-settings)
* [`waves`](./Setting-up-the-config-file#wiki-waves)
@ -58,7 +58,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 mandatory nodes `items` and `armor`, as well as optional nodes `permissions`, `lobby-permissions` (v0.96+), `unbreakable-weapons` (v0.96+), and `unbreakable-armor` (v0.96+).
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`, `unbreakable-weapons`, and `unbreakable-armor`.
**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!
@ -82,7 +82,7 @@ The `classes`-section is slightly more complicated. It is divided into _class-br
items: iron_sword, hay_block:17
armor: 302,303,304,305
### Unbreakable weapons/armor (v0.96+)
### Unbreakable weapons/armor
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.
<pre>
@ -107,7 +107,7 @@ classes:
<font color="blue">- -mobarena.use.leave</font>
</pre>
(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 (maybe except for a few potions).
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 (maybe except for a few potions).
<pre>
classes:
Basic:
@ -127,7 +127,7 @@ classes:
armor: 298,299,300,301
</pre>
### Mounts (v0.96+)
### Mounts
To give a class a horse mount, give it a hay block in the items-list (or place a hay block in the class chest). The item stack amount (in the first encountered stack) determines the variant and barding of the horse in a bit string pattern similar to the UNIX file permissions. To calculate the item stack amount, use [this tool](http://garbagemule.binhoster.com/mobarena/tools/mount/). In the example above, every player that picks the **Crusader** class will have a white horse with gold barding upon arena start. The mounts are invincible.
<pre>
@ -182,9 +182,9 @@ The settings-branch is quite extensive, and besides the `world`-node, it is basi
* `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.
* `use-scoreboards: [true|false]` - Whether to use scoreboards in MobArena or not.
* (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 [[Announcements]]) to all players on the server when an arena ends.
* (v0.96+) `global-join-announce: [true|false]` - When set to true, MobArena will announce the `arena-join-global` message (see [[Announcements]]) to all players on the server when the first player joins an arena.
* `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.
* `global-end-announce: [true|false]` - When set to true, MobArena will announce the `arena-end-global` message (see [[Announcements]]) to all players on the server when an arena ends.
* `global-join-announce: [true|false]` - When set to true, MobArena will announce the `arena-join-global` message (see [[Announcements]]) to all players on the server when the first player joins an arena.
### waves