User:OneDarkWolfy/sandbox: Difference between revisions

mNo edit summary
mNo edit summary
Line 1: Line 1:
__TOC__


'''Towny''' is a land protection and management plugin that allows players to create towns, form nations, claim territory, and collaborate with others. It introduces diplomacy, taxation, territory control, and active upkeep.
==Managing the Town==
====Town Rank====
Within a town, players may be assigned specific ranks that determine their responsibilities and access to various town interactions. While all residents have access to basic commands, higher ranks allow for more administrative interaction.
====Default Resident Permissions====
All town members automatically have access to:
* Deposit money: <code>/t deposit (amount)</code>
* Town Spawn: <code>/t spawn</code>
* Town Lists: <code>/t list</code>
* Town Reclaim: <code>/t reclaim</code>
* Leaving Town: <code>/t leave</code>


'''Tip:''' To view chunk borders, press <code>F3 + G</code>.
====Town Rank Overview====
 
'''Wilderness'''<br>
By default, all land is considered ''Wilderness'':
* Anyone can build, break, and interact
* PVP is always enabled
* Nothing is protected — be cautious!
 
==Towny Basics==
===What is a Town?===
A '''Town''' is a player created community that can claim chunks to protect them from other players. The player who creates the town becomes the Mayor. The Mayor can claim Wilderness chunks to turn them into protected town land.
{| class="wikitable"
{| class="wikitable"
! Role !! Description
! Rank            !! Description !! Example Permissions
|-
|-
| Mayor || Founder and administrator of the town
| '''Mayor'''      || The town’s leader with complete authority. Can manage claims, finances, ranks, and town settings. Always tax-exempt. || <code>/t set taxes</code><br /><code>/t claim</code>
|-
|-
| Resident || Player who joins a town
|'''Co-Mayor''' || Shares all mayoral powers, but cannot delete the town or assign a new Mayor. Tax-exempt. || Manages residents, finances, plots, and invites.<br /><code>/t claim</code>, <code>/t withdraw</code>
|}
'''Claimed land protects:'''
* Against non-residents building or breaking blocks
* Access to chests, doors, and containers
 
====Creating a Town====
To create a town, you must have 300⌾ in your personal bank, then head to spawn, <code>/spawn</code>.<br>
1. Hire an '''Architect''' from '''Lord Crowley''' at spawn.
<div style="border: 1px solid #c6c6c6; display: inline-block; padding: 5px;">
[[File:Stewards for Hire.png|450px]]
</div>
2. Lead the Architect to your desired location, it must be 128 blocks (8 chunks) away from another town.<br>
3. Right-click the Architect and select "Create Town".<br>
<div style="border: 1px solid #c6c6c6; display: inline-block; padding: 5px;">
[[File:Spawn Architect GUI.png|450px]]
</div>
4. The chunk you stand in becomes the '''homeblock''', and your exact position becomes the '''town spawn'''.<br>
 
'''To change town spawn or homeblock:'''<br>
* Set spawn: <code>/t set spawn</code>
* Set homeblock: <code>/t set homeblock</code>
'''To rename, invite, leave, kick commands:
* Rename town: <code>/t set name [new name]</code>
* Invite: <code>/t add [username]</code>
* Leave: <code>/t leave</code>
* Kick: <code>/t kick [username]</code>
 
====Town Bank====
Each town has its own '''Town Bank''' used to manage the town's economy and pay for land, stewards, and nation taxes. Anyone can deposit money into the bank, even non-residents.<br>
'''Bank commands:'''
* Deposit: <code>/t deposit [amount] [town name]</code>
* Withdraw: <code>/t withdraw [amount]</code>
* View history: <code>/t bankhistory</code>
'''Withdraw permissions:'''
* Mayor
* Co-Mayor
* Deputy Mayor
* Steward
* Finance Manager
 
===ActiveUpkeep System===
ActiveUpkeep replaces the default Towny upkeep. Instead of requiring money to sustain your town, players must now remain active to keep it thriving. A variety of in-game actions contribute to a player’s individual activity score.  
 
====Activity Decay====
Every player has an activity score that fluctuates based on their daily engagement, players must reach the activity threshold to be considered an active member of a town.<br>
 
The maximum score you can achieve far exceeds the threshold, allowing you to “bank” activity for a period of time. However your score will decay over time and will decrease faster the longer you haven’t played but slower if you have been consistently active.
 
====Inactivity Effects====
Towns are sustained through the activity of their residents. If all members of a town become inactive, the town will begin an inactivity countdown.
'''Inactivity Progress:'''
# When a town has no active residents, it is marked as '''inactive'''.
# If the town remains inactive for '''4 consecutive days''', it will be automatically removed from its nation.
# This serves as a warning sign that the town is no longer active.
# If the town remains inactive for an additional '''3 days''', bringing the total to '''7 consecutive days''', it will enter into '''ruin'''.
 
'''Check activity:'''
Players can check their own or others' activity using: <code>/activity</code> or <code>/activity [username]</code>
 
===Making Claims===
* Stand in a Wilderness chunk near your town
* Type <code>/t claim</code>
* After 3–4 claims, new claims must border 3 existing town claims
====Maximum Claims====
A town can have a maximum of '''690 total claims'''. The claim bonus from active members caps at 500, which is fully reached once 14 residents are active. Any additional active residents beyond that point won’t increase the town's claim capacity further, however you can still add them into your town.
The table below summarizes the sources that contribute to the total limit:
{| class="wikitable"
! Source                    !! Claim Cap !! Notes
|-
| Base Claims              || 10          || Default for all newly created towns
|-
| Bonus Claims (Residents)  || 500          || +35 claims per active resident, only active players count
|-
|-
| Nation Bonus              || 100          || Granted for being in a full-sized nation
| '''Deputy Mayor''' || A trusted manager with broad authority, but restricted from critical changes like deletion or renaming. Tax-exempt. || <code>/t kick</code><br /><code>/t set name</code>
|-
|-
| Housing Steward Bonus    || 80          || Requires Level 3 Housing Steward
| '''Steward'''    || A general overseer with a blend of building, financial, and invitation rights. || <code>/t withdraw</code><br /><code>/t set plotprice</code>
|-
|-
|}
| '''Land Manager''' || Manages land claims and plot access across town plots. || <code>/t claim</code><br /><code>/plot set perm</code>
====Claim Cost Table====
{| class="wikitable"
! Claim !! Type !! Individual Cost !! Cumulative Cost
|-
|-
| 10 || Base || 472⌾ || 3,188⌾
| '''Finance Manager''' || Controls town taxes, plot pricing, and bank access. || <code>/t set taxes</code><br /><code>/t withdraw</code>
|-
|-
| 50 || Bonus || 221⌾ || 10,519⌾
| '''Culture Manager''' || Handles town naming and ceremonial elements. || <code>/t set name</code><br /><code>/t toggle</code>
|-
|-
| 100 || Bonus || 364⌾ || 24,915⌾
| '''Sheriff'''    || Enforces town law through jail and outlaw systems. || <code>/t jail</code><br /><code>/t outlaw</code>
|-
|-
| 150 || Bonus || 598⌾ || 48,590⌾
| '''Builder'''    || Granted general build rights on town-owned land. || <code>/plot set perm build on</code>
|-
|-
| 200 || Bonus || 984⌾ || 87,527⌾
| '''Assistant'''  || Helps with resident management and minor plot settings. || <code>/t invite</code><br /><code>/plot set</code>
|-
|-
| 250 || Bonus || 1,618⌾ || 151,568⌾
| '''Tax-Exempt''' || Assigned to residents who are exempt from town tax. || <code>/t tax_exempt</code>
|-
| 300 || Bonus || 2,661⌾ || 256,894⌾
|-
| 350 || Bonus || 4,376⌾ || 430,116⌾
|-
| 400 || Bonus || 7,196⌾ || 715,000⌾
|-
| 450 || Bonus || 11,835⌾ || 1,183,527⌾
|-
| 500 || Bonus || 19,464⌾ || 1,954,091⌾
|-
| 550 || Bonus || 25,000⌾ || 3,134,328⌾
|-
| 600 || Bonus || 25,000⌾ || 4,384,328⌾
|-
| 650 || Bonus || 25,000⌾ || 5,634,328⌾
|-
| 690 || Bonus || 25,000⌾ || 6,634,328⌾
|}
|}
====Claim Cost Calulator====
<div style="border: 2px solid var(--background-color-neutral); padding: 10px; border-radius: 6px;">
'''Current Claim Summary''' <br>
• '''Existing claims:''' {{calculator|id=original|type=number|min=10|max=690|default=10|formula=startAmount}} 
• {{calculator|id=startAmount|type=range|min=10|max=690|default=10|style="margin-top:8px;"|formula=original}}
<hr style="margin: 10px 0;">
'''Bonus Claims to Purchase''' <br>
• '''Bonus claims:''' {{calculator|id=buy|type=number|min=0|default=0|formula=ifgreater(buyAmount,690-original,690-original,buyAmount)}} 
• {{calculator|id=buyAmount|type=range|min=0|max=680|default=0|style="margin-top:8px;"|formula=buy}} 
• (You can buy up to {{calculator|id=available|type=plain|min=0|default=680|formula=690-original}} bonus claims)
<hr style="margin: 10px 0;">
'''Cost Breakdown'''<br>
• '''Cost for {{calculator|id=newPlain|type=plain|min=0|default=0|formula=buy}} bonus claims:''' 
{{calculator|id=new|type=plain|default=0|formula=round(2716+150*((pow(1.01,min(515,original+buy-10))-1)/0.01)+ifgreater(515,buy+original-10,0,25000*(original+buy-10-515)))-round(2716+150*((pow(1.01,min(515,original+-10))-1)/0.01)+ifgreater(515,original-10,0,25000*(original-10-515)))}} ◎ <br>
• '''Total cost for {{calculator|id=totalPlain|type=plain|min=0|default=10|formula=original+buy}} claims:''' 
{{calculator|id=total|type=plain|default=2716|formula=round(2716+150*((pow(1.01,min(515,original+buy-10))-1)/0.01)+ifgreater(515,buy+original-10,0,25000*(original+buy-10-515)))}} ◎
</div>


===Resident Plots===
===Town Board===
Within a town, individual chunks can be assigned to residents as their personal plots. These are known as '''resident plots''' and can be owned by any member of the town, including the Mayor. Once owned, the resident has full control over how the land is used, within the rules set by the town.
The '''town board''' is a customizable message set by town mayor. It serves as a public announcement for both residents and visitors.
 
To create or update your town board message, use the command: <code>/t set board (your message)</code>
Once set, the board will be visible in the following places:
* Residents:  Displayed when residents join the server and in <code>/t</code>.
* Visitors: Shown in the town’s info screen via <code>/t (town name)</code>.
 
===Closed/Open Town===
By default, all towns are set to closed status, meaning they are invite-only. Players can only join a closed town if they are invited by a town official, typically a Mayor, Co-Mayor, Deputy Mayor, or Assistant.
<br>
If a town is set to open, any player can freely join using the command, <code>/t join (town name)</code>.
Open towns are marked with <code>(Open)</code> next to their name in the town list displayed via: <code>/t list</code>
<br>
<br>
Residents may own multiple plots, and they can use them for personal builds, shops, housing, etc.
Mayor, Co-mayor, Deputy Mayor can toggle their town’s status between open and closed at any time with: <code>/t toggle open</code>
 
====Identifying Public Towns====
Public towns are marked with <code>(Public)</code> in their town info screen (e.g., <code>/t</code> or <code>/t [town name]</code>). Additionally, the homeblock’s chunk coordinates are shown for public towns.
==== Changing Public Status====
To toggle between public and private status, use: <code>/t toggle public</code>
 
===Town Taxes===
Towns can impose multiple types of taxes to sustain steward upkeep, encourage participation, and manage land ownership. Taxes apply daily and can be adjusted by town Mayor, Co-Mayor, Deputy Mayor, Steward, Financial Manager.
====Resident Tax====
This is a general tax charged to all town members.
* Set using: <code>/t set taxes (amount or percentage)</code>
* Toggle flat vs. percentage mode: <code>/t toggle taxpercent</code>
'''Flat Tax'''<br>
* Charges a fixed amount from each resident's balance daily.
** If a resident cannot pay, they are automatically removed from the town.
'''Percentage Tax'''<br>
* Charges a percentage of each resident’s current balance.
** Residents unable to pay are also removed.
* Use <code>/t set taxpercentcap (amount)</code> to set a maximum tax limit.
====Resident Plot Tax====
A per-plot tax charged to residents who own plots within the town.
* Set using: <code>/t set plottax (amount)</code>
** If a resident cannot pay, ownership of the affected plots is revoked.
** Unpaid plots are automatically listed for sale.
====Shop Plot Tax====
Tax applied specifically to plots containing shop signs or shops.
* Set using: <code>/t set shoptax (amount)</code>
** Failure to pay results in loss of the shop plot.
** Any shop signs are removed when the plot is lost.
====Embassy Plot Tax====
A tax applied to non-residents who own embassy plots in your town.
* Set using: <code>/t set embassytax (amount)</code>
** If unpaid, the embassy plot is removed from the owner and returned to town control.
====Tax Stacking====
Taxes are additive. Below are common stacking examples:
* A resident who owns a shop plot pays: Resident Tax + Plot Tax + Shop Plot Tax
* A non-resident who owns an embassy plot pays: Plot Tax + Embassy Plot Tax
 
===Titles and Surnames===
In both towns and nations, players with the appropriate permissions can assign custom titles and surnames to residents. These appear in chat and consist of:
*A title (prefix) displayed before the player’s name
*A surname (suffix) displayed after the player’s name


====Claiming a Plot====
Both titles and surnames may be up to 15 characters long.
To claim a plot, it must first be listed '''for sale''' by an authorized official.


'''Authorized officials include:'''
====Assigning Titles====
* Mayor
- Town Titles
* Co-Mayor
Granted by: Mayor, Co-Mayor or Deputy Mayor
* Deputy Mayor
Command:
* Land Manager
<code>/t set title (player) (title)</code>
- Nation Titles
Granted by: Nation Leader or Co-Leader
Command: <code>/n set title (player) (title)</code>


'''Steps to claim a plot:'''<br>
====Assigning Surnames====
An authorized official stands on an unclaimed town chunk and types: <code>/plot forsale [price]</code>. A resident (or the Mayor) then stands on the same plot and types: <code>/plot claim</code>. The plot is then transferred to the resident, and its ownership is displayed in the plot info.
- Granted by: Mayor, Co-Mayor, Deputy Mayor
- Command: <code>/t set surname (player) (surname)</code>


'''Note:''' Plots may cost ⌾ to claim. The price is set by the official putting it up for sale, and plots can also be listed for free to allow easy claiming or gifting.
====Removing Titles and Surnames====
- Remove Town Title: <code>/t set title (player)</code>
- Remove Nation Title: <code>/n set title (player)</code>
- Remove Surname: <code>/t set surname (player)</code>


====Unclaiming Plots====
===Transferring Mayorship===
* Remove a plot from sale: <code>/plot notforsale</code>
The current Mayor of a town can choose to step down and pass their leadership role to another trusted resident.
* Unclaim your own plot: <code>/plot unclaim</code>
<br>
Once unclaimed, the plot returns to general town ownership and can be re-listed or reassigned as needed.
===Joining a Nation===
Joining a nation allows a town to participate in broader regional alliances, benefit from claim bonuses, and engage in diplomatic relationships with other towns and nations.


====Requirements to join a nation====
===How to Transfer Mayorship===
* The town must have at least '''3 residents'''.
To assign a new Mayor, use the following command: <code>/t set mayor (player)</code>
* The Mayor must receive an invitation to join a nation
Once the transfer is successful:
* The selected resident becomes the new Mayor with full leadership powers.
* The previous Mayor is automatically demoted to a regular resident and loses all assigned town ranks.


'''Accepting or Denying a Nation Invite'''<br>
Note: Only transfer mayorship if absolutely necessary and only to someone you trust completely. The new Mayor will have full control over the town, including its claims, finances, ranks, and even the ability to delete or rename the town.
If the town has received an invitation from a nation, the Mayor may respond using one of the following commands:
* Accept the invitation: <code>/accept [nation name]</code>
* Deny the invitation: <code>/deny [nation name]</code>


Once accepted, the town becomes an official member of that nation. The town will then gain access to any nation related perks, such as increased claim capacity, shared diplomacy, and protected alliances.
===Deleting a Town===
====Nation Tax====
Deleting a town will cause the town to go into ruin and after 24 hours of being in ruin will be permanent deleted. The following will be deleted when the town gets deleted.
Some nations may charge a daily '''nation tax''' to help sustain the nation’s upkeep or to make money.
* Name and identity
* The tax is automatically withdrawn each day from the '''town bank'''.
* Claimed land
* The tax amount is determined and adjusted by the nation's leader.
* Residents and their roles
* If the town bank lacks sufficient funds to cover the tax, consequences may include automatic removal from the nation.
* Town bank balance
* Steward and infrastructure
**Only the Mayor has the authority to delete the town.
==== How to Delete a Town ====
To delete your town:
* Withdraw funds first. Any money left in the town bank will be permanently lost. Use: <code>/t withdraw (amount)</code>
* Delete the town: <code>/t delete</code>
* Then confirm with: <code>/confirm</code>
After confirmation, the town enters a ruin period, where its former territory can be reclaimed or looted by others.


To check the current tax rate, use either of the following commands: <code>/towny prices</code> or <code>/n</code>
===Town Ruin Period===
When a town falls into ruin, whether due to inactivity or deletion, it enters a 24-hour ruin period. During this time:
* All town Stewards are downgraded to Level 1, except for the Bailiff.
* If the town is not reclaimed within 24 hours, it is permanently deleted, and all data (bank, claims, residents, etc.) is lost.
====Reclaiming a Ruined Town====
Former residents may reclaim a ruined town during the 24-hour window using:
<code>/t reclaim</code>
* Reclaiming costs 500⌾, deducted from the player's personal balance.
* The player who reclaims the town becomes the new Mayor.
* Upon reclaim:
** The town is fully restored under the new leadership.
** A 7-day activity grace period begins.
If the town does not meet the required activity threshold within those 7 days, it will re-enter ruin, and the cycle may repeat.