Custom Gamemode YAML Files
This tutorial will detail how to create your own custom gamemodes for the plugin using YAML files.
Before you start, it's reccomended you download Notepad++, which makes editing the config easier.
A gamemode YAML file is just like a configuration, only there is a new configuration for each new gamemode. Below are all of the possible things that can be configured, and their default values. You don't have to include any part of the config that you want to leave as the default value.
All Possible Configuration Settings
- Name
- The name of the gamemode. The default value is "Normal".
- Apocalypse
- Whether or not the gamemode is in apocalypse mode. In apocalypse mode, there are no waves, and zombies will just spawn constantly and increasingly quickly. Default value is false.
- Scavenger
- Whether or not the gamemode is in scavenger mode. In scavenger mode, zombies will drop items. Default value is false.
- No Regen
- Whether or not the gamemode is in no regen mode. In no regen mode, players will not regenerate health at the start of each wave. Default value is false.
- Slow Regen
- Whether or not the gamemode is in slow regen mode. In slow regen mode, players will slowly regain health at a constant rate. Default value is false.
- Gamemode Choice Weight
- The weight of this gamemode when a gamemode is being randomly picked. The higher the weight, the more likely it is to be picked. Default value is 1. It's reccomended not to set weight too far away from 1, or the choice of gamemodes will be highly unbalanced.
- Difficulty Modifier
- The higher this is, the more likely it is for more dangerous entities to spawn. Default value is 1.
- Damage Modifier
- Multiply this by the entities default damage to get the damage the entity deals in this gamemode. Default is 1.
- Default Zombie
- The default zombie for this gamemode. This can also be a list, so that you have multiple default zombies. Default value is whatever is the normal default zombie.
- Default Wolf
- Same as above, but for wolves. Default value is whatever is the normal default wolf.
- Default Skeleton
- Same as above, but for skeletons. Default value is whatever is the normal default skeleton.
- Start Items
- A list of items players start with in this gamemode. You CAN use Custom Items here, which are explained in the Advanced Signs tutorial. Default value is an empty list.
- Allowed Entities
- A list of entities allowed to spawn in this gamemode. Use ALL if you want all entities allowed to spawn. Default value is ALL.
- Allowed Items
- Items allowed to be bought in this gamemode. Has the argument of cost modifier. Use ALL if you want to have all items allowed to be bought, use NONE if you want none. Use cost modifier like this (If no cost modifier is defined, default value is 1):
Allowed Items: - Wood Sword 2 - Arrow .75 - Bow 5 - Iron Sword
Example Gamemode YAML File
Name: HellOnEarth ## We don't want such a difficult gamemode occuring too often Gamemode Choice Weight: .5 Health Modifier: 1.5 Zombie Amount Modifier: 1.5 Difficulty Modifier: 2 NoRegen: true ## When a default zombie spawns, there is a 50% chance it will be a fast zombie, and 50% ## chance it will be a strong zombie Default Zombie: - Fast Zombie - Strong Zombie ## The default skeleton will always be a fast skeleton Default Skeleton: Fast Skeleton Default Wolf: Hell Hound ## All items cost double Allowed Items: - ALL 2