# module.serverstatus.html

The server status module allows creators who operate Game Servers to display the status of their game server (e.g. player count or online status) on their store.

<table><thead><tr><th width="298.3333333333333">Variables</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>module.header</code></td><td>string</td><td>The header of the module.</td></tr><tr><td><code>module.online</code></td><td>boolean</td><td>If the game server is online.</td></tr><tr><td><code>module.ip</code></td><td>string</td><td>The IP address of the game server.</td></tr><tr><td><code>module.port</code></td><td>string</td><td>The port of the game server.</td></tr><tr><td><code>module.players.online</code></td><td>string</td><td>The total players on the game server.</td></tr><tr><td><code>module.players.max</code></td><td>string</td><td>The maximum players that can be online at one point on the game server.</td></tr></tbody></table>

### Request Variable

If you'd like access to a variable that is not currently available, [please let us know.](https://forms.monday.com/forms/8cbacdac7c30b725cd4617cbba0e5eeb?r=use1)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.tebex.io/developers/templates/sidebar-modules/module.serverstatus.html.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.