Go to dashboard

Installing Sphere Kit

Install and configure Sphere Kit services in your game.

Sphere Kit has been split into multiple packages to allow you to implement the specific services that you need in your game.

Required:

Package name
Git URL
Purpose

sphere-kit-core-sdk

https://github.com/project-quik/sphere-kit-core-sdk.git

Controls essential configuration, error handling, as well as the Authentication and Achievements services.

Optional:

Package name
Git URL
Purpose

sphere-kit-database-sdk

https://github.com/project-quik/sphere-kit-database-sdk.git

Retrieve, query and write data from our fast and scalable NoSQL database.

Adding the necessary packages

To install Sphere Kit, you must minimally install the sphere-kit-core-sdk package. However, you can take this opportunity to install the other packages that you are going to use as well.

1

Open the Package Manager

The package manager is found in Window > Package Management > Package Manager.

2

Add your desired package

Click the + button, then select "Install package from git URL...".

Paste the Git URL of your desired package from the table above, then click the Install button.

Configuring Sphere Kit

You will now need to configure some settings to connect this game to your Sphere Kit project.

1

Open the Project Settings

The Project Settings window is found in Edit > Project Settings...

2

Open the Sphere Kit panel

3

Fill in the details

In the Sphere Kit Dashboard, navigate to the Settings tab on the sidebar, then look for the Client ID and Project ID, and copy these fields into the Unity settings panel.

Set the Server URL to https://api.kit.sphereapp.co/v1.

The other fields can be left empty for now.

Your configuration should look like this:

You're set! You can now start developing with Sphere Kit. Good luck and have fun!

PreviousWelcomeNextPreparing Sphere Kit

Last updated