Set up Multi-Platforms Credentials

Last updated on October 24, 2024

Overview​

AccelByte Gaming Services (AGS) Multi-Platform Credentials allow you to build your game with different AGS credentials for each platform, eliminating the need to change credentials every time the build setting is changed to other platforms. This feature currently supports PlayStation 4, Xbox, and Steam.

Unreal Engine​

To get started with Multi-Platform Credentials, you will need to install the AGS Game SDK for Unreal Engine.

First, create a folder and a file under the <Your Project>/Config directory. Use the following format for the file naming:

<Platform>/<Platform>Engine.ini

For example, if you want to create a specific config for Windows, you would use the following name:

Windows/WindowsEngine.ini

Your Config folder will look like this:

Unreal Engine multi-platform credentials configuration folder preview

note

You can find the list of available platforms in Engine/Config/BaseEngine.ini under the InstalledPlatforms subfolder.

Input the config below into the file you just created. It is similar to the format inside the DefaultEngine.ini file:

[/Script/AccelByteUe4Sdk.AccelByteServerSettings]
ClientId=<My Server OAuth Client Id>
ClientSecret=<My Server OAuth Client Secret>
Namespace=<My Namespace>
BaseUrl="https://prod.gamingservices.accelbyte.io"

[/Script/AccelByteUe4Sdk.AccelByteServerSettingsDev]
ClientId=<Dev Server OAuth Client Id>
ClientSecret=<Dev Server OAuth Client Secret>
Namespace=<Dev Namespace>
BaseUrl="https://dev.accelbyte.io"

[/Script/AccelByteUe4Sdk.AccelByteServerSettingsCert]
ClientId=<Cert Server OAuth Client Id>
ClientSecret=<Cert Server OAuth Client Secret>
Namespace=<Cert Namespace>
BaseUrl="https://cert.accelbyte.io"

[/Script/AccelByteUe4Sdk.AccelByteServerSettingsProd]
ClientId=<Prod Server OAuth Client Id>
ClientSecret=<Prod Server OAuth Client Secret>
Namespace=<Prod Namespace>
BaseUrl="https://prod.accelbyte.io"

[/Script/AccelByteUe4Sdk.AccelByteSettings]
ClientId=<My OAuth Client Id>
ClientSecret=<My OAuth Client Secret>
Namespace=<My Namespace>
BaseUrl="https://prod.gamingservices.accelbyte.io"

[/Script/AccelByteUe4Sdk.AccelByteSettingsDev]
ClientId=<Dev OAuth Client Id>
ClientSecret=<Dev OAuth Client Secret>
Namespace=<Dev Namespace>
BaseUrl="https://dev.accelbyte.io"

[/Script/AccelByteUe4Sdk.AccelByteSettingsCert]
ClientId=<Cert OAuth Client Id>
ClientSecret=<Cert OAuth Client Secret>
Namespace=<Cert Namespace>
BaseUrl="https://cert.accelbyte.io"

[/Script/AccelByteUe4Sdk.AccelByteSettingsProd]
ClientId=<Prod OAuth Client Id>
ClientSecret=<Prod OAuth Client Secret>
Namespace=<Prod Namespace>
BaseUrl="https://prod.accelbyte.io"
note

You can either input part or all of the config into your file. For example, you can input only the ClientId and ClientSecret for the specific environment if desired.

Unity​

To get started with Multi-Platform Credentials, you will need to install the AGS Game SDK for Unity.

First, create a specific OAuthConfig for your desired platform with the following naming format for the Client-side SDK:

AccelByteSDKOAuthConfig<Platform>.json

Use the following naming format for the Server-side SDK:

AccelByteServerSDKOAuthConfig<Platform>.json

Our supported platforms include:

  • Steam (Windows/Linux build)
  • Epic Games (Windows/Linux build)
  • Apple
  • iOS
  • Android
  • PlayStation 4
  • PlayStation 5
  • Live (Xbox build)
  • Nintendo
note

We recommend you only use either Steam or Epic Games. When these two platforms exist in the same directory, the Steam config will be prioritized.

Once completed, you can edit or generate the Client-side SDK config from the Unity Editor. You can do this by navigating to AccelByte > Edit Settings. Then, choose the Platform and Environment you want to edit and edit the config. Click Save to confirm your changes.

Last updated on

On this page