Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Integrate Amazon GameLift with a Unity game server project

This topic helps you prepare your custom game server for hosting on Amazon GameLift. The game server must be able to notify Amazon GameLift about its status, to start and stop game sessions when prompted, and to perform other tasks. For more information, see  Add Amazon GameLift to your game server.

Prerequisites

Before integrating your game server, complete the following tasks:

Set up a new server process

Set up communication with Amazon GameLift and report that the server process is ready to host a game session.

The following code example shows how to set up a simple server process with Amazon GameLift.

//initSDK
var initSDKOutcome = GameLiftServerAPI.InitSDK();
           
//processReady
// Set parameters and call ProcessReady
var processParams = new ProcessParameters(
    this.OnGameSession,
    this.OnProcessTerminate,
    this.OnHealthCheck,
    this.OnGameSessionUpdate,
    port,
    // Examples of log and error files written by the game server
    new LogParameters(new List<string>()          
        {
            "C:\\game\\logs",
            "C:\\game\\error"
        })
);
               
var processReadyOutcome = GameLiftServerAPI.ProcessReady(processParams);
               
// Implement callback functions
void OnGameSession(GameSession gameSession)
{
    // game-specific tasks when starting a new game session, such as loading map
    // When ready to receive players
    var activateGameSessionOutcome = GameLiftServerAPI.ActivateGameSession();
}
               
void OnProcessTerminate()
{
    // game-specific tasks required to gracefully shut down a game session, 
    // such as notifying players, preserving game state data, and other cleanup
    var ProcessEndingOutcome = GameLiftServerAPI.ProcessEnding();
}
               
bool OnHealthCheck()
{
    bool isHealthy;
    // complete health evaluation within 60 seconds and set health
    return isHealthy;
}

Start a game session

After game initialization is complete, you can start a game session.

The following code example illustrates how to start a game session with Amazon GameLift.

void OnStartGameSession(GameSession gameSession)
{
    // game-specific tasks when starting a new game session, such as loading map   
    ...
    // When ready to receive players   
    var activateGameSessionOutcome = GameLiftServerAPI.ActivateGameSession();
}

End a game session

Notify Amazon GameLift when a game session is ending. As a best practice, shut down server processes after game sessions complete to recycle and refresh hosting resources.

The following example describes how to end a process for a game session.

var processEndingOutcome = GameLiftServerAPI.ProcessEnding();

if (processReadyOutcome.Success)
   Environment.Exit(0);

// otherwise, exit with error code
Environment.Exit(errorCode);
    

Create server build and upload to Amazon GameLift

After you integrate your game server with Amazon GameLift, upload the build files to a fleet so that Amazon GameLift can deploy it for game hosting. For more information on how to upload your server to Amazon GameLift, see Upload a custom server build to Amazon GameLift.