Edit

Author a game server build

  • Article

This topic explains how to create a game server build for PlayFab Multiplayer Servers (MPS). A game server build typically contains game assets and an executable that runs on the server.

When using PlayFab Multiplayer Servers, you need to make modifications to your regular game server build so that it can work on them. This modified server build is called a PlayFab Multiplayer Game Server Build.

If you're unsure of the terms used, see Terminology.

How to create a PlayFab Multiplayer Game Server Build

You can convert your regular game server build into a PlayFab Multiplayer Game Server Build by integrating it with the PlayFab Game Server SDK (GSDK).

  1. Download the GSDK you need
  2. Open your existing game server code project and add the GSDK as a dependency
  3. Implement essential functions (at minimum the Start and ReadyForPlayers methods) using the APIs in the GSDK. For code snippets, see Integrating game servers with GSDK.
  4. Build and compile the game server executable to create the PlayFab Multiplayer Game Server Build

This new build now helps manage game servers that are created using PlayFab Multiplayer Servers. Adding more methods provide greater control and gives you information about the servers. For more instructions, see the Program.cs in the Wrapper sample.

Note

Consider using our open source debugging utility LocalMultiplayerAgent to test your game server before uploading it into MPS. This will help prevent unnecessary costs in case your game server fails to start or is not properly integrated with GSDK. You can download LocalMultiplayerAgent here and check the instructions here. LocalMultiplayerAgent can also be used for iterative testing/debugging during the development of your game server.

Next step

When using Windows game servers, you have to use the managed Windows container image. So the PlayFab Multiplayer Game Server Build can be uploaded as a zipped file combined with other dependencies (DLL files) during the Deploy a build process. To help you determine what needs to be included in the zipped file, see Determining required DLLs.

When using Linux game servers, you need to Create your custom Linux container image and the PlayFab Multiplayer Game Server Build can be included as part of the image. Once your custom image is uploaded, you would be able to Deploy a build.

See also