Unreal Engine Game Server Client Plugin

This is the Unreal Engine 4 Agones Game Server Client Plugin.

Check the Client SDK Documentation for more details on each of the SDK functions and how to run the SDK locally.

Download

Download the source from the Releases Page or directly from GitHub .

Usage

The Unreal Engine plugin is specifically designed to be as simple as possible. No programming should be required to use the plugin within your Unreal Engine project.

From source

At this moment we do not provide binaries for the plugin. This requires you to compile the plugin yourself. In order to do this you need to have a C++ Unreal Engine project.

  1. Create a Plugins directory in your Unreal Engine project root directory.
  2. Copy the Agones plugin directory into the Plugins directory.
  3. Build the project.

Agones Hook

To manually call the Agones SDK methods add the plugin as a dependency inside the <project>.Build.cs file:

PublicDependencyModuleNames.AddRange(
    new string[]
    {
        ...
        "Agones"
    });

Then use FAgonesModule::GetHook() to get a reference to the Agones hook and call the SDK methods using the hook:

#include "Agones.h"

...

// Get a reference to the Agones hook.
FAgonesHook& Hook = FAgonesModule::GetHook();

Hook.Ready();
Hook.SetLabel(TEXT("key"), TEXT("value"));

// GetGameServerDelegate here is a class member of type FGameServerRequestCompleteDelegate.
Hook.GetGameServer(GetGameServerDelegate);
GetGameServerDelegate.BindLambda([](TSharedPtr<FGameServer> GameServer, bool bSuccess)
{
    // ...
});

Settings

The settings for the Agones Plugin can be found in the Unreal Engine editor Edit > Project Settings > Plugins > Agones

Available settings:

  • Health Ping Enabled. Whether the server sends a health ping to the Agones sidecar. (default: true)
  • Health Ping Seconds. Interval of the server sending a health ping to the Agones sidecar. (default: 5)
  • Request Retry Limit. Maximum number of times a failed request to the Agones sidecar is retried. Health requests are not retried. (default: 30)
  • Send Ready at Startup. Automatically send a Ready request when the server starts. Disable this to manually control when the game server should be marked as ready. (default: true)

Last modified March 28, 2020: update local.md (#1437) (6ff2787)