mirror of
https://github.com/garbagemule/MobArena.git
synced 2025-02-18 05:21:55 +01:00
Updated Setting up the config file (markdown)
garbagemule
parent
8fa5c14a7e
commit
d9db8fe0e8
@ -4,6 +4,7 @@
|
||||
* [`classes`](./Setting-up-the-config-file#wiki-classes)
|
||||
* [Bring your own items](./Setting-up-the-config-file#bring-your-own-items)
|
||||
* [Slot-specific armor nodes](./Setting-up-the-config-file#slot-specific-armor-nodes)
|
||||
* [Potion effects](./Setting-up-the-config-file#potion-effects)
|
||||
* [Price](./Setting-up-the-config-file#price)
|
||||
* [Unbreakable items](./Setting-up-the-config-file#wiki-unbreakable-weaponsarmor)
|
||||
* [Per-class permissions](./Setting-up-the-config-file#wiki-per-class-permissions)
|
||||
@ -23,31 +24,31 @@ The config-file, `plugins/MobArena/config.yml`, consists of 3 sections: `global-
|
||||
|
||||
[...]
|
||||
global-settings:
|
||||
update-notification: true
|
||||
enabled: true
|
||||
allowed-commands: /list
|
||||
prefix: '&a[MobArena] '
|
||||
update-notification: true
|
||||
enabled: true
|
||||
allowed-commands: /list
|
||||
prefix: '&a[MobArena] '
|
||||
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
|
||||
[...]
|
||||
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
|
||||
[...]
|
||||
arenas:
|
||||
default:
|
||||
settings:
|
||||
prefix: ''
|
||||
world: Tundra
|
||||
enabled: true
|
||||
protect: true
|
||||
clear-wave-before-next: false
|
||||
[...]
|
||||
waves:
|
||||
[...]
|
||||
rewards:
|
||||
[...]
|
||||
default:
|
||||
settings:
|
||||
prefix: ''
|
||||
world: Tundra
|
||||
enabled: true
|
||||
protect: true
|
||||
clear-wave-before-next: false
|
||||
[...]
|
||||
waves:
|
||||
[...]
|
||||
rewards:
|
||||
[...]
|
||||
|
||||
Note about notation: `[true|false]` means the setting must be "true or false", either or. `<time>` means the setting must be an amount of time (in seconds or server ticks), always a whole number, and always `0` or greater. `<amount>` is similar to time.
|
||||
|
||||
@ -64,31 +65,33 @@ 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 slot-specific armor nodes and optional nodes `price`, `permissions`, `lobby-permissions`, `unbreakable-weapons`, and `unbreakable-armor`.
|
||||
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 slot-specific armor nodes and optional nodes `effects`, `price`, `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 and Reward Syntax]]-page and fully understand it before you attempt to modify the config file!
|
||||
|
||||
classes:
|
||||
Archer:
|
||||
items: wood_sword, bow, arrow:128, grilled_pork
|
||||
armor: 298,299,300,301
|
||||
permissions:
|
||||
- EffectiveArrows.use.*
|
||||
- -mobarena.use.leave
|
||||
Tank:
|
||||
items: iron_sword
|
||||
armor: 310,311,312,313
|
||||
offhand: shield
|
||||
Knight:
|
||||
items: '276'
|
||||
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
|
||||
price: $5
|
||||
Archer:
|
||||
items: wood_sword, bow, arrow:128, grilled_pork
|
||||
armor: 298,299,300,301
|
||||
effects: speed
|
||||
permissions:
|
||||
- EffectiveArrows.use.*
|
||||
- -mobarena.use.leave
|
||||
Tank:
|
||||
items: iron_sword
|
||||
armor: 310,311,312,313
|
||||
offhand: shield
|
||||
effects: slow
|
||||
Knight:
|
||||
items: '276'
|
||||
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
|
||||
price: $5
|
||||
|
||||
### Bring your own items
|
||||
|
||||
@ -100,6 +103,10 @@ For a smooth, own-items-only experience, ditch the signs and set the per-arena s
|
||||
|
||||
If you want to use off-hand items, or if you just want to be explicit about which items go where in the armor slots, use the optional slot-specific armor nodes: `offhand`, `helmet`, `chestplate`, `leggings`, `boots`. In the example above, the **Tank** class gets a shield in its off-hand slot.
|
||||
|
||||
### 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".
|
||||
|
||||
### Price
|
||||
|
||||
The optional `price` node can be used to give classes a per-session price. When a player tries to pick a class that has a price, they will only be able to if they can afford it. The money is withdrawn when the arena starts, i.e. picking different priced classes in succession will not (necessarily) result in empty player wallets. In the example above, the **Crusader** class costs `$5`.
|
||||
@ -109,11 +116,11 @@ The optional `price` node can be used to give classes a per-session price. When
|
||||
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>
|
||||
classes:
|
||||
FrailTank:
|
||||
items: diamond_sword
|
||||
armor: 310,311,312,313
|
||||
<font color="blue">unbreakable-weapons: false</font>
|
||||
<font color="blue">unbreakable-armor: false</font>
|
||||
FrailTank:
|
||||
items: diamond_sword
|
||||
armor: 310,311,312,313
|
||||
<font color="blue">unbreakable-weapons: false</font>
|
||||
<font color="blue">unbreakable-armor: false</font>
|
||||
</pre>
|
||||
|
||||
### Per-class permissions
|
||||
@ -121,22 +128,22 @@ classes:
|
||||
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).
|
||||
<pre>
|
||||
classes:
|
||||
Archer:
|
||||
items: wood_sword, bow, arrow:128, grilled_pork
|
||||
armor: 298,299,300,301
|
||||
<font color="blue">permissions:</font>
|
||||
<font color="blue">- EffectiveArrows.use.*</font>
|
||||
<font color="blue">- -mobarena.use.leave</font>
|
||||
Archer:
|
||||
items: wood_sword, bow, arrow:128, grilled_pork
|
||||
armor: 298,299,300,301
|
||||
<font color="blue">permissions:</font>
|
||||
<font color="blue">- EffectiveArrows.use.*</font>
|
||||
<font color="blue">- -mobarena.use.leave</font>
|
||||
</pre>
|
||||
|
||||
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:
|
||||
items: ''
|
||||
armor: ''
|
||||
<font color="blue">lobby-permissions:</font>
|
||||
<font color="blue">- shop.buy</font>
|
||||
Basic:
|
||||
items: ''
|
||||
armor: ''
|
||||
<font color="blue">lobby-permissions:</font>
|
||||
<font color="blue">- shop.buy</font>
|
||||
</pre>
|
||||
|
||||
### Pet classes
|
||||
@ -144,9 +151,9 @@ 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.
|
||||
<pre>
|
||||
classes:
|
||||
Wolf Master:
|
||||
items: stone_sword, grilled_pork, <font color="blue">bone:2</font>
|
||||
armor: 298,299,300,301
|
||||
Wolf Master:
|
||||
items: stone_sword, grilled_pork, <font color="blue">bone:2</font>
|
||||
armor: 298,299,300,301
|
||||
</pre>
|
||||
|
||||
### Mounts
|
||||
@ -166,9 +173,9 @@ Note that only normal horses can have barding.
|
||||
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>
|
||||
classes:
|
||||
Crusader:
|
||||
items: iron_sword, <font color="blue">hay_block:17</font>
|
||||
armor: 302,303,304,305
|
||||
Crusader:
|
||||
items: iron_sword, <font color="blue">hay_block:17</font>
|
||||
armor: 302,303,304,305
|
||||
</pre>
|
||||
|
||||
## arenas
|
||||
@ -206,13 +213,13 @@ The settings-branch is quite extensive, and besides the `world`-node, it is basi
|
||||
* `final-wave: <number>` - The number of the final wave before the arena is force ended. This is useful if you want to set a cap on how many waves an arena will have.
|
||||
* `monster-limit: <amount>` - The maximum amount of monsters MobArena is allowed to spawn for this arena. The next wave, if any, will not spawn until there is room for more monsters.
|
||||
* `monster-exp: [true|false]` - If true, monsters will drop experience orbs. This is useful if you wish to give players the ability to spend the gathered experience on enchants or something else (using different plugins) during the session.
|
||||
* `keep-exp: [true|false]` - If true, players will keep the experience they gather in the arenas after death. This is useful if you want to allow players to level up or gather experience in the arenas. NOTE: If using `display-waves-as-level` or `display-timer-as-level`, set `keep-exp` to false.
|
||||
* `food-regen: [true|false]` - If true, a full food bar will cause players to regenerate health while in the arena. Note that this potentially makes tank-like classes extremely overpowered, since diamond armor (by default) coupled with a full food bar will make a player very hard to kill.
|
||||
* `lock-food-level: [true|false]` - If true, the food bar will be locked for all players in the arena, meaning they will not end up starving, and they will be able to sprint around as they please.
|
||||
* `player-time-in-arena: <time of day>` - When set to anything but world, this setting will freeze the apparent world time for players in the arena to whatever value you set. This is useful for making time-of-day themed arenas (e.g. constant night time for a cemetery, broad daylight for a pirate ship). Valid values are: dawn, sunrise, morning, midday, noon, day, afternoon, evening, sunset, dusk, night, midnight.
|
||||
* `auto-ignite-tnt: [true|false]` - If true, TNT will be automatically ignited when placed. This is useful for preventing Oddjob-like classes from forting.
|
||||
* `auto-start-timer: <time>` - The time (in seconds) before the arena will be force started after the first player has joined the lobby (the default of 0 means deactivated or infinite time). Non-ready players will be removed from the lobby. This setting is useful to prevent ill-minded players from delaying or preventing other players from starting the arena. Note that this feature is incompatible with `min-players`!
|
||||
* `start-delay-timer: <time>` - The time (in seconds) before the arena can be started after the first player has joined the lobby. This setting is useful if you want to give your players a fixed window of time to join the arena after the first player has joined, so they can't just start it off right away. Note that this feature is incompatible with `min-players`!
|
||||
* `boss-health-bar: [boss-bar|title|name|none]` - Shows a boss health bar. If set to `boss-bar` on 1.11+, a boss bar like the one for ender dragons and withers is used. If set to `title`, the Chapters/Titles API is used to show the health as a bar of colored pipe symbols (`||||`) on every hit. If set to `name`, the colored pipe symbols appear as the name of the boss. `none` disables the boss bar.
|
||||
* `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.
|
||||
@ -237,14 +244,14 @@ The waves-branch is broken into `every`- and `after`-branches. The `every`-branc
|
||||
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:
|
||||
every:
|
||||
'3': arrow:4, gold_ingot
|
||||
'10': diamond
|
||||
after:
|
||||
'7': iron_spade, iron_hoe, iron_axe, iron_pickaxe
|
||||
'19': diamond_sword
|
||||
'20': $200
|
||||
waves:
|
||||
every:
|
||||
'3': arrow:4, gold_ingot
|
||||
'10': diamond
|
||||
after:
|
||||
'7': iron_spade, iron_hoe, iron_axe, iron_pickaxe
|
||||
'19': diamond_sword
|
||||
'20': $200
|
||||
|
||||
**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.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user