1. Set up the development environment

Download the starter code

To begin this tutorial, download the starter code for the Immutable Runner game from GitHub.

1. Install git-lfs since some large game assets are stored on Git Large File Storage.
2. Clone the sample-unity-game repository.

The repository contains multiple branches, each representing a snapshot for each step in the tutorial. The starter code is available in the branch named step_00 (accessible via this link).

You can skip ahead or check what a specific tutorial step should look like by switching to the relevant branch. or instance, if you'd like to view the complete code after finishing step 3, you can switch to the step_03 branch to see it.

The complete game, including all tutorial steps, can be found in the complete branch.

Set up the game

1. Open the cloned sample-unity-game project in your preferred IDE.
2. Switch to branch step_00.
3. Open the Unity Hub application.
4. In the Projects tab, click the Add button and open the sample-unity-game/ directory.

5. Click on sample-unity-game to open the game in the Unity Editor.
6. In the Project window, search for Boot.
7. Start the game by double-clicking the Boot file and clicking the Play button at the top middle of the Unity Editor window.

Install the SDK

1. You'll need to include our dependency, UniTask version 2.3.3. This can also be installed using the Git URL method.
2. To integrate the Immutable Unity SDK Passport package into your game, we recommend using the Git URL method via the Unity Package Manager (UPM) for a straightforward setup.