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

Reorder arena settings to match settings.yml. 

For consistency.
Andreas Troelsen 2022-07-27 12:51:49 +02:00
parent 35b34fcf25
commit ff4b2bb077
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -227,6 +227,7 @@ The settings-branch is quite extensive, and besides the `world`-node, it is basi
* `min-players: <amount>` - Gives a lower limit on how many players are required to start the arena. The default of `0` is the same as `1`, which means 1 or more players may start the arena. Note that this feature is incompatible with `auto-start-timer` and `start-delay-timer`! * `min-players: <amount>` - Gives a lower limit on how many players are required to start the arena. The default of `0` is the same as `1`, which means 1 or more players may start the arena. Note that this feature is incompatible with `auto-start-timer` and `start-delay-timer`!
* `max-players: <amount>` - Gives an upper limit on how many players may join the arena. The default of `0` means no limit. * `max-players: <amount>` - Gives an upper limit on how many players may join the arena. The default of `0` means no limit.
* `max-join-distance: <distance>` - The maximum distance (in blocks) from which players can join or spectate the arena. If 0 (default), there is no limit, and players can join from any world. Note that the distance is calculated from every corner of the arena region, and that players not in the arena world won't be able to join or spectate. * `max-join-distance: <distance>` - The maximum distance (in blocks) from which players can join or spectate the arena. If 0 (default), there is no limit, and players can join from any world. Note that the distance is calculated from every corner of the arena region, and that players not in the arena world won't be able to join or spectate.
* `join-interrupt-timer: <time>` - Delay (in seconds) between typing a join/spec command and the command actually executing. If a player moves or takes damage during this delay, the command is interrupted, and the player will not join/spec the given arena. This should help prevent exploits on PvP servers.
* `first-wave-delay: <time>` - The time (in seconds) before the first wave of monsters upon arena start. * `first-wave-delay: <time>` - The time (in seconds) before the first wave of monsters upon arena start.
* `next-wave-delay: <time>` - The time (in seconds) before the next wave of monsters spawns. Note that if `wave-interval: 20` and `next-wave-delay: 5`, there will always be at least 25 seconds between each wave. * `next-wave-delay: <time>` - The time (in seconds) before the next wave of monsters spawns. Note that if `wave-interval: 20` and `next-wave-delay: 5`, there will always be at least 25 seconds between each wave.
* `wave-interval: <time>` - The time (in seconds) between each new wave of monsters. If clear-wave-before-next: true, this setting will be ignored. * `wave-interval: <time>` - The time (in seconds) between each new wave of monsters. If clear-wave-before-next: true, this setting will be ignored.
@ -237,20 +238,19 @@ The settings-branch is quite extensive, and besides the `world`-node, it is basi
* `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. * `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. * `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-ignite-tnt: [true|false]` - If true, TNT will be automatically ignited when placed. This is useful for preventing Oddjob-like classes from forting.
* `join-interrupt-timer: <time>` - Delay (in seconds) between typing a join/spec command and the command actually executing. If a player moves or takes damage during this delay, the command is interrupted, and the player will not join/spec the given arena. This should help prevent exploits on PvP servers.
* `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`! * `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`! * `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. * `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-class-chests: [true|false]` - When set to true, MobArena will try to use [[Class Chests]] in this arena when available. Otherwise, it will only use the class configuration from the config-file. * `use-class-chests: [true|false]` - When set to true, MobArena will try to use [[Class Chests]] in this arena when available. Otherwise, it will only use the class configuration from the config-file.
* `arena-warp-offset: <radius>` - A radius (in blocks) around the arena warp in which players can spawn. If set to a value greater than 0, MobArena will randomize the exact arena warp location for each player. This can help prevent suffocation damage when many players join an arena together. * `arena-warp-offset: <radius>` - A radius (in blocks) around the arena warp in which players can spawn. If set to a value greater than 0, MobArena will randomize the exact arena warp location for each player. This can help prevent suffocation damage when many players join an arena together.
* `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!
* `use-scoreboards: [true|false]` - Whether to use scoreboards in MobArena or not. * `use-scoreboards: [true|false]` - Whether to use scoreboards in MobArena or not.
* `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. * `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.
* `announcer-type: [title|chat]` - Announce arena messages such as wave spawns and player deaths either as titles or in the chat window. * `announcer-type: [title|chat]` - Announce arena messages such as wave spawns and player deaths either as titles or in the chat window.
* `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. * `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.
* `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.
* `show-death-messages: [true|false]` - When set to true, MobArena will announce death messages. When set to false, death messages for arena players are disabled. * `show-death-messages: [true|false]` - When set to true, MobArena will announce death messages. When set to false, death messages for arena players are disabled.