Tutorial / Tools > Functions
Ranks
Make ranks, give them to players and set the rank of new players and the auto-rank hours.
What it does
Ranks shows every rank in one list: the ranks of your admin mod (ULX or SAM) or, without one, the toolbox's own ranks. Superadmins make ranks here, remove them and give them to players with the tool.
New players get the default rank (citizens). Auto-ranks promote players by hours played. Settings > Playtime & Auto-Ranks shows the same ladder.
Ranks made here are made in your admin mod and inherit what that rank allows. Without an admin mod, the toolbox keeps the ranks and gives them back when players join.
Where to find it
Q menu > KGX's Admin Toolbox > Functions > Ranks.
Admins can open the tool, read ranks and playtime, and press Scan ranks. Only superadmins can give, make, remove or change ranks. With a server owner set (v3.6.12, kgxat_owner add <SteamID> in the server console), only owners can, from every place a rank is given (this tool, the Player Manager, rank presets); an owner can fix ranks here even without an admin rank. The other buttons and menus are disabled for admins.
You can also give a rank from Utilities > Player Manager (superadmins).
Admins only (v3.6.11.3): this tool sets up the server, so it cannot be given to players; it is greyed out in Settings > Player Access.
Controls
| Key | What it does |
|---|---|
| Left click | Give the aimed player the selected rank (superadmins) |
| Right click | Show the aimed player's rank and playtime |
| Reload | Put the aimed player back to the rank of new players (superadmins) |
Right-click also shows the next auto-rank and the hours it needs. The HUD shows the aimed player's name and rank.
The panel
A status line shows the admin mod, whether citizens are on and the rank selected for the tool.
| Option | What it does | Default |
|---|---|---|
| Scan ranks (update every rank picker) | Finds ranks made in the admin mod while the server runs | - |
| Preset: RP playtime ranks (28 ranks, hours, chat tags) | Makes 28 RP ranks from Citizen (user) to Legacy (5,000 h), each inheriting the one before, with auto-rank hours and chat tags. Existing ranks with the same names are kept. | - |
| Auto-ranks on (promote by hours played) | Turns auto-ranks on or off | On |
Ranks list
Columns: Rank, Inherits, Auto after, Online. The default rank is marked "(new players)" and user, admin and superadmin are marked "(built-in)". Double-click a rank to select it for the tool.
Right-click a rank:
- Use with the tool (left-click players)
- Make it the rank of new players (citizens)
- Auto-rank: promote to it after hours played...
- Take it off the auto-ranks (when it has hours)
- Remove this rank...
Make a rank
| Option | What it does |
|---|---|
| Name field | Letters, numbers, _ or - |
| Inherits from | The rank it builds on (user by default) |
| Make the rank | Creates it |
Players online
Columns: Player, Rank, Hours. Right-click a player > Give rank > pick a rank. Refresh reloads both lists.
How to use it
Promote a player
- Double-click the rank in the list, or right-click it > Use with the tool (left-click players).
- Left-click the player. They are told their new rank.
Make a VIP rank
- Type
vipin the name field. - Pick Inherits from (for example user) and press Make the rank.
Set up playtime ranks
- Right-click a rank > Auto-rank: promote to it after hours played....
- Enter the hours.
- Make sure Auto-ranks on (promote by hours played) is ticked.
Settings and commands
| Setting or command | What it does | Default / range |
|---|---|---|
kgxat_autoranks |
Promote players by playtime | 1, 0 or 1 |
kgxat_citizens |
Citizens: 0 = off, 1 = in RP mode, 2 = always | 1, 0 to 2 |
kgxat_citizen_rank |
The rank new players get as citizens | citizen |
kgxat_scanranks |
Scan every rank and update rank pickers | - |
kgxat_rankpreset rp |
Make the RP playtime ranks (superadmins) | - |
Tips and limits
- Nobody can change their own rank here. Bots cannot be targeted.
- user, admin and superadmin cannot be removed, and cannot be auto-ranks.
- An admin rank (or one that inherits one) cannot be the rank of new players or an auto-rank.
- Reload gives the citizen rank when citizens are on, else
user. - Auto-ranks only promote. Admin ranks, and ranks not on the ladder other than
user, are never changed by them. - Auto-ranks are saved in
data/kgx_admin_toolbox/ranks.json. Ranks given without an admin mod are saved inownranks.jsonand restored on join. - If your admin mod refuses a new or removed rank, make the change in the admin mod.