Skip to content

Step 1. Set up the integration

To log in with a Steam account, you must complete the external console and Hive Console settings and install the Add-ons that match the OSs your app will support. After you finish preparing, implement Step 2. Log in.

1. Prepare credentials in Steamworks

Prepare the Publisher Web API Key and the Steam App ID in Steamworks.

2. Register credentials in the Hive Console

Enable Steam login and register the Publisher Web API Key. For the detailed procedure, see Steam login credentials.

You do not enter the Steam App ID in the login settings. Register it as the Store App ID of the App ID for the Steam store in Register the Store App ID.

3. Install the Add-on

Install the Add-ons that match the OSs your app will support.

  • Windows, macOS: com.com2usplatform.hiveaxyl.auth.addon.steam
  • Android, iOS: com.com2usplatform.hiveaxyl.auth.addon.webauth

For how to install and initialize them, see Install and initialize the module.

4. Initialize Steamworks

On Windows and macOS, the Steam login Add-on receives the authentication ticket through Steamworks. The Hive Axyl SDK does not initialize Steamworks, so the app must initialize and maintain it itself.

The SteamAPI used for initialization is provided by com.rlabrecque.steamworks.net, an external package that the Steam login Add-on brings in together with the com.com2usplatform.hiveaxyl.steamworks package. Add using Steamworks; to use it.

  1. Call SteamAPI.Init() once when the app starts.
  2. Call SteamAPI.RunCallbacks() every frame to process Steamworks callbacks.
  3. If you run the app outside the Steam client for development, place a steam_appid.txt file in the same location as the executable and write the Steam App ID in it.

If you call the Add-on before initialization, the result is returned as Failure, and Failure.Problem.Code contains FailedPrecondition.

5. Prepare the app callback on Android and iOS

On Android and iOS, you open the Steam login page with a web login session. Because Steam does not send the login result back to the app's own scheme URL, Steam's response returns to the app callback URL {appId}://oauth-callback through the Hive Axyl relay URL.

On Android, the App ID is the scheme of the app callback URL; register it in the build settings. iOS requires no additional settings. For request composition and callback handling, see Step 2. Log in.

Next steps