Skip to content

For server owners

Cubiq Server Rules

A small, free plugin and server mod that tells the Cubiq Client what is allowed on your server: switch single features off, force them on, or limit a setting – globally, per world or per backend server.

All platforms are in one release – pick the file for your server software. Open source under GPL-3.0.

What it does

  • Lock features off

    For example the minimap, fullbright or zoom in a PvP arena. The player sees “Locked by the server” in the Cubiq menu.

  • Force features on

    Make a feature always active, e.g. toggle sprint on a parkour server.

  • Limit settings

    Set a fixed value or a range, e.g. zoom factor at most 4× or freecam only with fair play (no camera through walls).

  • Per world and per server

    Rules per world on Bukkit, Sponge and server mods, per backend server on Velocity and BungeeCord. Specific entries override the global ones.

  • Bypass for your staff

    Players with the permission cubiqrules.bypass get no rules at all – handy for admins and builders.

  • Players without Cubiq Client

    Optional: if a player does not answer as a Cubiq Client within the timeout, do nothing, show a note or kick.

Platforms

One jar per platform. Rules are the same everywhere; only the place of the config differs.

  • Spigot, Paper, Purpur & Folia

    Minecraft 1.8.8 to the latest version, one jar for all

    File
    cubiq-server-rules-bukkit-<version>.jar
    Config
    plugins/CubiqServerRules/config.yml
    Jar
  • Velocity

    Velocity 3.x – rules per backend server

    File
    cubiq-server-rules-velocity-<version>.jar
    Config
    plugins/cubiq-server-rules/config.yml
    Jar
  • BungeeCord & Waterfall

    Rules per backend server

    File
    cubiq-server-rules-bungee-<version>.jar
    Config
    plugins/CubiqServerRules/config.yml
    Jar
  • Sponge

    Sponge API 8 and newer

    File
    cubiq-server-rules-sponge-<version>.jar
    Config
    config/cubiqserverrules/config.yml
    Jar
  • Fabric, NeoForge & Forge (server mod)

    Fabric 1.20.1, 1.21.1, 1.21.4, 1.21.11 · NeoForge 1.21.1, 1.21.11 · Forge 1.20.1 – only needed on the server

    File
    cubiq-server-rules-<loader>-<mc>-<version>.jar
    Config
    config/cubiq-server-rules.yml
    Jar

On a proxy, the proxy's rules take precedence over a plugin on the backend server.

Configuration

Everything commented out means nothing is locked. Module IDs and setting names are listed in the documentation.

# Cubiq Server Rules – control Cubiq Client features on your server.
# Note: members of the Cubiq 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 Cubiq Client players
missing-client:     # players whose client does not answer with a Cubiq Client hello
  action: ignore    # ignore | notify | kick
  timeout-seconds: 10
  notify-message: "This server works best with the Cubiq Client."
  kick-message: "Please join with the Cubiq Client."
bypass-permission: cubiqrules.bypass   # players with this server permission get no rules

Commands

  • /cubiqrules reload – Reload the config and send the new rules to everyone.
  • /cubiqrules status <player> – Shows whether a player uses the Cubiq Client and which rules apply.

Permission cubiqrules.admin (server mods: OP level 3).

How it works

  1. The Cubiq Client says hello to the server over a plugin channel after joining.

  2. The plugin answers with the rules for the player's world (or backend server) – also when there are none.

  3. On a world or server change and after /cubiqrules reload the rules are sent again and replace the old ones.

  4. When the player leaves, the client forgets all rules. Nothing is stored.

Cubiq Server Rules only controls the Cubiq Client. It is not an anti-cheat: other clients ignore it, and a modified client can pretend to be a Cubiq Client.

Openly documented: Cubiq team bypass

Members of the Cubiq team with the team permission serverrules.bypass can use a locked feature anyway – but only after confirming an in-game prompt (“This server locks Minimap. Use it anyway as Cubiq team?”), and only until they leave the server.

  • It exists so the team can test features and help players on any server.
  • The server is not told about it and cannot switch it off.
  • It is written down here, in the documentation, in the README and as a comment at the top of every config file – it is not hidden.
  • Your own bypass for your staff is the server permission cubiqrules.bypass – that one is fully under your control.
Documentation

Questions or a platform missing?

Ask on Discord or open an issue – the plugin is open source like the rest of Cubiq.