Skip to content

Initial Setup

When you first install Debby, you will be greeted with a Getting Started window, and a DebbySettings asset will automatically be created for you at Assets/Resources/DebbySettings.asset. The default configuration is all you need to get started, just run your project and explore the available features!

Important: The settings file must be in a Resources folder for Debby to find it at runtime.

Configuring Settings

Select your DebbySettings asset in the Project window to configure Debby. Settings have tooltips with more information.

Important Settings

  • Auto Load: When enabled, Debby will automatically be initialized. If you want more control disable this and initialize it manually.
  • Layout: Which layou mode debby should use.
    • Auto: Automatically switches between Landscape / Portrait based on aspect ratio.
    • Landscape: Always uses Landscape mode.
    • Portrait: Always uses Portrait mode.
    • Desktop: Always uses Desktop mode.
  • Force Desktop Layout In Editor: If true, Debby will always use the Desktop layout when running in the Editor.

Adding values / actions to Adjust

  1. Create a Context class and annotate members you want to expose in Adjust:
csharp
public class GlobalContext
{
    [Adjust]
    public float myFloat;
    
    [AdjustInt(Min = 0, Max = 100)]
    public int myInt;
    
    [Adjust]
    public void MyAction()
    {
        // ...
    }
    
    [Adjust]
    public Task MyActionAsync()
    {
        // ...
    }
}
  1. Register the Context after initializing Debby:
csharp
Debby.Initialize();
Debby.RegisterContext<GlobalContext>();

TIP

To learn how to use the full power of Adjust, see the Adjust documentation.