Setting Up Sieges

Siege is a mechanic that allow players to control WorldGuard regions

1. Create a file named sieges.yml.
2. Open it in a text editor supporting YAML format, such as Notepad++ or Sublime Text
3. At the root of the file, type sieges: and make a new line.
4. Create nodes for each siege. Minimum 1 siege is required. You can name each node under the sieges root as you like.
5. Under each node, you need to define the following parameters:

Parameter	Type	Description
RegionToControl	String	Defines the name of the region a player will gain control over if he/she wins a siege
SiegeRegion	String	Defines the name of the region where fighting occurs and where the siege flagship must be present in order to win a siege. This should be a different region from the RegionToControl
CraftsToWin	String list	Defines which craft types that are allowed as flagships during a siege
DaysOfWeek	Integer list	Determines the weekdays players will be allowed to siege. 1 = Sunday and 7 = Saturday
DelayBeforeStart	Integer	Determines the delay before the actual siege happens. This allows the attacker to prepare and defenders to arrive
SiegeDuration	Integer	The total length of a siege, including delay before start and the duration of the actual siege
ScheduleStart	Integer	Determines the earliest time of the day in military time when the siege can take place
ScheduleEnd	Integer	Determines the latest time of the day in military time when the siege can take place

In addition to the required parameters above, you can also add these optional parameters under each siege node

Parameter	Type	Default value	Description
CostToSiege	Integer	0	Defines the amount of money to charge players for starting a siege
DoubleCostPerOwnedRegion	false	Boolean	Defines if a player starting a siege should be charged the cost to siege multiplied with the number of already owned regions. Example: if a player owns 3 siegeable regions, CostToSiege will b 3 times higher than if the player never owned a single siegeable region
DailyIncome	Integer	0	Determines how much money the owner(s) of this region will receive per IRL day. If multiple players own the region, the payout will be shared among all owners
SiegeCommandsOnStart	String list	Empty list	List of commands to be executed when a siege starts. Placeholders: %r = siege region, %c = Siege cost
SiegeCommandsOnWin	String list	Empty list	List of commands to be executed when a siege is won. Placeholders: %r = siege region, %c = Siege cost, %l = Siege leaders
SiegeCommandsOnLose	String list	Empty list	List of commands to be executed when a siege is lost. Placeholders: %r = siege region, %c = Siege cost, %l = Siege leaders