🎮Deploying a Game Server

Before proceeding further, make sure you have upgraded your PlayFlow plan. ⬆Upgrading your existing PlayFlow Plans

Understanding Server Responses and Status 🌐

When you start a server on PlayFlow, you will receive a response with important information about your server. This documentation will help you understand the response structure and explain the values you receive when your server is running.

Starting a Server 🚀

Upon starting a server, you will receive the following response:

{
    "match_id": "n76f415773f543d9a009c04d8c78acc4",
    "ip": "0.0.0.0",
    "region": "us-east",
    "status": "launching",
    "version": 67
}

Checking Server Status 🔍

To find out if your server is in a running state, use the GET Server Status API or the Unity Plugin to get the status of your server. Once your server is running, you should receive the following response:

{
    "match_id": "n76f415773f543d9a009c04d8c78acc4",
    "status": "running",
    "region": "us-east",
    "instance_type": "small",
    "server_arguments": "",
    "ssl_enabled": true,
    "ip": "108.61.23.126",
    "ports": {
        "443": 31722,
        "7777": 31224,
        "7778": 30501
    },
    "server_url": "108-61-23-126.games.playflow.cloud",
    "playflow_api_version": 9,
    "server_tag": "production",
    "server_version": 67
}

Response Values Explained 🔧

  • match_id: A unique identifier for the game match or server instance.

  • status: The current status of the server, such as "launching" or "running."

  • region: The geographical region where the server is located, e.g., "us-east."

  • instance_type: The type or size of the server instance, e.g., "small."

  • server_arguments: Any additional command-line arguments passed to the server.

  • ssl_enabled: Indicates whether SSL is enabled (true) or disabled (false).

  • ip: The IP address assigned to the server.

  • ports: A dictionary containing the server's port mappings, with the key being the original port and the value being the assigned port.

  • server_url: The server's URL, which can be used to connect to the game.

  • playflow_api_version: The version of the PlayFlow API in use.

  • server_tag: A label for the server, such as "production" or "staging."

  • server_version: The version number of the server software.

SSL Port for WebGL Clients 🔒

If SSL is enabled, the port designated for WebGL clients will be "31722" (consistently corresponding to the port with 443 as its key). Utilize this port for secure WebSockets connections when establishing a connection to the server.

By understanding these response values, you can effectively manage your PlayFlow game servers and ensure a smooth gaming experience for your players. If you need more information or assistance, please refer to our comprehensive documentation and support resources available on our website.

Last updated