Skip to content

Game Server Status

Aleksandar Ovcharov edited this page Aug 8, 2024 · 2 revisions

Game Server Status Feature

The Game Server Status feature in PteroSync provides real-time information about your game servers, enhancing the management and monitoring experience. This feature leverages the query port of your server to fetch status information, ensuring you have the latest data at your fingertips.

How It Works

The feature operates by checking if a server has a specified query port. If a query port is available, it uses this port; otherwise, it defaults to using the server's main port. This flexibility ensures compatibility with a wide range of server configurations.

Enabling Game Server Status

By default, the Game Server Status feature is disabled to ensure optimal performance for all users. However, enabling it is straightforward:

  1. Locate the config.json file within your PteroSync installation.

  2. Change the show_server_information setting from false to true.

    {
      "show_server_information": true
    }

What Information Is Displayed?

We use the third-party service api.gamecms.org to fetch the following information:

  • Server Status: Indicates whether the server is online or offline.
  • Max Players: The maximum number of players that can join the server.
  • Online Players: The current number of players on the server.
  • Server Name: The name of the server, which is hidden if it is not set or is empty.

Choosing Server Status Name

To choose what name to use for Server Status, you need to edit each product and set the desired option. The options are:

  • Node Name: We will use the node name for the game name.
  • Nest Name: We will use the nest name for the game name.
  • Do not show server status: This means it won't show server status on the client area.

Ensure your nest/egg names are in English, such as "Minecraft", "Source", "cs2", "FiveM", etc. The module won't support any custom names that are not English-friendly.

Reporting Issues

While we strive to support a wide range of games, there might be instances where specific games do not work as expected with the Game Server Status feature. If you encounter any issues or if your game is not supported, please feel free to open an issue on our GitHub repository. Your feedback helps us improve support for all users.


We hope this feature enhances your server management experience by providing key insights into your game servers' status. For any further assistance or feedback, do not hesitate to reach out through our GitHub repository.