Unity SDK

Our Unity SDK uses a special version of the C# SDK. It uses UnityWebRequest instead of standard .NET requests and comes with some other customizations that are required for WebGL support. It mostly provides UI code and prefabs that you can use as a starting point for your SCILL integration directly into your game.

Our Unity SDK offers a quick “go to market” solution that you can just “drag & drop” into your game. The prefabs we provide are fully functional and handle all the heavy lifting with the SCILL cloud. They are completely open-source, and you are welcomed to adjust them to your own needs. Prefabs quickly can be adjusted to your games UI with prefab variants.

The main functionality is implemented by the classes, but virtual functions allow you to quickly make adjustments by overriding these classes and methods to adjust certain aspects of our implementation.

Video Tutorial#

David Liebemann (CrystalMesh) has compiled an easy to follow and understandable video tutorial on how to add SCILL to your game and guides you to the first steps of leveraging our great tool kit to quickly integrate high-tech features like cloud based realtime challenges and leaderboards.

Click the videos below to watch “SCILL Unity SDK Quickstart " or just jump to the Video Tutorial Playlist on youtube.

Part 1 - The Admin Panel#

Contains useful information about the admin panel independent of chosen SDK!

Part 2 - Integration and Base Setup#

Part 3 - Challenges and Events#

Part 4 - Leaderboards#

Part 5 - Battle Passes#

Part 6 - Integrating Audio Feedback#

Part 7 - Integrating Visual Feedback#

Production Ready Prefabs#

Our Unity SDK comes with fully working prefabs and samples with complete implementation of a battle pass and challenges. We have used Game Assets from Kenney for the samples, which are slim and awesome. Thank you very much Kenney for making those public domain.

This is a screenshot of the fully working Battle Pass UI Prefab with reward selection, realtime challenges and progress tracking.

SCILL also offers simple challenges that can be utilized for many things like “Weekly Challenges”, giving your players enough to do each week and also allows users to collect rewards, coins and/or experience points.

Source Code#

You can find the source code to our Unity SDK in our public Github repository: https://github.com/scillgame/scill-unity. If you encounter any bugs or issues, please let us know in the Issues tab of Github.

If you fix a bug in our code base, please commit your bugfix in a separate branch and create a merge request with a short description what you have fixed. Of course, we will credit you and your game in the changelog and at the start page of our Github repository in this case!

Installing the SDK#

You have the various methods to install the Unity SDK.

• Using the Package Manager (recommended)
• Unity Package
• Download and “merge” with your Project.

Package Manager#

Using the package manager will ensure that all dependencies are set up correctly and that you will have the most up to date version of our SDK. In most cases, using the Package Manager is the way to go.

Adding from git URL#

In Unity click on the menu Window -> Package Manager to open the Package Manager. In the Package Manager window, click on the + button and choose Add package from git URL ..., with this URL: https://github.com/scillgame/scill-unity.git?path=/unity-package

Don’t forget to also import the Sample 1 into your project if you’d like to test and change the sample scenes we created for you.

To update the SCILL Unity SDK, just add the package using the git URL method again - the Package Manager will automatically update the current local version to the newest available version in the repository.

Adding from disk#

For this method you will need to first clone the SCILL Unity SDK from our github repository. In the Package Manager window, click on the + button and choose Add package from disk .... Navigate to the \unity-package directory within the local repository on your device and select the package.json file. Unity will then import the package and resolve the dependencies.

The advantage is, that you can pull new versions of our SDK and you can also directly work on the source code. So if you find and fix a bug, you can submit it to your fork and send a pull request to us, describing the changes you made. This way we can review your code changes and integrate them into our main branch. Of course, we will credit you and your game in the changelog and at the start page of our Github repository in this case!

Unity Package#

Please download the SCILL Unity SDK as a .unitypackage from our Github releases page. Download: SCILL-Unity-SDK.unitypackage

Because Unity does not resolve dependencies automatically when importing Assets as a .unitypackage, you will need to ensure that Unity’s Newtonsoft-JSON package has been added to your project. To add the Newtonsoft package to your project, navigate to the Package Manager by using the Window -> Package Manager menu. In the Package Manager window, click on the + button, choose Add package from git URL ... and enter the package reference: com.unity.nuget.newtonsoft-json

Download and add source code#

You can also download the ZIP file from Github and add the contents of the ZIP file into your Unity Asset folder. This way, our SDK will be “merged” with your project. If you commit your code to a Version Control System (like Git) then you will commit SCILL source files into your own repo.

Which way to choose?#

It depends on how you want to leverage SCILL. If you want to use our SDK as is and don’t plan to change much yourself, then it’s best to use the Package Manager approach. You will profit from new features by just pulling the latest version in the cloned repo.

If you want to heavily change SCILLs code or prefabs, it’s perhaps best to merge the code into your codebase. This way it will be perhaps a bit harder to get new features, but if you plan to build on top of our code, you will most likely have built them either yourself or you don’t care.

Using the Samples#

In the Sample 1/Scenes folder we have prepared a couple of scenes you can try out. These samples are linked to an example App. You may see the battle pass or challenges not in a fresh state, as the sample scene uses a hard coded user id for testing. In this case please select the SCILL Manager GameObject in the hierarchy of the sample scene and change the User Id setting to something random. When leaving the User Id field empty, the SCILLManager Script will attempt to use your device unique identifier.

After that, you’ll see the battle pass or challenges in a fresh state (of course if nobody before chose that user id before).

Replace the API-Key and App-ID in the SCILL Manager settings with your own values et voilà: You have a fully working battle pass!

Of course, there are various other ways to add our SDK to Unity:

Personal Challenges#

Challenges are a nice way of adding user interaction into your game by letting users pick challenges and pickup rewards once they have achieved those challenges. Personal Challenges are defined like this:

• Need to be unlocked and activated (not necessarily by users)
• Have a duration (in minutes)
• Can be repeatable - users can try over and over again, or they are a one-shot

Follow this Step-by-Step guide to add Personal Challenges to your game.

That’s it. You have added SCILL Personal Challenges to your game.

We have prepared a much more detailed guide with screenshots and code examples in this example integration:

Tanks (Unity)

We took this simple but fun open source Unity tank game and added challenges to it. Use our example code as a starting point for your own Unity based project.

Learn more

Battle Passes#

Our Battle Passes are built on top of the challenge system, but they can both co-exist in a game. Fortnite for example combines both elements with weekly challenges to earn coins and battle passes as a monetization tool, delivering great and unique rewards only available in battle passes that users must purchase.

Our battle pass system is very flexible yet easy to implement:

• Battle Passes have a start and end date, which allows you to sell multiple battle passes per user with a seasoning approach.
• Battle Passes are compiled of levels that can have a reward
• Levels are locked by default (the first level is unlocked once the battle pass is unlocked for the user)
• Levels contain one or more challenges which must all be achieved before the level is complete
• Completed levels automatically unlock the next level and users can claim the reward.

It depends on your game how deep you want to integrate our battle pass system. You can either add it as a monetization feature but you can also control the flow of your game using our battle passes. For example you can connect your maps or levels to the battle pass levels, that is, users first need to unlock a certain level in the battle pass before they can play a new map.

Follow this Step-by-Step guide to add Battle Passes to your game. Please note: That’s a very detailed description of what you should do. You’ll have a basic but fully functional battle pass integrated into your game within 1-2 hours!

That’s it. You have added SCILL Battle Passes to your game.

Leaderboards#

Leaderboards are a must have for each and every game. It’s the simplest and yet one of the most powerful tools for user retention. Core features of our leaderboards:

• Driven by the events you already send to SCILL
• Define the sort order, events types to process - that’s it

Follow this Step-by-Step guide to add Personal Challenges to your game.

That’s it. You have added a SCILL leaderboard to your game.

FAQ#

A couple of answer to typical questions:

How to handle date objects?

The dates in the responses can be converted to native C# Date objects using this code:

var date = DateTime.Parse(challenge.user_challenge_activated_at);