In the Unity Editor, open the Package Manager.

In the Package Manager, open the + menu and select Add package from git URL and enter this GitHub URL:

https://github.com/Main-Tank-Software/bugquest-unity.git

Git must be installed and available in your system's PATH.

For more details please seeInstall a UPM package from a Git URLin the Unity documentation

After the library is installed the Setup window should automatically appear. If it does not, open it by selecting BugQuest.GG under the Window menu.

Click the green Setup button to setup the library in your project.

This will automatically:

• Get an API key for your project
• Create a GameObject in your current scene
• Create a link to our website to quickly setup an account associated with this project

Your game's first scene must be loaded in the Unity Editor when you click Setup. This allows the BugQuest GameObject to load immediately when the game launches.

Click the link that appears or copy it to your clipboard and paste it in a browser window. This will take you to the web interface where you can quickly create an account and view your errors.

Replays let you record gameplay videos that will be available in the BugQuest dev console. Use them to capture moments around player actions or bugs.

public void StartBossFightReplay()
{
    if (!BugQuestAPI.IsReplayRecording())
    {
        BugQuestAPI.StartReplay("BossFight");
    }
}

public void StopBossFightReplay()
{
    BugQuestAPI.StopReplay(onlyKeepLastMinutes: 5);
}

Error clips are short videos automatically captured when the game encounters an error. They are enabled when the game starts but may be disabled or re-enabled at runtime using these methods.

BugQuestAPI.EnableErrorClips();

BugQuestAPI.DisableErrorClips();

BugQuestAPI.Disable();

BugQuestAPI.DisableAllVideoFeatures();