Tutorial / Settings
Paychecks
Pay online players every few minutes: interval, normal amount, amounts per rank, who gets paid, and a Pay everyone now button.
What it does
Paychecks pay every online player a sum of money every few minutes. This page sets how often, how much, and who gets paid. A countdown at the top shows the time to the next paycheck.
Each rank can have its own amount. Ranks without one get the normal paycheck. With DarkRP, DarkRP pays its own salaries; tick the DarkRP box to pay these on top.
Where to find it
Q menu > KGX's Admin Toolbox > Settings > Paychecks.
Only superadmins can change these settings. The rank list and the countdown load for players with access to the Economy panel (toolbox admins, or players given Economy in Settings > Player Access).
The panel
The status line reads "Next paycheck in m:ss." When paychecks are off it reads "Paychecks are off (interval 0, the economy is off, or DarkRP pays instead)."
Checkboxes take effect as soon as you click them. Sliders take effect when you click Apply the numbers above.
When and how much
| Option | What it does | Default | Range |
|---|---|---|---|
| Paycheck every N minutes (0 = off) | Time between paychecks. Changing it restarts the timer. | 10 | 0-240 |
| Normal paycheck (ranks without their own amount) | Amount for ranks with no amount below. | 50 | 0-1,000,000 |
| Only with at least N players online (0 = always) | Nobody is paid while fewer players are online. | 0 | 0-64 |
| No paycheck once a player has this much (0 = no limit) | Counts wallet + bank. | 0 | 0-10,000,000 |
| Apply the numbers above | Saves the four sliders. | - | - |
Who gets paid
| Option | What it does | Default |
|---|---|---|
| Paychecks go into the bank (instead of the wallet) | Where the money goes. | Off |
| AFK players are paid too | Off: AFK players are skipped. | Off |
| Jailed players are paid too | Off: jailed players are skipped. | Off |
| Only living players are paid (not while dead) | Dead players are skipped. | Off |
| Show players a message when they are paid | A notice with the amount. | On |
| With DarkRP: also pay these (on top of DarkRP salaries) | Off: no toolbox paychecks while DarkRP runs. | Off |
Paycheck per rank
| Item | What it does |
|---|---|
| Rank list | Columns Rank and Paycheck: the ranks that have their own amount. |
| Rank | Pick a rank. |
| Amount box | The amount for that rank, 0 to 999,999,999. Starts at 100. |
| Set paycheck for this rank | Saves the amount for the picked rank. |
| Remove selected rank amount | The selected rank goes back to the normal paycheck. |
| Pay everyone now | Pays every online player now, with the same rules (asks first). The timer starts over. |
| Refresh | Reloads the list and the countdown. |
A rank set to 0 is never paid.
How the amount is picked
For each player the toolbox uses the first of these that applies:
- Their job's own paycheck, set in Settings > Jobs.
- With jobs on and no job (Unemployed): the Unemployed paycheck,
kgxat_unemployed_payin Settings > Jobs. At -1 it falls through to the next step. - Their rank's amount from Paycheck per rank.
- The Normal paycheck.
How to use it
Pay VIPs more
- Pick the rank under Rank, for example
vip. - Type the amount in the box below it.
- Click Set paycheck for this rank. It appears in the list.
Stop paychecks for idle players
- Leave AFK players are paid too unticked.
- Set No paycheck once a player has this much to a cap, for example 100000.
- Click Apply the numbers above.
Test paychecks quickly
- Set Paycheck every N minutes to 1 and click Apply the numbers above.
- Watch the countdown, or click Pay everyone now.
Settings and commands
| Setting | Default | Range |
|---|---|---|
kgxat_paycheck_minutes |
10 | 0-240 |
kgxat_paycheck |
50 | 0-1,000,000 |
kgxat_paycheck_min_players |
0 | 0-64 |
kgxat_paycheck_cap |
0 | 0-10,000,000 |
kgxat_paycheck_bank |
0 | 0-1 |
kgxat_paycheck_afk |
0 | 0-1 |
kgxat_paycheck_jailed |
0 | 0-1 |
kgxat_paycheck_alive |
0 | 0-1 |
kgxat_paycheck_notify |
1 | 0-1 |
kgxat_paycheck_darkrp |
0 | 0-1 |
Tips and limits
- No paychecks are paid while the economy is off (Settings > Economy).
- Only human players are paid, not bots.
- Rank amounts are saved for every map in
data/kgx_admin_toolbox/economy_settings.json. - Bank interest is set in Settings > Economy, not here.
- v3.6.20: an income tax can take a percent of every paycheck into the server treasury (Settings > Taxes & Treasury); players are told how much.