Configuration Guide
The config.yml has quite a lot in it, so here's a guide to every option you have.
Before you start, it's reccomended you download Notepad++, which makes editing the config easier.
- First Time Plugin Load
- Whether or not this is the first time the plugin has loaded. It is reccomended not to touch this.
Options
- Always Night
- Whether or not it should always be night in the world the game is running in.
- Auto-Start
- Whether or not the game should automatically start when the server starts.
- Auto-Run
- Whether or not the game should automatically run, meaning a vote for the next map will take place after a game ends.
- Auto-Join
- Whether or not players joining the server should automatically be put into the game.
- Save Position on Game Join
- If enabled, players will have their old location saved when they enter the game. When they then leave the game, they will be teleported back to that location.
- Game World
- The world where the game takes place.
- Game Leave World
- The world where a player is teleported to when they leave the game. Overridden if 'Save Position on Game Join' is enabled.
- Game Leave Location
- The location where a player is teleported to when the leave the game. Overridden if 'Save Position on Game Join' is enabled.
- Player Limit
- The maximum number of players who may be in the game at once.
- Save Items
- Whether or not to save a players items when he/she enters the game. These items are returned to the player when they leave.
- Voting Length
- How long, in seconds, a vote for a new map lasts.
- XP Bar Shows Money
- Whether or not the players level shown on the XP bar shows the players money or not. If enabled, this will also disable mob xp drops, and prevent the players level from changing in any way save from gaining or losing money.
- Broadcast To All
- If enabled, all players on the server will have ZArena information broadcasted to them. Else, only players in game will.
- Wave Start Delay
- How long, in seconds, the delay is between waves.
- World Exclusive
- Whether or not the Game World is solely meant to be used for ZArena. If enabled, normal players will be unable to change blocks in the Game World.
- Disable Hunger
- Whether or not hunger (and hunger regeneration) is disabled for players in game.
- Disable Non ZArena Commands In Game
- If enabled, players may only use ZArena commands while in game.
- Disable Joining Game With Inventory
- If enabled, players will be unable to join the game unless their inventory is empty. This is used as a precaution against loss of items, if your server is having a problem with that.
- Enable Killcounter
- Whether or not to enable the built in kill counter.
- Respawn Every X Waves (0 to disable)
- How many waves it takes for a player to spawn back into the game. As is shown in the description, set this to 0 to disable it.
- Shop Sign Header
- The header you put on the first line of signs to define the sign as a ZArena shop sign. This is changeable to prevent plugin incompatibilities.
- Toll Sign Header
- The header you put on the first line of signs to define the sign as a ZArena toll sign. This is changeable to prevent plugin incompatibilities.
- Start Items
- A list of items that players start with when a new game begins.
- Seperate Inventory
- Whether or not players should have a seperate inventory from their normal one while in the game. If set to true, the players inventory will be saved and cleared when they enter the game, and they'll have that inventory restored when they leave.
Stats
- Money on Kill
- The amount of money gained on a kill, by default.
- Money Percent Lost on Death
- The percentage of money you lose when you die. Should be a decimal greater than 0 and less than or equal to 1.
Entities
- Wolf Spawn Chance
- How often wolves spawn on normal waves. Should be a decimal greater than 0 and less than or equal to 1.
- Skeleton Spawn Chance
- How often skeletons spawn on normal waves. Should be a decimal greater than 0 and less than or equal to 1.
- Wolf Wave Chance
- How often wolf waves occur. Should be a decimal greater than 0 and less than or equal to 1.
- Skeleton Wave Chance
- How often skeleton waves occur. Should be a decimal greater than 0 and less than or equal to 1.
- Wolf Spawn Chance During Wolf Wave
- How often wolves spawn on wolf waves. Should be a decimal greater than 0 and less than or equal to 1.
- Skeleton Spawn Chance During Wolf Wave
- How often skeleton spawn on skeleton waves. Should be a decimal greater than 0 and less than or equal to 1.
- Default Entity File Name
- The name of the YAML file for the default entity. E.g., 'zombie.yml'.
- Default Skeleton File Name
- The name of the YAML file for the default skeleton. E.g., 'skeleton.yml'.
- Default Wolf File Name
- The name of the YAML file for the default wolf. E.g., 'wolf.yml'.
- Entity File Name List
- A list of all non-default entities. The names follow the same format as mentioned above.
Zombies
>Health<
- Formula Type [Quadratic|Logistic|Logarithmic]
- Formula type used to determine the health of zombies per wave. Quadratic goes up slowly at first, than speeds up. Logarithmic starts up quickly, than slows down. Logistic starts off quadratic, than turns into a kind of a logarithmic, slowing down at the limit.
- Limit (Only applicaple for Logistic Forumula)
- If using a logistic formula, this is the amount where the health of zombies will begin to stop at.
- Coefficients
- A list of coefficients used in the formula. There are 3. The first one defines how fast the formula moves. The second one increases the health at a constant rate by multiplying it by the wave number. So, if it were wave 4, and the number you put down was 1, than this coefficient would increase the health of zombies by 4. The third coefficient is the health of zombies on wave 1.
>Quantity<
- Formula Type [Quadratic|Logistic|Logarithmic]
- Same definition as above, only used to define quantity of zombies per wave.
- Limit (Only applicaple for Logistic Forumula)
- Same definition as above, only used to define quantity of zombies per wave.
- Coefficients
- Same definition as above, only used to define quantity of zombies per wave.
Donator
See bottom of page for information on how to use this section of the config.
SignCustomItems
See the page on Advanced Signs for information on this section of the config.
Gamemodes
- Default Gamemode File Name
- The file that has information on the default gamemode. E.g., 'normal.yml'.
- Gamemode File Name List
- A list of all other possible gamemodes. Follows the same format as shown above.