TRS Server Rules

TRS Server Rules is a free plugin and server mod. It tells the TRS Client what is allowed on your server: switch single modules off, force them on, or set and limit their settings – globally, per world or per backend server.

Download and install

All platforms are in one GitHub release: github.com/theredstonee/TRS-Launcher/releases/tag/server-plugin. Overview: For servers.

Configuration

# TRS Server Rules – control TRS Client features on your server.
# Note: members of the TRS team with the "serverrules.bypass" permission can override these rules
# after an in-game confirmation. This is documented on purpose.
modules:            # global
  minimap: false    # false = forced off, true = forced on
  fullbright: false
settings:
  zoom.factor: {max: 4}
  cinematic.freecamFairPlay: true
worlds:             # Bukkit/Sponge/mods: per world; Velocity/Bungee: "servers:" per backend server
  pvp_arena:
    modules: {zoom: false, freelook: false}
message: ""         # optional text shown once to TRS Client players
missing-client:     # players whose client does not answer with a TRS Client hello
  action: ignore    # ignore | notify | kick
  timeout-seconds: 10
  notify-message: "This server works best with the TRS Client."
  kick-message: "Please join with the TRS Client."
bypass-permission: trsrules.bypass   # players with this server permission get no rules

Everything commented out (or missing) means: nothing is locked, the player decides.

modules

<module id>: true | false. false locks the module off, true forces it on. A module that is not listed stays the player's choice. All IDs: Module IDs.

settings

<module id>.<setting id>: … – the setting IDs are the keys of a module in the TRS Client's own config file config/trsclient.json (flags, numbers, choices).

Unknown modules or settings are ignored by the client, so a config also works with older and newer TRS Client versions.

worlds / servers

Rules for single worlds (Bukkit, Sponge, server mods: worlds:) or backend servers (Velocity, BungeeCord: servers:), each with its own modules: and settings:. An entry there overrides the global entry with the same key; everything else comes from the global part.

message

Optional text that the TRS Client shows once as a TRS notice when the rules arrive. Empty = no notice.

missing-client

What happens to players whose client does not answer with a TRS Client hello within timeout-seconds:

bypass-permission

Players with this server permission (default trsrules.bypass) get no rules at all – for your admins and builders.

bypass-players and bypass-op-level

• bypass-players: [] – names or UUIDs that get no rules, on every platform.
• bypass-op-level: 0 – server mods only (Fabric/NeoForge/Forge have no permission plugins): operators with at least this level get no rules (0 = off). On Fabric, bypass-permission and trsrules.admin also work if LuckPerms or another mod with fabric-permissions-api is installed.

Commands

Permission trsrules.admin; on Fabric, NeoForge and Forge OP level 3.

TRS team bypass

Members of the TRS team whose role has the team permission serverrules.bypass can use a locked module or setting anyway. When they try to change it, the TRS Client asks first: “This server locks “Minimap”. Use it anyway as TRS team?”. Yes lifts this one lock until they leave the server.

• It exists so the team can test features and help players on any server.
• The game server is not told about it and cannot switch it off.
• It is documented on purpose: here, on the For servers page, in the README of the plugin and as a comment at the top of every generated config.
• Your own exception for your staff is the server permission from bypass-permission – that one is fully under your control.

Protocol

For people who want to write their own implementation. Plugin messaging (custom payload), the content is UTF-8 JSON as raw bytes (no length prefix), at most 32 KiB.

Servers register both names where the platform allows it (mixed versions behind ViaVersion).

Hello (client → server):

{"v":1,"client":"trsclient","version":"0.20.0","mc":"1.21.11","loader":"fabric","modules":["fps","minimap","zoom"]}

Rules (server → client):

{"v":1,
 "modules":{
   "minimap":{"enabled":false},
   "fullbright":{"enabled":false},
   "zoom":{"settings":{"factor":{"max":4.0}}},
   "cinematic":{"settings":{"freecamFairPlay":{"value":true}}},
   "toggleSprint":{"enabled":true}
 },
 "message":"Optional text the client shows once"}

• enabled: false = locked off, enabled: true = forced on, missing = the player decides.
• settings.<id>: {"value": x} forces a value (bool, number, or a choice by its enum name), {"min": a, "max": b} clamps a number.
• Unknown modules and settings are ignored. With v greater than 1 the client only reads the fields it knows.

Module IDs

The IDs are the same in every Minecraft version. A module that does not exist in a version is simply ignored.

HUD

PvP

World

Chat

Redstone

Performance

Misc

Codes in chat or MOTD

Without a plugin, a server can still send invisible codes: each letter with a § in front, in a chat message or in the MOTD. They stay valid until the player leaves the server and still work next to TRS Server Rules.

The map codes are the common ones of other map mods, so existing fair-play plugins work with the TRS Client too.