Skip to main content

Tags

Tags System

Tags are short labels you attach to servers or players. Other parts of the network can read them and react by blocking access, triggering routing rules, or changing behavior.

Tags are managed through the OrbisMod API in your server code.

Server Tags​

A server tag describes the current state of a server. Any server in your network can set a tag on itself or check tags on other servers.

Examples​

Maintenance mode Set a maintenance tag on a server when it's being updated. Use a routing rule to redirect players away from any server with that tag.

Server state Tag a server as open, starting, or full to let other servers know what's happening. Other systems can react to these states.

Custom flags Define any tag you need for your own logic: pvp-active, event-running, locked, etc.

Using server tags in routing​

Server tags connect directly to Connection Redirect Rules. You can set a condition like:

  • Any server in Game Pool has tag maintenance → redirect players to Lobby

Player Tags​

A player tag is attached to a specific player when they join or are on a server. Other servers can check whether a player has a tag when they connect.

What you can do with it​

Spectator system Tag a player as spectator when they enter spectator mode. A routing rule can use this to keep them on spectator-compatible servers.

Access control Tag players as vip or staff to unlock access to restricted servers. Use a routing condition to check for the tag on connect.

Custom game states Tag players as in-game, in-queue, or ready to track where they are in a game flow.

How tags work in routing​

Tags are checked as routing conditions. On every connection, OrbisManager can check whether a server or player has a specific tag and redirect, block, or allow accordingly.

Setting tags via the Mod API​

Tags are controlled through the OrbisMod API in your server-side code. See the API documentation for the full reference.