Get started

Integrating with Xsolla servers is suitable for partners who want a ready-made server solution for monetization and in-game items management.

After integration of Xsolla SDKs, you can use:

• Xsolla Login for authenticating users and managing the friend system and user account
• In-Game Store for creating an in-game store and player’s inventory
• Player Inventory for managing player’s inventory in your application
• Xsolla Pay Station for setting up payments

With this integration, all operations are processed on the Xsolla side and you do not have to configure your own server side for these tasks.

Choose and install one of the following assets depending on your needs:

• Store Unity SDK — contains all the necessary methods to integrate all Xsolla products listed above.
• Login Unity SDK — designed to implement only the functions of the Xsolla Login.
• Inventory Unity SDK — designed to implement functions of the Xsolla Login and the Player Inventory. Use this asset if your application is published on a platform that cannot use the Xsolla Pay Station and In-Game Store for some reason.

Requirements

Features

Store Unity SDK features

• Xsolla Login
• In-Game Store (including Player Inventory)
• Xsolla Pay Station

• selling virtual items
• selling virtual currency
• managing in-game store
• working with promotional campaigns (discounts, coupons, promo codes)

Legal compliance

Privacy policy

If you use the SDK, add the Xsolla Privacy Policy Agreement link to your application. You can see the example of this link in the demo project on the sign up page.

Charge policy

Xsolla offers the necessary tools to help you build and grow your gaming business, including personalized support at every stage. The terms of payment are determined by the contract that can be signed via Publisher Account.

The cost of using all Xsolla products is 5% of the amount you receive for the sale of the game and in-game goods via the Xsolla Pay Station. If you do not use the Xsolla Pay Station in your application, but use other products, contact your Account Manager to clarify the terms and conditions.

Prerequisites

Before integrating Unity SDKs, follow these steps:

1. Install the asset.
2. Set up the project in your Publisher Account.

Install the asset

1. Download Unity.
2. Pick a personal or professional Unity license based on your preferences.
3. Create a new Unity project.
4. Download one of the assets:
   • Store Unity SDK. You can download it from the Unity Asset Store or GitHub.
   • Login Unity SDK. You can download it from the Unity Asset Store or GitHub.
   • Inventory Unity SDK. You can download it from the Unity Asset Store or GitHub.

5. Add a Xsollus demo scene in build settings:
   1. Go to Assets > Xsolla > DemoCommon > Scene and launch the Xsollus scene.
   2. Open File > Build settings and click Add Open Scenes.

6. Make sure that the Mono compiler is used for creating a game build (optional):
   1. Click Edit > Project Settings in the main menu.
   2. Go to Other Settings > Configuration block.
   3. Make sure that Mono is chosen in the Scripting Backend field.

After installing the asset, launch the Store demo scene that shows how SDKs features work.

Set up the project in your Publisher Account

1. Register an Xsolla Publisher Account.
2. Configure a Publisher Account project that is automatically created after the previous step:
   1. Click My game in the Projects block and go to Project settings.
   2. In setup mode, specify a Project name and click Save.

3. Go to Integration settings and check that the Integrate Commerce API toggle is set to On.

During the integration process, you will need the following parameters:

• Project ID found in Project settings > Project ID.

• Login ID found in Login settings > Login ID. It has the UUID format.

Demo

To demonstrate the functionality of integration with Xsolla servers, we provide the Xsollus demo scene. It is available in the Assets > Xsolla > DemoCommon > Scene > Xsollus folder. Use it as an example.

For the demo scene, a project in Publisher Account is preset and an in-game store is fully configured. When you launch the Xsollus demo scene, the sign-up/login page is displayed. If the authorization is successful, the main menu opens.

Default values for the Xsollus demo scene:

Continue reading