Skip to main content

Server Rules

The Server Rules page lets administrators publish rules in Markdown format and optionally enforce acceptance before players can use the shop.

Access​

Navigate to Admin › Server Rules in the admin navigation. The page is visible to any admin role that has the rules.view access right. Editing requires rules.edit. Viewing the rule change history requires rules.viewHistory.

Editing the Rules​

The rules editor is a Markdown text field that grows automatically as you type — there is no fixed scrollable window. Write the rules using standard Markdown (headings, bullet lists, bold text, etc.).

Two save buttons are available:

  • Save — publishes the changes and records a history entry (see Rule Change History below).
  • Save silently — publishes the changes without recording a history entry. Use this for minor corrections that should not appear in the public change log.

Saving the rules does not automatically trigger a re-acceptance from players. Use the reset action described below if you want players to re-read and re-accept after an update.

Rule Change History​

Every Save (non-silent) records a history entry containing a unified diff of the change, the editor's username, and a timestamp. The last 10 entries are kept.

Click the Rule Changes button (visible when the rules.viewHistory access right is granted) to open the history drawer. Each entry shows who made the change and when — click the entry to expand the diff view. Multiple entries can be expanded at the same time.

Players with the rules.viewHistory access right also see a Rule Changes button on the player-facing Rules page, giving them read-only access to the same history.

Enforcement​

The setting Players must accept the rules in Admin › Settings › Whitelist & Accounts controls whether players must accept the rules before accessing any page in the shop frontend. The Rule Acceptance Enforcement card on this page shows whether it is on and links straight to the setting.

  • Disabled (default): The Rules page is only visible to players who have the rules.access access right.
  • Enabled: Every page in the shop redirects to the Rules page until the player clicks the acceptance button. When enforcement is active, the access right is ignored and the Rules page is accessible to all players.

Changing it needs the settings.edit right and takes effect as soon as you save the settings. If the rules are already published in a Discord channel, the accept button below them appears or disappears with it; the rules text itself is left as it is.

Discord Role​

When a player accepts the rules, the Discord bot automatically assigns a Rules accepted role on your Discord server. If the bot does not yet have this role, it creates it automatically.

Syncing Rules to Discord​

The Sync to Discord section lets you publish the current rules directly to a Discord channel. Before using this feature, configure a Discord Rules Channel in Admin › Settings › Discord.

When you click Sync to Discord, the bot:

  1. Fetches all previous bot messages in the configured channel and deletes them.
  2. Splits the rules Markdown into sections (one Discord message per heading, or multiple messages if a single section exceeds Discord's 2 000-character limit).
  3. Posts the sections as sequential messages in the channel.
  4. While enforcement is enabled, posts one last message with an Accept rules button. Players accept the rules with it right in Discord, exactly as with the button on the web page — including the Rules accepted role. Their confirmation is only visible to them, so the channel stays clean.

Syncing is a manual action — it does not trigger automatically when you save the rules. Click Sync to Discord again after any update to push the latest version. Toggling enforcement only adds or removes the accept button below rules that are already published — it does not push rule changes.

Players can also type /rules anywhere on your Discord to see whether they have accepted the rules, open them on the web, and accept them. Their Discord account needs to be linked to their player (see /link); a player who is not linked gets a hint to link first.

Resetting Rule Acceptance​

The Reset All Acceptances button (in the "Reset Rule Acceptance" section) removes the acceptance flag from every player on this server and also removes the Rules accepted Discord role from each player. After a reset:

  • Players who have accepted will need to accept again.
  • If enforcement is enabled, they will be redirected to the Rules page on their next visit.

This action is irreversible. A confirmation dialog is shown before it takes effect.