> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Setting up PlayFab authentication using Steam and Unity

> Step-by-step tutorial for adding Steam sign-in to a Unity game with the PlayFab SDK and Steamworks, covering AppID setup and player authentication code.

This tutorial guides you through the steps for logging into PlayFab using Steam through **SteamWorks** and Unity.

## Prerequisites

Before beginning, you should have:

* A Unity project with an imported PlayFab SDK, and a configured title ID.
* A Steam Application with:
  * The AppID already set up. The AppID can be acquired through the [Steam Direct (Formerly Greenlight)](https://partner.steamgames.com/steamdirect) process.
  * A Steam Publisher Web API Key. To generate a publisher key, follow [Creating a Publisher Web API Key](https://partner.steamgames.com/doc/webapi_overview/auth#create_publisher_key) in the **Steamworks** documentation.
* Familiarity with [Login basics and Best Practices](https://docs.xbox.com/services/playfab/identity/player-identity/login/login-basics-best-practices.md).

## Setting up a PlayFab title with Steam integration

To enable support for Steam authorization, PlayFab requires you to enable the Steam add-on.

Go to your **Game Manager** page:

1. Select the **Add-ons** menu item.
2. In the list of available **Add-ons**, locate **Steam** and select the title link:

![Game Manager Add-ons tab](https://mintcdn.com/microsoft-4404708b/mLCHf0iQv3VidfBe/images/playfab/identity/player-identity/platform-specific-authentication/tutorials/steam-unity/game-manager-addons-tab-steam.png?fit=max\&auto=format\&n=mLCHf0iQv3VidfBe\&q=85\&s=0a73a84c8672d5d3b437e64503483f1d)

1. Enter your **App ID**.
2. Enter the **Web API Key**.
3. Then select **Install Steam**.

![Game Manager install Steam Add-on](https://mintcdn.com/microsoft-4404708b/mLCHf0iQv3VidfBe/images/playfab/identity/player-identity/platform-specific-authentication/tutorials/steam-unity/game-manager-install-steam-addon.png?fit=max\&auto=format\&n=mLCHf0iQv3VidfBe\&q=85\&s=dfdcfff9e84cdabbe596107ad25e3822)

## Setting up a Unity project

Start by downloading the latest release of Steamworks.NET from the [Releases page](https://github.com/rlabrecque/Steamworks.NET/releases).

* Get the Unity Package version of the release, and import it into the project.
* Once you import the package, close Unity.
* Navigate to the **Project** root folder.
* Locate the **steam\_appid.txt** file.
* Open the file and replace the **App ID** value with your own.

![Unity project - Update AppId](https://mintcdn.com/microsoft-4404708b/mLCHf0iQv3VidfBe/images/playfab/identity/player-identity/platform-specific-authentication/tutorials/steam-unity/unity-project-update-appid.png?fit=max\&auto=format\&n=mLCHf0iQv3VidfBe\&q=85\&s=080b41d817e52a1728413f63da857637)

Re-open Unity and create a new scene.

Inside that scene, create a new **GameObject** called **Steam**:

1. Add a **SteamManager** component to the **GameObject**. This component is part of Steamworks.Net.
2. Create and add a **SteamScript** component to the **GameObject**.

![Unity project - Add Steam object](https://mintcdn.com/microsoft-4404708b/mLCHf0iQv3VidfBe/images/playfab/identity/player-identity/platform-specific-authentication/tutorials/steam-unity/unity-project-add-steam-object.png?fit=max\&auto=format\&n=mLCHf0iQv3VidfBe\&q=85\&s=125456b765664eca5ae44b75c48aa9fc)

The following example shows the code for the `SteamScript` component.

```csharp theme={null}
using System.Text;
using PlayFab;
using PlayFab.ClientModels;
using Steamworks;
using UnityEngine;

public class SteamScript : MonoBehaviour
{
    protected Callback<GetTicketForWebApiResponse_t> m_OnGetSteamAuthTicket;

    // Alternatively, you can use this callback if you choose to call SteamUser.GetAuthSessionTicket(...) instead
    // TicketIsServiceSpecific in the PlayFabLoginRequest should be false in this case
    // protected Callback<GetAuthSessionTicketResponse_t> m_OnGetSteamAuthTicketAlternate;

    private HAuthTicket m_hTicket;

    public void Awake()
    {
        m_OnGetSteamAuthTicket = Callback<GetTicketForWebApiResponse_t>.Create(OnGetSteamAuthTicket);
    }
    
    public void OnGUI()
    {
        if (GUILayout.Button("Log In") && SteamManager.Initialized)
        {
            GetSteamAuthTicket();
        }
    }

    private void GetSteamAuthTicket()
    {
        m_hTicket = SteamUser.GetAuthTicketForWebApi("AzurePlayFab");

        if (m_hTicket == HAuthTicket.Invalid)
        {
            Debug.Log("Failed to request steam auth ticket");
        }
        else
        {
            Debug.Log("Steam auth ticket requested");
        }
    }

    private void OnGetSteamAuthTicket(GetTicketForWebApiResponse_t pCallback)
    {
        Debug.Log("Steam auth ticket callback invoked");

        if (pCallback.m_eResult != EResult.k_EResultOK)
        {
            Debug.Log("Failed to get steam auth ticket: " + pCallback.m_eResult);
        }

        StringBuilder sb = new();
        for (int i = 0; i < pCallback.m_cubTicket; ++i)
        {
            sb.AppendFormat("{0:x2}", pCallback.m_rgubTicket[i]);
        }

        PlayFabClientAPI.LoginWithSteam(new LoginWithSteamRequest
        {
            CreateAccount = true,
            SteamTicket = sb.ToString(),
            TicketIsServiceSpecific = true
        }, OnComplete, OnFailed);
    }

    private void OnComplete(LoginResult obj)
    {
        SteamUser.CancelAuthTicket(m_hTicket);
        Debug.Log("Success!");
    }

    private void OnFailed(PlayFabError error)
    {
        SteamUser.CancelAuthTicket(m_hTicket);
        Debug.Log("Failed PlayFab login: " + error.GenerateErrorReport());
    }
}
```

## Testing

You may test right inside the editor:

1. Run the scene and select the **Log In** button.
2. The console message should appear after a moment, indicating the authentication result **Success!**.

![Unity test PlayFab login with Steam](https://mintcdn.com/microsoft-4404708b/mLCHf0iQv3VidfBe/images/playfab/identity/player-identity/platform-specific-authentication/tutorials/steam-unity/unity-test-playfab-login-with-steam.png?fit=max\&auto=format\&n=mLCHf0iQv3VidfBe\&q=85\&s=f5eafa1a09fb3673c292a617c027c69e)


## Related topics

- [Platform-Specific Authentication](https://docs.xbox.com/services/playfab/identity/player-identity/platform-specific-authentication/index.md)
- [Setting up PlayFab authentication using Facebook and Unity](https://docs.xbox.com/services/playfab/identity/player-identity/platform-specific-authentication/facebook-unity.md)
- [Setting up PlayFab authentication using Kongregate and Unity](https://docs.xbox.com/services/playfab/identity/player-identity/platform-specific-authentication/kongregate-unity.md)
- [Setting up PlayFab authentication using Universal Windows Platform](https://docs.xbox.com/services/playfab/identity/player-identity/platform-specific-authentication/uwp.md)
- [Setting up PlayFab authentication using Google and HTML5](https://docs.xbox.com/services/playfab/identity/player-identity/platform-specific-authentication/google-html5.md)