Tutorial / Admin panels > Utilities
Rules
Write the server rules players read with !rules, show them on join or to everyone, and place rules signs in the world.
What it does
Rules holds your server rules. Players type !rules in chat to open them in a window. You can also show them to every player when they join, or to everyone at once.
Rules signs put the same text on a wall or on a standing board in the world. Signs update by themselves when you save new rules.
Where to find it
Q menu > KGX's Admin Toolbox > Utilities > Rules.
Toolbox admins can edit the rules and place signs. Players can get this through Settings > Player Access with the Rules (edit) tick.
Every player can read the rules with !rules or /rules in chat, and can see rules signs.
The panel
Rules text
| Option | What it does | Default |
|---|---|---|
| Rules box | The rules text. Up to 6000 characters. | Example rules |
| Show the rules to players when they join | Opens the rules window for each player a few seconds after they join. | Off |
| Save rules | Saves the text and the checkbox on the server. | |
| Preview | Opens the rules window for you only, with the unsaved text. | |
| Show the rules to everyone now | Opens the rules window on every player's screen. | |
| Reset to defaults (example rules, not on join) | Asks to confirm, then saves the example rules with on-join off. |
Edits are not saved until you press Save rules.
Rules signs (up to 5 per map)
These settings set the look of the next sign you place. They are saved on your own game.
| Option | What it does | Default | Range |
|---|---|---|---|
| Title (empty = none) | Heading at the top of the sign. | Server Rules | |
| Size (1 poster - 10 billboard) | How big the sign is. | 2 | 0.5-10 |
| Width (where lines wrap) | Line width before text wraps. | 1000 | 500-2400 |
| Title color | Color of the title. | 255, 210, 80 | |
| Text color | Color of the rules text. | 235, 235, 235 | |
| Background | Draws a background behind the text. | On | |
| Background color (alpha = see-through) | Background color and transparency. | 20, 22, 28, 220 | |
| Center the text | Centers the text instead of left-aligning it. | Off | |
| Place a rules sign where I am looking | Places a sign on the wall you look at, or a standing sign on the floor. | ||
| Reset the sign settings | Puts all sign settings back to their defaults. |
The list below shows every rules sign on the map: #, Sign and Distance. Double-click a sign to go there. Right-click for:
| Option | What it does |
|---|---|
| Go there | Teleports you to the sign. |
| Rename... | Gives the sign a name (empty = no name). |
| Apply the sign settings above to it | Changes the sign to the current look settings. |
| Load its settings into the panel | Copies the sign's look into the settings above. |
| Copy position | Copies its x, y, z position. |
| Remove | Removes the sign. |
How to use it
Write and publish the rules
- Open Utilities > Rules.
- Write your rules in the box.
- Tick Show the rules to players when they join if new players should see them.
- Press Save rules.
- Press Show the rules to everyone now to show the new rules to players already online.
Place a rules sign at spawn
- Set Title (empty = none), Size (1 poster - 10 billboard) and the colors.
- Look at a wall, or at the floor for a standing sign that faces you.
- Press Place a rules sign where I am looking.
Restyle an existing sign
- Right-click the sign in the list and pick Load its settings into the panel.
- Change the settings, for example a larger size and a red background.
- Right-click the sign again and pick Apply the sign settings above to it.
Settings and commands
| Setting or command | Default | What it does |
|---|---|---|
!rules |
Any player: opens the rules window. | |
kgxat_rules_accept |
0 | New players are frozen until they accept the rules, and again after the rules change. Admins are exempt. |
kgxat_rulesign_* |
Your own sign look settings (client side). |
Tips and limits
- With
kgxat_rules_accepton, the window has I have read the rules and agree and I do not agree (leave the server) buttons, and no close button. Until they agree, every rules window they get (!rules, "show to everyone") is that one. - With
kgxat_rules_accepton, it shows the rules on join instead of Show the rules to players when they join. - If the rules text is empty, players see "No rules have been set on this server yet."
- At most 5 rules signs per map. Signs are saved per map and come back after a restart.
- Show the rules to everyone now works at most once every 10 seconds.
- The rules are saved in
data/kgx_admin_toolbox/rules.json, for every map.