Governor icon

Governor -----

An Unofficial Towny Expansion Plugin



Other Plugins by ShermansWorld:
CharacterCards, CustomServerTime, SimpleLockpicking, RaidsPerRegion


index.jpg

Dependencies:
EssentialsX, Towny, Vault

Description:

Governor is an expansion for Towny that gives town leaders additional tools. I plan on adding additional features and am currently taking suggestions so stay tuned and feel free to reach out!

Town/Nation Tax Calls:

Town and Nation tax calls are designed as a more interactive alternative to the towny's build-in tax/upkeep system. Town/Nation leaders (whichever ranks you specify in the config) have the ability to start a tax call. During a tax call every online member will be prompted and have a set amount of time to accept the tax, deny the tax, or abstain from the tax. Players that are too poor to pay the tax are automatically exempt.

Member Perspective:

[​IMG]

Leader or "Governor's" Perspective
[​IMG]

Chain-Of-Command - Claiming Mayorship:
Tired of all the inactive towns on your server? Well this feature seeks to solve this problem with zero staff intervention. If a town mayor is inactive for a set amount of days the town will be marked as inactive. Inactive towns can then be claimed by players depending on what you set in the config. Options include certain town ranks (such as co-mayors), any town member, any nation member or even any player at all! See the config below for more details

Successful Claim Example
[​IMG]

Town/Nation Income Tax [EXPERIMENTAL FEATURE]:

Yet another alternative for taxing town residents and nation members. This feature hooks into essentials in order to detect every time a player's balance increases. This increase in balance or "income" is then taxed at a set rate. Town/Nation leaders have the ability to change this rate, including disabling it. See the config for all of the options with income tax!

Example Using /sell
[​IMG]

Governor has support for the following plugins. (Many will probably work but these have been tested):
- EssentialsX /sell, /pay, various sign shops
- Quickshop player/admin shops
- Chestshop player/admin shops
- JobsReborn earnings from jobs


Note: Income tax amounts are always whole numbers. If the tax comes out to be less than $1, the player will not be charged. This is not a bug, this is simply how town/nation banks work.

Commands:
/governor reload - Reloads the config
/governor taxtown [amount/cancel] - Starts/cancels a town tax call
/governor taxnation [amount/cancel] - Starts/cancels a nation tax call
/governor claim [town] - Claims mayorship of an inactive town
/governor checkmayor [town] - Check how many days a mayor has been offline
/governor townincometax [rate] - Set the town's income tax rate
/governor nationincometax [rate] - Set the nation's income tax rate

/ttax [accept/deny] - Accepts/Denies a town tax call
/ntax [accept/deny] - Accepts/Denies a nation tax call

Permissions:
Governor.reload - Gives access to the reload command

TODO:
- Add support for TheNewEconomy plugin

Code (Text):

# ========================================
# | Governor by ShermansWorld            |
# | An Unofficial Towny Expansion Plugin |
# ========================================

config-version: 3

# =====================================
# |          TAX CALL SETTINGS        |
# =====================================

# Tax calls are an alternative taxing method directed towards online players

TownTax:

  CallTime: 6000
  # How long the tax call will last in ticks
  # 1 second = 20, 1 min = 1200. Default = 5 minutes (6000)
  # Server restarts/reloads will cancel tax calls, so this shouldn't be set too high
 
  MaxTaxAmount: 10000
  # The maximum tax amount allowed. Default = $10,000
 
  AskCaller: false
  # If the person who started the tax will also be asked to pay it
 
  AllowedRanks:
    - "co-mayor"
    - "assistant"
    #- "guard"
    #- "helper"
    #- "sheriff"
 
  #The towny ranks allowed to start a town tax call
  #The town mayor is always allowed to start a tax call
 
NationTax:

  CallTime: 6000
  # How long the tax call will last in ticks
  # 1 second = 20, 1 min = 1200. Default = 5 minutes (6000)
  # Server restarts/reloads will cancel tax calls, so this shouldn't be set too high
  MaxTaxAmount: 10000
  # The maximum tax amount allowed. Default = $10,000
 
  AskCaller: false
  # If the person who started the tax will also be asked to pay it
 
  AllowedRanks:
    - "assistant"
    #- "captain"
    #- "colonel"
    #- "engineer"
    #- "general"
    #- "gunner"
    #- "helper"
    #- "lieutenant"
    #- "major"
    #- "private"
 
# =====================================
# |     CHAIN-OF-COMMAND SETTINGS     |
# =====================================

# Chain-of-Command is a feature that allows players to claim the leadership of inactive towns
# When a player claims leadership, they will automatically become mayor and the former leader co-mayor

ChainOfCommand:

  Enabled: true
  # Enables/Disables the entire Chain-of-Comamnd feature
  # Changing this requires a server restart/reload
 
  InactiveTime: 30
  # How many days a leader must be inactive for a town's leadership to be claimed
  # Default = 30 days
 
  AnyoneCanClaim: false
  # This allows ALL players to claim a town if it is deemed inactive (USE WITH CAUTION)
  # Overrides all other options
 
  AnyNationMemberCanClaim: false
  # Nation members can assume control, even if they are not in the town
  # Allows for town members to claim as well
 
  AnyTownMemberCanClaim: false
  # Town members can assume control regardless of their towny rank
 
  AllowedRanks:
    - "co-mayor"
    - "assistant"
    #- "guard"
    #- "helper"
    #- "sheriff"
 
  # Player can assume control of the town if they have these towny ranks
  # Only matters if the other claim conditions are false
 
# =====================================
# |        INCOME TAX SETTINGS        |
# =====================================

# This is an EXPERIMENTAL FEATURE which taxes all income streams for players and automatically routes it to the town/nation bank
# This feature is new and is in the TESTING phase. If you find a bug please report it at https://github.com/ShermansWorld/Governor
# It is difficult to determine what effect this will have on your server since all server economies are different
# If you are experiencing any problems with this feature I recommend disabling it below

IncomeTax:

   Enabled: true
   # Enables/Disabled the entire Income Tax feature.
 
   EnableChatMessages: true
   # Displays a message in the chat when an income tax is paid
 
   TaxEssentialsPay: true
   # Taxes when a player pays another player using /pay
 
   DefaultTownTax: 0.05
   # This is a percentage of every transaction where the player gains money
   # Default = 0.05 (5%)
   # If you want disable this by default input 0.0

   TownAllowedRanks:
     - "co-mayor"
     - "assistant"
     #- "guard"
     #- "helper"
     #- "sheriff"
 
   # Town ranks allowed to change their town's income tax rate
 
   DefaultNationTax: 0.05
   # This is a percentage of every transaction where the player gains money
   # Default = 0.05 (5%)
   # If you want disable this by default input 0.0
 
   NationAllowedRanks:
     - "assistant"
     #- "captain"
     #- "colonel"
     #- "engineer"
     #- "general"
     #- "gunner"
     #- "helper"
     #- "lieutenant"
     #- "major"
     #- "private"
 
   # Nation ranks allowed to change their nation's income tax rate
 
   MaxTaxRate: 0.5
   # The higest rate a town/nation leader can set their income tax rate
   # Default = 0.5 (50%)
 
   # ===== INCOME TAX HOOKS =====
   # Global settings for additional economy plugins. These plugins are supported but are NOT REQUIRED to use Governor's Income Tax feature
   # If you would like to request support for a new hook request it here: https://github.com/ShermansWorld/Governor/issues
 
   EnableChestShopIncome: True
   # Enables/Disables taxing income from ChestShop shops
 
   EnableJobsIncome: True
   # Enables/Disables taxing income from jobs
   # Note: Incomes will only be taxed if the tax amount is over $1 due to Towny banks working in whole numbers only. This is NOT a bug!
 
   EnableQuickShopIncome: True
   # Enables/Disables taxing income from QuickShop shops

 
Resource Information
Author:
----------
Total Downloads: 411
First Release: Apr 19, 2022
Last Update: Aug 19, 2023
Category: ---------------
All-Time Rating:
2 ratings
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings