Overview

You can use Steam to authenticate users when the player logins to the game server, automatically connecting their Steam account to their Metaplay account and sharing progression with other devices that run your game through Steam.

Setup

To use Steam sign-in, you need to:

1. Create a Steam WebApi key.

   Follow instructions at https://partner.steamgames.com/doc/webapi_overview/auth#create_publisher_key.

2. Configure the game server to accept and validate Steam sign-in requests.

   In the relevant Options.<env>.yaml, set:

   Steam:
     EnableSteam: true
     AppId: [Your Steam application ID]
     PublisherAuthenticationKeyPath: [The Steam publisher authentication key created in step 1]

   💡 Pro tip

   We recommend using the AWS secret manager to store any sensitive secrets. See AWS Secrets Manager for more information!

3. Install Steamworks.net

   Follow instructions at https://steamworks.github.io/installation/.

   📌 Note

   If you choose to do "Manual Installation", please set the METAPLAY_HAS_STEAMWORKS define in the "Windows, Mac, Linux settings" in the Unity Project Settings.

4. Initialize the Steamworks.net library prior to initializing MetaplayClient as part of your game services initialization code.

   ...
   SteamAPI.InitEx(out var steamErrorMsg);
   ...
   MetaplayClient.Initialize(new MetaplayClientOptions());

   The SDK-provided default implementation of session credentials management in UnityCredentialsService.cs will automatically use Steam credentials when the SteamAPI is present and has been initialized.

5. Invoke Steam's RunCallbacks periodically.

   Add a call to SteamAPI.RunCallbacks() in your update.

Your users should now be able to login with Steam. If you take a look at your player's profile in the dashboard, you should see Steam as a login method under the Account Access & Logs tab.