Updated Setting up the config file (markdown)

Setting-up-the-config-file.md

@@ -28,13 +28,17 @@ The config-file, `plugins/MobArena/config.yml`, consists of 3 sections: `global-
       enabled: true
       allowed-commands: /list
       prefix: '&a[MobArena] '
+      pet-items:
+        wolf: bone
+        ocelot: raw_fish
     classes:
       Knight:
-        items: diamond_sword, grilled_pork:2
-        armor: 306,307,308,309
-      Archer:
-        items: wood_sword, bow, arrow:128, grilled_pork
-        armor: 298,299,300,301
+        items: diamond_sword, potion:instant_heal:3
+        armor: iron_helmet, iron_chestplate, iron_leggings, iron_boots
+      Tank:
+        items: iron_sword, potion:instant_heal:2
+        armor: diamond_helmet, diamond_chestplate, diamond_leggings, diamond_boots
+        effects: slow, health_boost
       [...]
     arenas:
       default:
@@ -60,6 +64,7 @@ The `global-settings` are few, but important. Note that if `enabled: false`, no
 * `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.
 * `allowed-commands: <com1>, <com2>, ...` - A comma-separated list of the commands that players are allowed to use while in the lobby and/or arena. This is useful if you don't want players to use teleport-commands, flying carpets, kill commands, etc. If you write the command WITH its forward-slash, the entire command and all "sub-commands" will be allowed. For instance, writing `/kill` will allow both `/kill`, `/kill Sausageman22` and `/kill Notch`. Writing the command WITHOUT its forward-slash will allow only that specific command or "sub-command". Writing `kill` will thus ONLY allow `/kill`, but not `/kill Sausageman22`.
 * `prefix: <prefix>` - The prefix MobArena uses for all of its messages. The default is the classic green `[MobArena]`, but you can change it to whatever you want. You can override the prefix for specific arenas by using the arena-specific setting with the same name.
+* `pet-items` - By default, bones are transformed to pet wolves, and raw fish are transformed to pet ocelots. This section lets you change the item types if you want.
 
 I recommended leaving the update notifications on, and disabling commands like `/kill` and `/tp`.
 
@@ -72,30 +77,30 @@ The `classes`-section is slightly more complicated. It is divided into _class-br
     classes:
       Archer:
         items: wood_sword, bow, arrow:128, grilled_pork
-        armor: 298,299,300,301
+        armor: leather_helmet, leather_chestplate, leather_leggings, leather_boots
         effects: speed
         permissions:
         - EffectiveArrows.use.*
         - -mobarena.use.leave
       Tank:
         items: iron_sword
-        armor: 310,311,312,313
+        armor: diamond_helmet, diamond_chestplate, diamond_leggings, diamond_boots
         offhand: shield
-        effects: slow
+        effects: slow, health_boost
       Knight:
-        items: '276'
+        items: diamond_sword
         armor: iron_helmet, iron_chestplate, iron_leggings, iron_boots
       Wolf Master:
         items: stone_sword, grilled_pork, bone:2
         armor: 298,299,300,301
       Crusader:
         items: iron_sword, hay_block:17
-        armor: 302,303,304,305
+        armor: chainmail_helmet, chainmail_chestplate, chainmail_leggings, chainmail_boots
         price: $5
 
 ### Bring your own items
 
-MobArena allows you to just bring your own items into the arena via the implicit 'My Items' class. What this means is that if you just place a sign in the lobby with the text My Class, you'll get the items that you had before joining the arena. Items are still restored on dying in or leaving the arena.
+MobArena allows you to just bring your own items into the arena via the implicit 'My Items' class. What this means is that if you just place a sign in the lobby with the text My Items, you'll get the items that you had before joining the arena. Items are still restored on dying in or leaving the arena.
 
 For a smooth, own-items-only experience, ditch the signs and set the per-arena setting `default-class` to `myitems`.
 
@@ -105,7 +110,7 @@ If you want to use off-hand items, or if you just want to be explicit about whic
 
 ### Potion effects
 
-Classes can be enhanced with potion effects using the optional `effects` node. Available potion effects are listed in the [PotionEffectType](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/potion/PotionEffectType.html) constants in the Bukkit API. The potion syntax is `<effect>:<amplifier>:<seconds>`. The amplifier and duration are optional, and will default to 0 (level 1) and pseudo-infinity, respectively. In the example above, the **Archer** class has the speed effect to make it more nimble, and the **Tank** class has the slow effect to match the weight of its heavy armor. Both effects are level 1 and last "forever".
+Classes can be enhanced with potion effects using the optional `effects` node. Available potion effects are listed in the [PotionEffectType](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/potion/PotionEffectType.html) constants in the Bukkit API. The potion syntax is `<effect>:<amplifier>:<seconds>`. The amplifier and duration are optional, and will default to 0 (level 1) and pseudo-infinity, respectively. In the example above, the **Archer** class has the speed effect to make it more nimble, and the **Tank** class has the slow effect to match the weight of its heavy armor and the health boost effect to make him more beefy. All of these effects are level 1 and last "forever".
 
 ### Price
 
@@ -118,7 +123,7 @@ The optional `unbreakable-weapons` and `unbreakable-armor` nodes can be used to
 classes:
   FrailTank:
     items: diamond_sword
-    armor: 310,311,312,313
+    armor: diamond_helmet, diamond_chestplate, diamond_leggings, diamond_boots
     <font color="blue">unbreakable-weapons: false</font>
     <font color="blue">unbreakable-armor: false</font>
 </pre>
@@ -130,7 +135,7 @@ Using the optional `permissions`-node, you can give classes special permissions
 classes:
   Archer:
     items: wood_sword, bow, arrow:128, grilled_pork
-    armor: 298,299,300,301
+    armor: leather_helmet, leather_chestplate, leather_leggings, leather_boots
     <font color="blue">permissions:</font>
     <font color="blue">- EffectiveArrows.use.*</font>
     <font color="blue">- -mobarena.use.leave</font>
@@ -148,12 +153,12 @@ classes:
 
 ### Pet classes
 
-For every bone (Material name: `bone`, data value: `352`) in a class' items-list (or class chest), 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` or `raw_fish` in a class' items-list (or class chest), one wolf or ocelot 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. Ocelots help deter creepers.
 <pre>
 classes:
   Wolf Master:
     items: stone_sword, grilled_pork, <font color="blue">bone:2</font>
-    armor: 298,299,300,301
+    armor: leather_helmet, leather_chestplate, leather_leggings, leather_boots
 </pre>
 
 ### Mounts
@@ -175,14 +180,14 @@ In the example above, every player that picks the **Crusader** class will have a
 classes:
   Crusader:
     items: iron_sword, <font color="blue">hay_block:17</font>
-    armor: 302,303,304,305
+    armor: chainmail_helmet, chainmail_chestplate, chainmail_leggings, chainmail_boots
 </pre>
 
 ## 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:
 
 ### settings
-The settings-branch is quite extensive, and besides the `world`-node, it is basically just a bunch of toggles (on/off, true/false), though a few are number-based.
+The settings-branch is quite extensive, and besides the `world`-node, it is basically just a bunch of toggles (on/off, true/false), though a few are special.
 
 * `prefix: <prefix>` - An arena-specific prefix to use for messages/announcements in this arena only. The default is the empty string (`''`), which means the `global-settings` prefix will be used.
 * `world: <name>` - The name of the world the arena resides in.
@@ -193,12 +198,10 @@ The settings-branch is quite extensive, and besides the `world`-node, it is basi
 * `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.
-* `auto-equip-armor: [true|false]` - If true, armor pieces will automatically be equipped upon class selection. Note that this does not work if a class has more than 1 of an armor piece type.
 * `soft-restore: [true|false]` - If true, all destroyed blocks will be saved in a "repair list", which will be used to restore blocks at arena end. No data is saved to the harddrive. Note that this setting, if true, ignores the `protect` flag.
 * `soft-restore-drops: [true|false]` - If true, blocks destroyed by players will drop as items like they normally do (using pickaxes, spades, etc.). Note that this makes it very easy for classes with pickaxes to "mine the arena" and build forts.
 * `require-empty-inv-join: [true|false]` - If false, players' inventories will be saved upon joining, and restored upon death/leaving.
 * `require-empty-inv-spec: [true|false]` - If false, players can spectate the arena without having to empty their inventories.
-* `hellhounds: [true|false]` - If true, all pet wolves in the arena will be in flames! This has no actual function, and is purely for the cool-factor. Also useful for distinguishing enemy wolves and pet wolves.
 * `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.