User Defined Status Tagging

Everyone wishes to display their player counts, and other information in specific ways. You must add the StatusFormat variable to your bot's settings to enable this ability. If one is not specified or is null I will default to my original format automatically.

Here is an example of a bot that contains StatusFormat:

{
   "Name": "Server Name",
   "Address": "Address",
   "Token": "Token",
   "StatusFormat": "@Players/@MaxPlayers Q: @QueuedPlayers",
   "Status": 0,
   "UseNameAsLabel": false,
   "ProviderType": 0
}

If you do not wish to specify your own format, just remove the StatusFormat line or set it to null.

{
   "Name": "Server Name",
   "Address": "Address",
   "Token": "Token",
   "Status": 0,
   "UseNameAsLabel": false,
   "ProviderType": 0
}

{
   "Name": "Server Name",
   "Address": "Address",
   "Token": "Token",
   "StatusFormat": null,
   "Status": 0,
   "UseNameAsLabel": false,
   "ProviderType": 0
}

Before we continue, you must understand the terminology I will use later. A Tag is a case sensitive name for a data point that is prefixed with the @ symbol.

**For Example @Players is the tag that holds data related to the players currently logged into your server. @players does nothing. 👎 **

Every provider has different supported tags; however, there are tags that all providers share.

The common tags are as follows:

Common Tags for All Providers

Tag	What does it display?	Notes
@Address	IP Address	N/A
@Port	Port Provided	Battlemetrics will not display anything
@Players	Online Players	N/A
@MaxPlayers	Max Allowed Player on Server	N/A
@QueuedPlayers	Currently Queued Players	Not supported by all providers and games.	If you prefix this tag with Q: it will automatically hide when there is no queue count

Note: Queued Players is only specific to games that have a queue count I can capture. If you don't see the value then contact me via discord server. I will need to use your server to test, and fix it.

Provider Specific Tags

BattleMetrics

Tag	What does it display?	Notes
@Map	Current Server Map	N/A
@Time	Time on the server	N/A
@Gamemode	Current Server Gamemode	N/A
@Rank	Server's Current Rank	N/A

Minecraft

Tag	What does it display?	Notes
@Version	Current Server Version	N/A

Steam

Tag	What does it display?	Notes
@Map	Current Server Map	N/A
@GameType	Current Server GameType	N/A

Docker

When using docker, add BOT_STATUSFORMATS to your docker-compose file. These values are still separated by semi-colons. If you don't wish to set a specific format use the value null.

Example: BOT_STATUSFORMATS: "null;@Players/@MaxPlayers Q: @QueuedPlayers;null;null"

Suggestions

If you have any suggestions for data that you wish to have as a tag, please suggest it to me in an issue or via my discord server.