Skip to content

xsolla/commerce-cocos-sdk

Repository files navigation

This article can also be read in Chinese.

Easily embed Xsolla services with this ready-to-use library for games developed using Cocos Creator.

The SDK simplifies integrating Xsolla products into your Cocos Creator project by providing out-of-the-box data structures and methods for working with Xsolla API.

After integration, you can use:

  • Login to authenticate users and manage the friend system and user accounts.
  • In-Game Store for managing in-game purchases and player inventory in your application.
  • Pay Station for setting up payments.
  • Subscriptions to provide users with access to a package of services under specified conditions (subscription cost and duration).

Learn more about supported features →

To get started with the SDK, you need to install this extension and set up a project in Xsolla Publisher Account.

Go to the integration guide →

Features

Authentication

  • OAuth 2.0 protocol-based authentication.
  • Classic login via username/email and password.
  • Social login.
  • Login using a device ID.
  • Passwordless login via a one-time code or a link sent via SMS or email.

User management

  • User attributes to manage additional information.
  • User account.
  • Friend system.
  • Secure Xsolla storage for user data. Alternatively, you can connect PlayFab, Firebase, or your own custom storage.

INFO: You can also manage user accounts and access rights in Xsolla Publisher Account.

Catalog

  • Virtual currency:
    • Sell virtual currency in any amount or in packages (for real money or other virtual currency).
    • Sell hard currency (for real money only).
  • Virtual items:
    • Set up a catalog of in-game items.
    • Sell virtual items for real and virtual currency.
  • Bundles:
    • Sell bundles for real or virtual currency.
  • Promotional campaigns:
    • Reward users with virtual currency packages, game keys, or virtual items for coupons.
    • Give users bonuses or discounts on items in the cart with promo codes.
  • Sell items with one click or using the shopping cart.

INFO: You can add items in the catalog or manage campaigns with discounts, coupons, and promo codes via Xsolla Publisher Account.

Subscriptions

  • Selling subscriptions.
  • Subscription renewal and cancelation.
  • Subscription management from a user’s dashboard.

INFO: You can add and manage subscription plans via Xsolla Publisher Account.

Item purchase

  • Provide users with a convenient payment UI. The main features are:
    • 700+ payment methods in 200+ countries, including bank cards, digital wallets, mobile payments, cash kiosks, gift cards, and special offers.
    • 130+ currencies.
    • UI localized into 20+ languages.
    • Desktop and mobile versions.

INFO: Xsolla Publisher Account provides you with purchase analytics, transaction history, and other statistics.

Player inventory

  • Get and verify an inventory.
  • Consume items according to the in-game logic.
  • Spend virtual currency according to the in-game logic (for example, when opening a location or purchasing a level).
  • Synchronize all purchases and premium rewards of the user across all platforms.

Requirements

System requirements

  • 64-bit OS
  • Windows 7 and higher
  • macOS 10.9 and higher
  • Minimum supported version of Cocos Creator — 3.1.0

Target OS

  • Android
  • iOS
  • HTML5

The SDK uses Google Mobile Services and doesn’t support builds for devices without Google Mobile Services, such as Huawei.

Install SDK

  1. Go to Cocos Store.
  2. Choose Xsolla SDK in the Creator Extension > Plugins section.
  3. Click Get.
  4. Click Add To Project to launch Cocos Dashboard.
  5. In Cocos Dashboard, click Add To Project and select a project.
  6. In the modal window that appears, click Confirm to begin downloading the ZIP archive with the SDK.
  7. Unzip archive to your project’s assets folder.

Pricing

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 you can sign in Publisher Account.

Xsolla only charges 5% of the amount you receive for in-game purchases made through Xsolla Pay Station. If you don’t use Xsolla Pay Station in your application, but use other products, contact your Account Manager to clarify the terms and conditions.

Explore legal information that helps you work with Xsolla.

License

See the LICENSE file.

Contacts

Additional resources