Initialisation

Toolkit for Steamworks

You do NOT require any GameObjects to make Steamworks run. Steamworks Subsystem will automatically initalise your active app

If you prefer to initalise On Demand, you can configure the Subsystem accordingly in the Subsystem Settings. When in On Demand mode you must call Initialise … examples are below.

On Demand

SteamTools.Interface.Initialise();
Ready Check

You can check if the interface is ready to use by using the Interface class

private void Start()
{
    if (SteamTools.Interface.IsReady)
    {
        // Ready to go
    }
    else
    {
        // Not ready yet, listen for On Ready
        SteamTools.Interface.OnReady += Interface_OnReady;
    }
}

private void Interface_OnReady()
{
    // Ready now
}

Or you can use the “When Ready” feature.

private void Start()
{
    SteamTools.Interface.WhenReady(Interface_OnReady);
}

private void Interface_OnReady()
{
    // Ready Now
}
Debugging

To enable debugging from code, you can set:

SteamTools.Interface.IsDebugging = true;

This will cause it to be more verbose about things. In general, you would set this before you initialise, so you can get more verbose initialisation steps as well.

Code Free

If you need a code-free solution, we provide you with a component script which will initialise the Steamworks SDK for you based on your configured settings.

Initialise Steamworks

There are no settings needed; that is all handled by your configuration. You do not need to mark this object Do Not Destroy, It exists to do nothing more than call

SteamTools.Game.Initialise();

Rate This Article!