Tutorial / Settings
Taxes & Treasury
Income tax on paychecks, sales tax on store and shipment prices, transfer fees and property tax, collected into a server treasury that admins and Treasury jobs (a Mayor) pay players out of.
What it does
Taxes & Treasury (v3.6.20) takes money out of the economy in four ways and keeps it in one server account, the treasury:
- Income tax: a percent of every toolbox paycheck.
- Sales tax: a percent added on top of store and shipment prices.
- Transfer fee: a percent (with a minimum) of money given with !give or sent by bank transfer; the sender pays it.
- Property tax: a percent of a bought property's price, charged every tax period (counted for each property from when it was bought).
Everything is off (0) by default. With all taxes at 0, nothing changes on your server.
The treasury is spent by admins and by jobs with the Treasury ability (for example a Mayor): they pay players out of it with a reason (a bonus, a reward, a job well done). Every tax, fee and payment is in Utilities > Money Log as its own source, and the treasury shows there as the player Treasury.
Where to find it
Q menu > KGX's Admin Toolbox > Settings > Taxes & Treasury. Only superadmins change the settings.
The treasury window: !treasury in chat, kgxat_treasury_open in the console, or Open the treasury on this page. Admins with the Economy panel and players whose job has the Treasury ability (Settings > Jobs) can open it.
The panel
| Option | What it does | Default | Range |
|---|---|---|---|
| Income tax: % of every paycheck | Taken from each toolbox paycheck (Settings > Paychecks). The player is paid the rest and told how much tax was taken. | 0 | 0-90 |
| Sales tax: % added to store and shipment prices | Added on top of the price at the Server Store (F3), NPC and player stores, shipments and shipment boxes. Buyers see the price with the tax; the store window says "Prices include N% sales tax." Sellers get the price without it. At least 1 per purchase. | 0 | 0-50 |
| Transfer fee: % of !give and bank transfers | The sender pays it on top of what they send. | 0 | 0-50 |
| Transfer fee: at least | The smallest fee per transfer. With the percent at 0, this is a flat fee. | 0 | 0-1000000 |
| Property tax: % of a bought property's price per period | Charged from the owner while they are online: from the wallet, then the bank. Rented property (it pays rent) and server property pay none. | 0 | 0-25 |
| Property tax: period (minutes) | How often property tax is charged. Each property has its own: the first tax comes one period after it was bought (or after property tax was turned on), then every period. An owner who is away pays when they are back (once). The treasury window shows when the next one is due (v3.6.21.3). | 60 | 5-1440 |
| Property tax: unpaid periods before it is sold back | An owner who cannot pay owes the tax (it adds up and is told each time). After this many unpaid periods in a row the property is sold back: they get half of what they paid, minus what they owe. | 3 | 1-20 |
| Keep taxes and fees in the treasury | Off = taxes and fees are removed from the economy (a money sink) instead. | On | |
| Treasury jobs: pay at most (per payment) | The most a Treasury job pays out at once. Admins: no limit. | 5000 | 0-100000000 |
| Treasury jobs: seconds between payments | Admins: no wait. Treasury jobs cannot pay themselves. | 30 | 0-3600 |
| Bank vaults: % of every tax and fee that goes into the bank vaults (v3.6.21) | That share of each tax goes to the banks and ATMs set as a bank vault (Store Maker > Bank vault, or Money Generator > Money comes from: Bank vault), split by each vault's own share, up to each vault's most; the rest goes to the treasury. Robbing a vault takes its money. Admin deposits, payments back and rollbacks are never split. | 0 | 0-100 (2 decimals) |
| Bank vaults only hold money: nobody (admins too) deposits or withdraws at them (v3.6.21.2) | A bank or ATM set as a bank vault opens no bank window: it only holds the bank's money and shows its robbery sign. Players use another bank, an ATM or !bank. Off: vault banks are also normal banks. v3.6.21.3: E on a vault opens a window with its money and whether it can be robbed. | On | |
| Screens on treasury nodes and stores (v3.6.21.5) | Off: no treasury node or store shows its screen. Each screen is set on its own: Economy > Treasury Node (right-click a node) and Store Maker > Screen. | On | |
| Charge property tax now (owners who are online) (v3.6.21.3) | Charges every owned property now, due or not (to test it, or start a period for all). | ||
| Open the treasury | Opens the treasury window. |
The treasury window
| Part | What it shows or does |
|---|---|
| Balance | What the treasury holds, with the amount in words under it. "Taxes are not kept right now" when the treasury box is off. |
| Refresh | Loads the window again. |
| Copy the log (v3.6.21.4.1) | Copies every line shown in the log to the clipboard (with "the last N of M lines" when the log has more). Also in the right-click menu. |
| Clear the log... (v3.6.21.4.1, superadmins) | The same as Clear the log... in the right-click menu, as a button. |
| Live (update while open) | On: the open window updates by itself (within a second) when the treasury changes. Your typed amounts stay. Remembered per player (kgxat_treasury_live). On by default. |
| Rates | The tax rates of the server. Under them (v3.6.21.4.1), what the property tax is doing: how many bought properties are taxed, when the next one is due and how many owners are offline; or why nothing is taxed: the economy is off, RP mode or Property is off (Settings > Gameplay), DarkRP runs, or only rented or server property is owned (those pay none). |
| In today, from | Today's income per source (Sales tax, Income tax...) and Paid out today; with bank vaults (v3.6.21) also To bank vaults today and In the bank vaults now. |
| The log | Every treasury change (v3.6.20.2): When, Change, Balance after it, What (the source, its detail and any note) and By (who did it). The newest 200 lines are shown; hover a line to see the amounts in words. |
| Pay a player... | Pick an online player, an amount and What it is for, then Pay from the treasury. The money goes to their wallet; they see who paid and why. A reason is needed. The amount in words shows under the box. |
| Deposit / Withdraw (admins) | Put money into the treasury or take it out (never below 0), with a reason or note for the log and the Money Log. The amount in words shows under the box. |
The treasury log
The log keeps the last 1000 changes in treasury.json. Right-click a line or the empty part of the log:
| Option | Who | What it does |
|---|---|---|
| Copy this line, Copy the amount, Copy the amount in words, Copy the detail, Copy the note | Everyone who can open the window | Copies to the clipboard. |
| Deposit..., Withdraw... | Admins with the Economy panel | Asks for the amount, shows it in words, then asks for a reason or note. |
| Add a note line... | Superadmins | A line of its own with your note (up to 120 letters), for example "Server grant for the police budget". |
| Add a note to this line... / Edit the note... | Superadmins | A note on any line. Empty removes the note; an empty note on a note line removes that line. |
| Take this deposit back... | Superadmins | On an admin's deposit: takes that amount back out of the treasury (never more than it has) as a new line, and marks the deposit "(taken back)". Only once per deposit. |
| Remove this line... | Superadmins | Removes the line from the log. The balance does not change. |
| Clear the log... | Superadmins | Empties the log and In today; one line says who cleared it. The balance does not change. |
Removing lines and clearing the log never touch the Money Log: Utilities > Money Log keeps every change (and rollbacks need it). Every superadmin change is in the Action log.
Amounts in words
Every amount box shows its amount in words, like on a check, always with the cents (v3.6.21): 1000000 is One Million Dollars and 00/100, 12.50 is Twelve Dollars and 50/100. With another currency it uses its name: "Twelve Euros and 50/100", "Twelve Credits and 50/100". The words are English only.
How to use it
A Mayor who pays bonuses
- Settings > Jobs: edit the Mayor job and tick the Treasury ability. Save.
- Settings > Taxes & Treasury: set Income tax to 10 and Sales tax to 5. Click Apply the numbers above.
- The Mayor types !treasury, picks a player, types 200 and "Kept the streets clean", and presses Pay from the treasury.
A money sink against inflation
- Untick Keep taxes and fees in the treasury.
- Set a Transfer fee of 2% and a Property tax of 0.5%.
- Money taken this way leaves the economy. Utilities > Money Log shows each charge on the player.
Note a big deposit
- As an admin, type 1000000 in the deposit box: "One Million Dollars" shows under it.
- Type "Server grant" as the reason and press Deposit.
- As a superadmin, right-click the new line > Add a note to this line... and write what it is for.
Settings and commands
| Command | What it does |
|---|---|
kgxat_tax_income, kgxat_tax_sales, kgxat_tax_transfer, kgxat_tax_transfer_min, kgxat_tax_property, kgxat_tax_property_minutes, kgxat_tax_property_strikes |
The taxes (see the panel). |
kgxat_treasury, kgxat_treasury_max_pay, kgxat_treasury_pay_cooldown, kgxat_treasury_bank_share, kgxat_bank_vault_only, kgxat_screens |
The treasury settings. |
kgxat_screen_distance |
Per player: how far away (units) treasury and store screens are drawn (200-2000, default 900). |
kgxat_treasury_open |
Opens the treasury window; in the server console it prints the balance. |
| !treasury | Opens the treasury window (admins, Treasury jobs). |
kgxat_treasury_live |
1 = your open treasury window updates by itself (per player). |
| data/kgx_admin_toolbox/treasury.json | The treasury's balance and its log (the last 1000 lines). |
Tips and limits
- Income tax only touches toolbox paychecks; with DarkRP, DarkRP's own salaries are not taxed. DarkRP's own money transfers and doors are not taxed either.
- Taxes the toolbox takes are rounded down, but a sales tax is at least 1 on a paid item. With cents on (Settings > Economy), taxes are kept to the nearest cent and a sales tax is at least $0.01.
- Property tax is not taken? Open the treasury and read the line under the rates: it says why. The first tax of a property comes one period after it was bought; Charge property tax now charges at once to test it.
- Every payment and every tax can be undone in Utilities > Money Log (Rollbacks).
- Players see the tax lines in their own language (Settings > Display > Language).