FirstLook

https://docs.firstlook.gg/
Admin
FirstLook is a platform that helps game studios understand and engage their audiences through player...
Tokens:46,847
Snippets:943
Trust Score:7.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start Session with Unity SDK

Source: https://docs.firstlook.gg/setup/sdk-setup/unity

Initiate a session using StartSessionAsync or AuthenticateAndStartSessionAsync. The SDK tracks the session until explicitly ended or the app closes.

```csharp
StartSessionAsync();
```

```csharp
AuthenticateAndStartSessionAsync(...);
```

--------------------------------

### Duration Schema Example

Source: https://docs.firstlook.gg/player/analytics/cloud-events

Use this schema for timed activities such as match length or menu navigation. Requires session, start, end times, and a duration name.

```csv
steam_id,session_id,start_time,end_time,duration_name
76561198012345678,a1b2c3d4-e5f6-7890-abcd-ef1234567890,2026-01-15T14:00:00Z,2026-01-15T14:25:00Z,match.round
76561198012345678,a1b2c3d4-e5f6-7890-abcd-ef1234567890,2026-01-15T14:26:00Z,2026-01-15T14:28:00Z,menu.loadout
76561198087654321,b2c3d4e5-f6a7-8901-bcde-f12345678901,2026-01-15T15:00:00Z,2026-01-15T15:45:00Z,match.round
```

--------------------------------

### Post a Counter Event in Unreal Engine

Source: https://docs.firstlook.gg/setup/sdk-setup/unreal

Example of posting a counter event from a UCommonActivatableWidget to track a hero selection. Ensure the UFirstLookSubsystem is accessible.

```cpp
void UMainMenu::HandleSendCounterEventClicked()
{
    if (ULocalPlayer* OwningLocalPlayer = GetOwningLocalPlayer();
        OwningLocalPlayer != nullptr)
    {
        if (UFirstLookSubsystem* FirstLookSubsystem =
            OwningLocalPlayer->GetSubsystem<UFirstLookSubsystem>)
        {
            FirstLookSubsystem->PostCounterEvent("loadout.hero-a-selected", 1);
        }
    }
}
```

--------------------------------

### Initialize and Authenticate with Steam

Source: https://docs.firstlook.gg/setup/sdk-setup/unity

Use this snippet for host-owned Steam integrations. Ensure Steamworks is initialized before calling. Logs errors if Steamworks is not installed or the ticket is unavailable.

```csharp
using Pragma.FirstLook;
using UnityEngine;


public sealed class FirstLookStartup : MonoBehaviour
{
    [SerializeField] private FirstLookSettings firstLookSettings;


    private FirstLookClient _client;


    private async void Start()
    {
        var settings = firstLookSettings != null
            ? firstLookSettings
            : Resources.Load<FirstLookSettings>("FirstLookSettings");


        if (settings == null)
        {
            Debug.LogError("[FirstLookStartup] Missing FirstLookSettings.");
            return;
        }


        _client = FirstLookBootstrap.InitializeWithSettings(settings);


#if FIRSTLOOK_STEAMWORKS
        var ticket = FirstLookSteamHelper.GetSessionTicket();
        if (string.IsNullOrWhiteSpace(ticket))
        {
            Debug.LogError("[FirstLookStartup] Steam ticket unavailable. Make sure Steamworks is initialized first.");
            return;
        }


        var result = await _client.AuthenticateAndStartSessionAsync(
            FirstLookAuthRequest.Steam(ticket, FirstLookSteamHelper.GetAppId()));


        if (!result.Success)
        {
            Debug.LogError($"[FirstLookStartup] FirstLook startup failed: {result.AuthResult?.Error}");
            return;
        }


        Debug.Log($"[FirstLookStartup] FirstLook ready. Session: {result.SessionId}");
#else
        Debug.LogError("[FirstLookStartup] Steamworks.NET is not installed.");
#endif
    }
}
```

--------------------------------

### Start and End Duration Event for Match in Unreal Engine

Source: https://docs.firstlook.gg/setup/sdk-setup/unreal

Example of tracking match duration by calling StartDurationEvent at the beginning and EndDurationEvent at the end of a match. This requires iterating through player controllers to access the subsystem.

```cpp
void AMyGameMode::OnMatchStart()
{
    for (APlayerController* PC : GetWorld()->GetPlayerControllerIterator())
    {
        if (ULocalPlayer* LP = PC->GetLocalPlayer())
        {
            if (UFirstLookSubsystem* FirstLook = LP->GetSubsystem<UFirstLookSubsystem>())
            {
                FirstLook->StartDurationEvent("match.round");
            }
        }
    }
}


void AMyGameMode::OnMatchEnd()
{
    for (APlayerController* PC : GetWorld()->GetPlayerControllerIterator())
    {
        if (ULocalPlayer* LP = PC->GetLocalPlayer())
        {
            if (UFirstLookSubsystem* FirstLook = LP->GetSubsystem<UFirstLookSubsystem>())
            {
                FirstLook->EndDurationEvent("match.round");
            }
        }
    }
}
```

--------------------------------

### Add FirstLookSDK as a Dependency in Build.cs

Source: https://docs.firstlook.gg/setup/sdk-setup/unreal

Include the FirstLookSDK plugin as a private dependency in your game's Build.cs file.

```csharp
PrivateDependencyModuleNames.AddRange(new string[] {"FirstLookSDK"});
```

--------------------------------

### Declare UFirstLookSubsystem Methods

Source: https://docs.firstlook.gg/setup/sdk-setup/unreal

Declare the necessary methods for posting counter events within the UFirstLookSubsystem class.

```cpp
UCLASS()
class FIRSTLOOKSDK_API UFirstLookSubsystem : public ULocalPlayerSubsystem
{
public:
    // ...
    UFUNCTION(BlueprintCallable, Category = FirstLook)
    void PostCounterEvent(FString CounterName, int32 Count);
    // ...
}
```

--------------------------------

### Start Custom Duration Event

Source: https://docs.firstlook.gg/setup/sdk-setup/unity

Call `StartDurationEventAsync` when an activity begins to track its duration. The SDK handles timing and delivery.

```csharp
public async void OnMatchStart()
{
    if (_client == null || !_client.IsSessionActive)
        return;


    await _client.StartDurationEventAsync("match.round");
}
```

--------------------------------

### Declare Duration Event Methods in UFirstLookSubsystem

Source: https://docs.firstlook.gg/setup/sdk-setup/unreal

Declare the methods for starting and ending duration events within the UFirstLookSubsystem class.

```cpp
UCLASS()
class FIRSTLOOKSDK_API UFirstLookSubsystem : public ULocalPlayerSubsystem
{
public:
    // ...
    UFUNCTION(BlueprintCallable, Category = FirstLook)
    void StartDurationEvent(FString DurationName);


    UFUNCTION(BlueprintCallable, Category = FirstLook)
    void EndDurationEvent(FString DurationName);
    // ...
}
```
Tokens:
Raw