Set up AMS configuration - Game server integration - (Unreal Engine module)
About
AccelByte Multiplayer Servers (AMS) is a dynamic dedicated game server manager that enables you to serve dedicated game servers as close to your players as possible. You can learn more about what AMS has to offer in the AMS documentation.
To start using AMS, you need to create an AMS account and link your game namespace to it. You also need an IAM Client to manage your game server on AMS, such as upload your game server build and claim your dedicated servers from your fleet.
Create AMS IAM client
To manage your dedicated servers on AMS, such as uploading new server build and claiming dedicated servers from your backend, you need an IAM client with enough permission to do those actions. In this tutorial section, you will learn how to create that IAM client.
- AGS Shared Cloud
- AGS Private Cloud
Log in to the Admin Portal and go to your game namespace dashboard.
Go to Game Setup > Games and Apps > IAM Clients and click Create IAM Clients.
On the new page, use the configuration below to create a new server IAM client.
- Create Options: the available options to create a new IAM client. Choose the Create Custom IAM Clients option to create a new IAM client from a scratch.
- Client Name: the name of the IAM client. Set it to ByteWars-AMS.
- Client Type: the confidentiality of the IAM client. Set it to Confidential.
- Secret: the secret or password for the IAM client. You can use your own secret or click the Generate button to generate a random one. Be sure to copy this.
- Redirect URI: the URI used to redirect once the IAM client authorization is successful. Set it to
http://127.0.0.1
.
warningThe Secret will not be shown again after you create the IAM client. Be sure to copy and save it before proceeding to the next step.
On the Permissions section, enable the permission below. This permission allow you to upload game server build to AMS and simulating AMS server locally.
- AMS > Dedicated Server Toolkit: enable Read, Create, and Update permissions.
Once done, click on the Create button to create your IAM client.
Log in to the Admin Portal and go to your game namespace dashboard.
Go to Game Setup > Games and Apps > IAM Clients and click Create New.
On the new window, use the configuration below to create a new server IAM client.
- Client Type: the confidentiality of the IAM client. Since the server IAM client must be secret, set it to Confidential.
- Secret: the secret or password for the IAM client. You can use your own secret or just click the Generate Client Secret button to generate a random secret.
- Client Name: the name of the IAM client. Set it to ByteWars-AMS.
- Redirect URI: the URI used to redirect once the IAM client authorization is successful. Set it to
https://127.0.0.1
.
warningThe Secret will not be shown again after you create the IAM client. Be sure to copy and save it before proceeding to the next step.
Click Create to create your server IAM client. After that, your new IAM client information will be displayed on the screen.
Go to the Permissions tab and click on the Add button to add new permission. Then, add the permission below. This permission allow you to upload game server build to AMS and simulating AMS server locally.
Resource Permission AMS:UPLOAD Create, Update Now, your IAM client setup is complete.
Configure the AGS SDK
Before using the AGS Game SDK, you will need to configure it to use the IAM client you just created.
Open
/Config/DefaultEngine.ini
in a text editor.Find the
[/Script/AccelByteUe4Sdk.AccelByteServerSettings]
and[/Script/AccelByteUe4Sdk.AccelByteSettings]
section insideDefaultEngine.ini
and replace the values with a dummy value. This setup is used for AccelByte Gaming Services (AGS) integration, since you won't be using that in this module, set it to any value.[/Script/AccelByteUe4Sdk.AccelByteServerSettings]
ClientId=DUMMYCREDS
ClientSecret=DUMMYCREDS
Namespace=DUMMYCREDS
PublisherNamespace=DUMMYCREDS
RedirectURI="http://127.0.0.1"
BaseUrl=DUMMYCREDS
[/Script/AccelByteUe4Sdk.AccelByteSettings]
bServerUseAMS=trueSave the
DefaultEngine.ini
file and rebuild your Byte Wars project.