Upstream/MobArena
1
0
Fork 0
mirror of https://github.com/garbagemule/MobArena.git synced 2024-11-29 06:05:15 +01:00
Code Issues Projects Releases Wiki Activity

Updated Setting up the config file (markdown)

garbagemule 2017-03-11 15:05:09 +01:00
parent 3af923a8c0
commit 1d906d34d2
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -26,6 +26,7 @@ The config-file, `plugins/MobArena/config.yml`, consists of 3 sections: `global-
update-notification: true update-notification: true
enabled: true enabled: true
allowed-commands: /list allowed-commands: /list
prefix: '&a[MobArena] '
classes: classes:
Knight: Knight:
items: diamond_sword, grilled_pork:2 items: diamond_sword, grilled_pork:2
@ -37,6 +38,7 @@ The config-file, `plugins/MobArena/config.yml`, consists of 3 sections: `global-
arenas: arenas:
default: default:
settings: settings:
prefix: ''
world: Tundra world: Tundra
enabled: true enabled: true
protect: true protect: true
@ -56,6 +58,7 @@ The `global-settings` are few, but important. Note that if `enabled: false`, no
* `enabled: [true|false]` - This determines if MobArena is enabled or not. If set to `false`, players will not be able to join any arenas at all, regardless of what the arenas' individual statuses are. * `enabled: [true|false]` - This determines if MobArena is enabled or not. If set to `false`, players will not be able to join any arenas at all, regardless of what the arenas' individual statuses are.
* `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. * `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`. * `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.
I recommended leaving the update notifications on, and disabling commands like `/kill` and `/tp`. I recommended leaving the update notifications on, and disabling commands like `/kill` and `/tp`.
@ -174,6 +177,7 @@ This section is by far the largest, and it is divided into several smaller branc
### 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. 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.
* `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. * `world: <name>` - The name of the world the arena resides in.
* `enabled: [true|false]` - If false, players cannot join the arena. * `enabled: [true|false]` - If false, players cannot join the arena.
* `protect: [true|false]` - If false, the arena will not be protected from explosions and players breaking the blocks. * `protect: [true|false]` - If false, the arena will not be protected from explosions and players breaking the blocks.