Suggestion: SiegeWar TP

[GoodrichDev]

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

• It is often difficult for players to find an easy and reliable way to go to a siege zone.
• Players often have to make outposts to go to a siege zone, or have to temporarily give up their nation spawn to set it to somewhere in the siege zone. This hurts economic activity because it is sacrificed for pvp, which not everyone may want to participate in.
• This leads to strange workaround solutions such as nations in the server creating "puppet nations" that are only used to set siege war spawns

Describe the solution you'd like
A clear and concise description of what you want to happen.

• SiegeWar TP that can be set by players to allow for both sides to arrive at the siege zone quickly and without having to cross through wilderness and risk losing items.

• SiegeWar TP would have limitations to ensure it is only used for sieges:

• Can only be set in a location that is within the siege zone and must within claims of either the attacking town or the defending town (Each side gets to set up their own teleport)

• Can only be teleported to during an active battle session and if the siege it corresponds to is still active.

• Only the general(s) or the nation leader have the permission to set this teleport. They will be allowed to set the teleport in the attacking or defending town even if they are not a part of that town. ( A new permission node will need to be created for this purpose and allocated to the appropriate ranks within townyperms.yml )

• Optional, configurable ability to attach a cost to the creation of the teleport and to configure a cost per teleport that is charged to the nation attacking or defending, and be able to adjust the cost separately for attacking nation and defending nation. (config node)

• Run a check that verifies which side the teleporting player is allied to and based on that result, teleports the player to the appropriate side. The player must be directly allied to only one side of the siege. If they are allied to both sides or allied to neither side, the TP will be denied.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

• SiegeWar battle commander feature could be used, but relying on a teleport to another player can be inherently unreliable, and it can cause tension and toxicity among the team if a single person must be relied on for the transport of all players to the siege zone.

Additional context
Add any other context or screenshots about the feature request here.

• Storage: Teleports could be stored in a YML file. Each active siege is stored in the file upon creation.
• Add a check that only allows players to set a siege TP in the overworld. Nether or end won't be planned on being supported.
• Set the 'configured' value to false upon creation. This will force the player to first set a TP before it can be used. Avoids having to set up weird placeholder values. TP will be denied if 'configured' is false or null.
• After a siege has been set has over, delete the siege section from the file.
• Storage idea: First, set up the file read/write to work correctly and check values from the file every teleport. Then, once this works reliably, introduce a caching system to cache frequently used teleports into memory for performance.

Example:

teleports.yml
constantinople:
attacker:
configured: true
x: 100
y: 63
z: 100
defender:
configured: true
x: 400
y: 63
z: 100

hokkaido:
attacker:
configured: false
x:
y:
z:
defender:
configured: true
x: 100
y: 63
z: 100

[p3sto]

Not a player, just seen you around in the Towny discord and was interested in your rework.

An idea I had for this was to borrow the idea of SiegeCamps. Essentially, placing down a soul campfire would make a WarCamp. Allies of the player who placed it down could then teleport to the campfire during battlezones (or whenever appropriate). WarCamps would be tied to the nearest siege and be auto-removed once the siege has ended.

Possible issues and solutions:

1. Players can abuse the system by placing camps too close to the banner
   Solution: Add a min/max distance requirement from the siege banner

2. Many players can add their own war camp
   Solution: Limit war camps to specific nation roles or limit the amount of active camps per-side

3. Enemies of a one side will camp the spawn point
   Solution: Limit plot permissions inside of camps and prevent expansion or maybe allow more than one camp per side for more strategy like diversions and other interesting tactics.

[GoodrichDev]

WarCamps

About to have Medieval Battle Camps...

[Bustun01]

Per @GoodrichDev direction, we will be storing teleport data using Towny metadata instead of using a .yml file. This is so that the data can more easily be accessed by other plugins and can be easily exported to .json.

[Bustun01]

Progress update:
Still working through the initial implementation.

• Metadata handling permissions checks
• /siegetp setspawn preconditions (must be in siegezone, in your side's claims, have permissions, be a member of the defending town/nation or attacking nation, etc.)
• TeleportTask that will be passed to the appropriate folia schedulers

If anyone is wanting to review and/or collaborate, let me know so I can push commits to branch

[Bustun01]

Completed. This has been tested to be working in development server.
If any further bugs arise, open an issue in SiegeCore