Skip to content

Getting Started

Follow this setup guide once for every new Unity project. All other documentation assumes these steps are already completed.

1. Install Unity dependencies

The SDK needs Newtonsoft.Json for save serialisation. Install it via Window → Package Manager → + → Add package by name:

  • com.unity.nuget.newtonsoft-json

For console-specific package and middleware requirements, see each platform's setup page - they vary per target.

2. Import the Core package

Import UpscaleSDK-Core.unitypackage from your distribution into the project. It contains:

  • Assets/UpscaleSDK/BootstrapScene - the runtime bootstrap scene
  • Assets/UpscaleSDK/Core - all cross-platform modules (Input, Saves, UI, Configuration, Utils, Validator)
  • Assets/UpscaleSDK/Platform/Desktop - the Desktop platform layer

3. Import the platform packages you ship on

Import the per-platform .unitypackages for every target you build. Each platform page lists the extra packages, assembly definition references, and middleware its layer needs:

4. (Optional) Import samples and extras

  • UpscaleSDK-Samples.unitypackage - runnable example scenes for Input, Saves, and UI (see Samples)
  • UpscaleSDK-Extras.unitypackage - optional content under Assets/UpscaleSDK/Extras

5. Add the Bootstrap scene

Open Assets/UpscaleSDK/BootstrapScene and add it as the first entry in Build Settings → Scenes In Build.

6. Configure the SDK

Create or locate the UpscaleSDKConfig asset at Resources/UpscaleSDK, name it Config and fill in the fields you need:

  • Saves Settings - autosave interval, file extension, container / save size per platform (see Manual → Saves → Setup)
  • GamepadIconsSet references - one glyph set per controller model (DualSense, DualShock 4, Xbox Controller, Switch Pro Controller, Joy-Cons) used by the Input module (see Manual → Input → Glyphs)
  • KeyboardIconsSet / MouseIconsSet references - glyph sets for Desktop targets

7. Verify with the Validator

Run Tools → UpscaleSDK → Validate Project and resolve any reported issues before building.

Next steps

  • Input - action-based gamepad input
  • Saves - cross-platform key/value persistence
  • UI - controller-friendly menu navigation
  • Validator - build-time project checks