skillz-integration-tutorial-unity

This folder is meant to test different versions of the Skillz SDK on different versions of Unity (i.e. 2019, 2020, and 2021).

The recommended way to do this is by doing the following steps:

Copy any of the games in game-templates into the implementations folder using the steps in the 1. Clone a Game Template section.
- The game folders take the naming syntax of GAME_NAME-UNITY_VERSION (i.e. Driver-2019.4.35f1).
Follow the version specific Skillz SDK integration instructions from docs.skillz.com.
If you are integrating Firebase, follow the instructions in the Firebase section.

skillz-integration-unity

Driver Sample Unity Game

Driver is a simple driving game where the goal is to be able to drive for as long as possible without crashing. The longer you are driving, the bigger your score gets. Tap the left side of the screen to turn left and tap right to turn right.

The Driver game is based on one of the tutorials in a Unity 3D course from GameDev.tv. Specifically, it is based on this commit, which has been modified for the purposes of integrating the Skillz SDK.

In the game-templates folder, you will find the following versions of the Driver Game:

Each version of the game has the exact game logic in their respective Assets/Scripts directory. The main difference amongst them is the version of Unity (i.e. 2019) and the corresponding package versions.

Let's use Driver-2019.4.35f1 as an example to breakdown the folder structure that's relevant for the purposes of testing the Skillz SDK:

Assets
- Scenes
  - MainMenu.unity
    - This is the main menu scene.
    - The scripts in this scene are used to initialize the Skillz and Firebase SDKs.
  - Game.unity
    - This is the car gameplay scene.
    - After successful integration, the Skillz SDK will launch this scene.
  - FinalScore.unity
    - This scene gets called to show the final score after the gameplay has finished.
    - After successful integration, pressing the button in this scene will submit the final score to Skillz.
  - Progression.unity
    - This scene is used to show the Skillz Progression Data.
    - After successful integration, you will see the Skillz Progression data after submitting a match's final score to Skillz.
  - Track Assets.unity
    - This scene is used to track the assets from the game.
    - Not really relevant to Skillz integration.
- Scripts
  - MainMenu.cs
    - Used in the MainMenu scene to keep handle the button logic and Skillz Initialization logic.
  - SkillzGameController.cs
    - Used in the MainMenu scene to handle Skillz delegate logic.
  - CrashlyticsInit.cs
    - Used in the MainMenu scene to initialize Firebase Crashlytics.
  - CrashlyticsTester.cs
    - Used in the MainMenu scene to send Test Crashes to Firebase Crashlytics.
  - Car.cs
    - Used in the Game scene to handle car movement and crash logic.
  - ScoreSystem.cs
    - Used in the Game scene to handle the logic that keeps track of the score in-game.
  - FinalScore.cs
    - Used in the FinalScore scene to handle the logic that shows the final score on the screen and the logic that submits the score to Skillz.
  - Progression.cs
    - Used in the Progresion scene to handle the logic that shows the Skillz Progression data.
Packages
- This folder has the manifest.json file, which lists the versions of the packages that are specific to the Unity Version.
- This is perhaps what changes the most across the different Unity versions of the Driver game.
  - For example, the com.unity.device-simulator package is built into Unity 2021, but shows as 3.0.3-preview in Unity 2020 and 2019.

Integrate the Skillz SDK

Now that you understand the basics of the Driver game and the Unity project setup, in this section, let's integrate the Skillz SDK.

1. Clone a Game Template

Before you clone a game template, please close the Unity and Unity Hub applications.

To clone a game template, run the following steps in your terminal:

# Go to implementations folder
cd implementations

# Select your desired game (only Driver for now)
GAME_NAME="Driver"

# Select your Unity Version by uncommenting one of the versions below
#UNITY_VERSION="2019.4.35f1"
#UNITY_VERSION="2020.3.27f1"
#UNITY_VERSION="2021.2.10f1"

# Select your desired SDK version by uncommenting one of the versions below
#SDK_VERSION="27.2.8"
#SDK_VERSION="28.0.5"
#SDK_VERSION="28.0.11"
#SDK_VERSION="28.0.17"
#SDK_VERSION="28.1.4"
#SDK_VERSION="29.0.16"

# New Game Directory
GAME_DIRECTORY="${GAME_NAME}-${UNITY_VERSION}-SDK-${SDK_VERSION}"

cp -r "../game-templates/${GAME_NAME}-${UNITY_VERSION}" "./${GAME_DIRECTORY}"

# Go to your game directory
cd "./${GAME_DIRECTORY}"

# Remove any environment specific files
rm -rf .vscode Library Temp

# Remove the build directories
rm -rf Build
rm -rf Builds

You should have a clean copy of the game template.

2. Open the Cloned Unity Project

Now open Unity Hub and open the Unity Project in ${GAME_DIRECTORY}.

Unity Hub might ask you to install the specific version of Unity that this project was built with. Go ahead and let it install it and open the game with it.

You might be prompted to install an updated version of Unity. For the sakes of this tutorial and to avoid unnecessary complications, please stick to the version that the project was built with.

Once you open the game, feel free to test it on an Android or iOS Device to make sure it works properly before moving on with the next section.

3. Integrate the Skillz SDK

Up to this point, you should have a working Driver game with all of the following Skillz Logic implemented but commented out.

In this section, you will install the Skillz SDK in the Unity project and then go to each relevant file and enable the Skillz SDK logic. To do so, run the following steps:

Open docs.skillz.com and select the desired SDK version in the top left dropdown.
Follow steps 1-4 from the Install the SDK guide in your Unity Project.
- Make sure you add your Game ID in the Skillz Menu in Unity.
Follow the steps in the Step 5 - Build and Run section to deploy the Skill-enabled game to your iOS or Android Device.

If successful, you should be able to see the Skillz UI, Launch into a game, and see the final score on the Skillz UI.

Troubleshooting

If you are having issues opening a newly cloned Unity Project, try the following:

Close Unity and Unity Hub.
Delete the Library and Temp folders.
Open Unity again and open Project.

The above will rebuild the project from scratch, hopefully fixing all the dependency and caching issues.

Accepting Android License Agreements

Sometimes, when you are building and deploying an app to an Android device, you will get an error message asking you to accept the license for a given Android API version.

Every Unity installation comes with its own JDK and Android SDK installations. In order to properly accept the license for a given Android API, you need to use the specific Android SDK and JDK that corresponds to the specific Unity installation.

The following is meant to be a helper script to help you accept the SDK license for a single Android API using the Command Line on macOS:

# Get the exact Unity Version
UNITY_VERSION="2020.3.27f1"

# Set the Android SDK_ROOT variable using the Unity Version
SDK_ROOT="/Applications/Unity/Hub/Editor/${UNITY_VERSION}/PlaybackEngines/AndroidPlayer/SDK"

# Set the JAVA_HOME variable using the Unity Version
export JAVA_HOME="/Applications/Unity/Hub/Editor/${UNITY_VERSION}/PlaybackEngines/AndroidPlayer/OpenJDK/jre"

# Set the Android API variable
# This is the API that you need to accept the license for
API="android-28"

# Accept License using the sdkmanager tool in the SDK's root directory
"${SDK_ROOT}/tools/bin/sdkmanager" "platforms;${API}" --sdk_root=${SDK_ROOT}

You can also achieve the same result by opening the exported Android Studio project and using its GUI to accept the license there when prompted.

NOTE: You may need to perform the above steps for each Android API that requires you to do so.

Integrate the Firebase Crashlytics SDK

To integrate Firebase, follow the instructions in the Firebase section of the Skillz documentation.

Contributing

When contributing back to the Driver game, please make sure that the game logic is exactly the same on all versions of the Driver game in the game-templates folder. That way, when cloning a project, the user can just focus on Skillz SDK integration.

xinatcg / skillz-integration-tutorial-unity