Siege War User Guide - TownyAdvanced/SiegeWar GitHub Wiki
ℹ️ Overview
🔥 SiegeWar adds a war system to Towny.
⚔️ In SiegeWar, wars are decided by Sieges:
Each siege is a "King Of The Hill" battle, which takes place on the border of a town.
Each siege has a maximum 7 hours of fight time, spread over the course of a weekend.
🤼 Each siege has 2 opposing teams:
Attackers: An attacking nation + its allies.
Defenders: A defending town + its nation + its allies.
🌍 Geopolitical Results:
If the attackers win, they can Plunder the town.
If the attackers win, they can Capture the town and add it to their nation.
🛡️ Assign Military Ranks
👉 Before players can participate in sieges, kings/mayors must assign military ranks.
💂 Nation Military Ranks:
Private, Sergeant, Lieutenant, Captain, Major, Colonel: Can gain Battle Points.
General: As above, plus can assign nation military ranks, start/abandon sieges, and plunder/capture.
💂 Town Military Ranks:
Guard: Can gain battle points.
🔥 Start Siege
⛳ On Thursday, as a nation king or general, place a non-white banner in the wilderness near a town:
This is the Siege Banner.
This action will start a new siege at the town.
If your SiegeWar config.yml has assemblies_enabled: true then this will being a Siege Assembly before the Siege can start.
Players must score a number of points within an amount of time in order to "win" the Siege Assembly. Siege Assemblies were added in order to prevent friendly nations from creating mock Sieges in order to maintain Siege Immunity.
Each nation can have a maximum of 3 offensive sieges at any one time.
💰 The nation deposits $20/plot into a War Chest:
This money will be automatically recovered later, by the eventual winner of the siege.
🧱 Prepare for Battle
🎪 On Friday, prepare your army and your allies (if you have any) for battle!
⌚ On Saturday, wait for a Battle Session to begin:
Each siege has a maximum duration of 7 Battle Sessions.
There are 7 battle sessions spread over the course of each weekend.
Each battle session lasts 1 hour.
🍏 During each battle sessions, temporary chat restrictions are activated to reduce toxicity:
General Chat, /lc, and /tell are disabled during the Battle Session (and for 10 minutes after).
/tc, /nc, /ac are not affected, so that players can continue to chat with their battlefield team-mates.
☢️ During each Battle Session, PVP protections are disabled in a 300 block radius around the Siege Banner (the Siege Zone).
⚔️ Fight !
⏩ Spawn to the Siege:
When a battle session starts, 2 Battle Commanders are automatically designated for each Siege, 1 for the attackers, 1 for the defenders.
To be designated a Battle Commander, a player must be a King or General, an official siege participant, in the Siege-Zone, and online.
During the battle Session, if your team's battle commander is alive and in the Siege-Zone, run /sw spawn <town>, to teleport to them.
💯 Capture Banner:
As a Official Siege Participant (a military-ranked player on one of the teams), move close to the Siege Banner.
A Banner Capture Session will start.
If you remain close to the Siege Banner for 7 minutes, you will Capture the Banner for your team, and will be added to the Banner Control List.
Your team will automatically get 30 Battle Points each minute for each player on the Banner Control List.
If a team steals battle control from the enemy team, this is a Banner Control Reversal. The reversing team get an x3 boost to their timed-point-generation rate.
💯 Kill Enemy Players:
As a soldier in the Siege-Zone, kill an enemy Official Siege Participant of military rank, for a reward of 150 Battle Points.
When a player dies in a SiegeZone, their equipment does not drop, but degrades by 5%.
🦍 Win Battle:
When the Battle Session ends:
The team with the best Battle Points score is declared the battle-winner.
Both teams get their battle points applied to the Siege Balance.
The Siege Balance is capped on either end, at -20,000 and +20,000.
🏳️ Abandon attack:
As a siege attacker, place an all-white banner in the wilderness near the town to abandon the attack.
🏳️ Surrender defence:
As a siege defender, place an all-white banner in the wilderness near the town to surrender the defence.
🏆 Win Siege
📝 Siege Outcome
After 7 battle sessions have occurred, the Siege Outcome is determined:
Conquest Siege:
Siege Balance more than +4999 (or Town Surrender): Decisive Attacker Victory
Warchest: Attacker
Plunder: Full
Invade: Yes
Siege Balance 0 to +4999: Close Attacker Victory
Warchest: 50/50 split attacker/defender
Plunder: 1/2
Invade: Yes
Siege Balance 0 to -4999: Close Defender Victory
Warchest: 50/50 split attacker/defender
Plunder: No
Invade: No
Siege Balance less than -4999 (or Attacker Abandon): Decisive Defender Victory
Warchest: Defender
Plunder: No
Invade: No
Revolt Siege:
Siege Balance more than +4999 (or Town Surrender): Decisive Attacker Victory
Plunder: Full
Invade: Yes
Demoralization: No
Siege Balance 0 to +4999: Close Attacker Victory
Plunder: 1/2
Invade: Yes
Demoralization: No
Siege Balance 0 to -4999: Close Defender Victory
Plunder: No
Invade: No
Demoralization: No
Siege Balance less than -4999 (or Attacker Abandon): Decisive Defender Victory
Plunder: No
Invade: No
Demoralization: Yes ... attacker gets -1500 Siege Balance to all sieges they start, for 7 days.
🔥 ❌ Siege Immunity After the siege, the town receives Siege Immunity for 7 days. During this time the town cannot be re-attacked.
🧑🌾 ❌ Revolt Immunity After the siege, the town received Revolt Immunity for 3 days. During this time the town cannot revolt.
🎁 Plunder & Invade
💰 Plunder Town:
As king/general whose nation has won a siege, place a chest in the wilderness near the town.
This action will rob the town of $40/plot, and deposit it in the nation bank.
A plundered town cannot fall due to the money loss (it can only go 'bankrupt', preserving the town completely but blocking building/claiming/recruitment).
🚩 Capture Town:
As king/general whose nation has won a siege, place a non-white banner in the wilderness near the town:
This action will capture the town, adding it to the victories nation.
If the capture town was the last town in nation, that nation will be disbanded!
That the former king will receive a Nation Refund of 80% of the new-nation price.
This money can collected using /sw collect
The captured town will be in an Occupied state, and cannot leave the nation using /n leave
Rather, to leave the nation, it must revolt (see next section).
🗽 Escape Occupation
🧑🌾 As the mayor of a town which has been captured, you can free your town via a Revolt Siege:
Place a non-white banner outside the town.
This action will immediately remove the occupation, and will start a Revolt Siege.
If the town wins the Revolt Siege, it remains free from occupation.
If the town loses the Revolt Siege, the occupier can re-invade, and plunder.
⌨️ Player Commands
🛡️ Assign Military Ranks:
Town - /t rank add [player name] [rank] - As a mayor, assign Guard ranks.
Nation - /n rank add [player name] [rank] - As a king, assign any nation military rank e.g. private, sergeant, lieutenant, captain, * ⏩ Spawn to Siege
/sw spawn <besieged town> - Spawn to a siege.
ℹ️ View Information:
Siege - /sw hud [town name] - Toggle a HUD on/off, to monitor the progress of a particular siege.
Town - /t or /t here or /t [town name] - View detailed information about the siege on the town (if any).
Nation - /n [nation name] - View the list of sieges the nation is involved in (if any).
major, colonel, or general. As a general, assign any of these except general.
💸 Pay Soldiers:
/sw nation paysoldiers <amount> - As a king, make a military salary payment to your soldiers. Each soldier receives a share of the money, based on their military rank.
💵 Collect Money:
/sw collect - As a soldier, collect any income due to you from Military Salary or Nation Refunds.
🤑 Set Occupation Tax:
/n set occupationtax <rate> - As a king, set your nation's occupation tax-rate. Generally you don't need to run this command, as your nation will automatically use the highest rate. Once you run this command, your nation's rate will no longer track the server configured maximum.
/n set occupationtax max - As a king, set your nation's occupation tax to track the server configured maximum.
☮️ Make Town Peaceful:
/sw town togglepeaceful - As a mayor, declare your town to be peaceful. The peaceful state will be confirmed in 7 days (2 if the town is new).
Advantages:
Town becomes immune to siege attack.
Town gets a public /t spawn.
Disadvantages:
Town cannot move homeblock.
Residents cannot receive nation-military ranks.
Town becomes vulnerable to being Subverted by nearby nations.
How Subverting Works:
The largest (by num-townblocks), non-sieged, non-peaceful, town within 1,200 blocks of your peaceful town is your Guardian Town
Whichever nation owns that Guardian Town, can instantly subvert and capture your peaceful town, by placing a non-white banner on your town border.
☮️ Make Town Non-Peaceful:
/sw town togglepeaceful - As a mayor, declare your town to be Non-Peaceful. The Non-Peaceful state will be confirmed in 7 days (2 if the town is new).
🔧 Configure Personal Preferences:
/sw preference bossbar on|off - Toggle the bossbars on and off.
/sw preference beacon on|off - Toggle the beacon beam on and off.
⌨️ Admin Commands
Reload the SiegeWar config & language files - /swa reload.
Set siege immunities - /swa siegeimmunity [alltowns/nation/town] ...
Set revolt immunities - /swa revoltimmunity [alltowns/nation/town] ...
End a siege (Siege ends, and winner is decided by current Siege Balance) - /swa siege [town name] end.
Remove a siege (Siege is removed with no winner) - /swa siege [town_name] remove
Set Siege Balance - /swa siege [town name] setbalance [balance].
Set the siege plundered flag - /swa siege[town name] setplundered [true/false].
Set the siege invaded flag - /swa siege [town name] setinvaded [true/false].
Set town occupation - /swa town [town name] setoccupied [true/false].
Set town peacefulness - /swa town [town name] setpeacefulness [true/false].
Give players a few days to prepare before enabling the system.
👇 Moderator Guide
Add the following rules for players:
📜 No surrounding of towns with other towns.
📜 Always put the siege banner at the general height of the town, and where the enemy can, absent your army, reach it without difficulty.
📜 No griefing at the SiegeZone, but small military constructions like walls & small-forts are ok.
Know the basics of the system
Be familiar with the basic features, actions, and commands of the system, as detailed in this user-guide.
🔧 Support
If you find a bug with SiegeWar, log a bug ticket here.
If you have a suggestion for a SiegeWar improvement, log a suggestion ticket here.
If you have a question about SiegeWar, ask in the Towny discord server, on the "Support" channel, here.
ℹ️ NOTE ON SPECIFIC VALUES IN THIS GUIDE
Any specific values on this page (e.g. 30%, 2, 70) are just defaults - Almost all values can be modified in the SiegeWar config.yml file, to suit individual servers.