mirror of
https://github.com/garbagemule/MobArena.git
synced 2025-02-18 05:21:55 +01:00
Updated Setting up the config file (markdown)
parent
3766f2e5dc
commit
0cc8a3d61c
@ -9,7 +9,19 @@
|
||||
* [[Permissions]]
|
||||
* [[FAQ]]
|
||||
|
||||
## The config-file ##
|
||||
**On this page:**
|
||||
* [Overview](./Setting-up-the-config-file#an-overview)
|
||||
* [`global-settings`](./Setting-up-the-config-file#global-settings)
|
||||
* [`classes`](./Setting-up-the-config-file#classes)
|
||||
* [Per-class permissions](./Setting-up-the-config-file#per-class-permissions)
|
||||
* [Pet classes](./Setting-up-the-config-file#pet-classes)
|
||||
* [`arenas`](./Setting-up-the-config-file#arenas)
|
||||
* [`settings`](./Setting-up-the-config-file#settings)
|
||||
* [`waves`](./Setting-up-the-config-file#waves)
|
||||
* [`rewards`](./Setting-up-the-config-file#rewards)
|
||||
* [`coords`](./Setting-up-the-config-file#coords)
|
||||
|
||||
### An Overview
|
||||
|
||||
_Note: When editing the config-file, you **MUST use spaces for indentation**! Using tabs instead of spaces will give you errors!_
|
||||
|
||||
@ -43,7 +55,7 @@ The config-file, `plugins/MobArena/config.yml`, consists of 3 sections: `global-
|
||||
|
||||
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.
|
||||
|
||||
## global-settings ##
|
||||
## global-settings
|
||||
|
||||
The `global-settings` are few, but important. Note that if `enabled: false`, no arenas can be joined, regardless of their individual `enabled` status.
|
||||
|
||||
@ -53,7 +65,7 @@ The `global-settings` are few, but important. Note that if `enabled: false`, no
|
||||
|
||||
I recommended leaving the update notifications on, and disabling commands like `/kill` and `/tp`.
|
||||
|
||||
## classes ##
|
||||
## 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.
|
||||
|
||||
@ -73,18 +85,18 @@ 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
|
||||
|
||||
### Class-based permissions ###
|
||||
### 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).
|
||||
|
||||
### Pet classes ###
|
||||
### Pet classes
|
||||
|
||||
For every bone (Material name: `bone`, data value: `352`) in a class' items-list, 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.
|
||||
|
||||
## arenas ##
|
||||
## 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 ###
|
||||
### 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.
|
||||
|
||||
* `world: <name>` - The name of the world the arena resides in.
|
||||
@ -127,11 +139,11 @@ The settings-branch is quite extensive, and besides the `world`-node, it is basi
|
||||
* `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.
|
||||
|
||||
### waves ###
|
||||
### waves
|
||||
|
||||
Please go to [[setting up the waves]] for more information.
|
||||
|
||||
### rewards ###
|
||||
### 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. You can also specify monetary rewards if you use a major economy plugin (iConomy, BOSEconomy, Essentials Eco) in the notation `$<amount>`.
|
||||
|
||||
@ -153,7 +165,7 @@ In the following example, players will receive either four arrows or a gold bar
|
||||
|
||||
**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.
|
||||
|
||||
### coords ###
|
||||
### coords
|
||||
|
||||
The coords-section does not exist when MobArena first generates the config-file. This is because the coordinates need to be set by the user _in-game_. See the in-game section for more details on how to set everything up. The coords-section consists of five key points, and an arbitrary amount of spawnpoints:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user