Skip to content

Latest commit

 

History

History
136 lines (87 loc) · 5.93 KB

README (SDK).md

File metadata and controls

136 lines (87 loc) · 5.93 KB
Raw

The SDK makes it easier to integrate Xsolla products into your Unreal Engine 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 account
  • 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 start with the SDK, you need to install this plug-in and set up a project in Xsolla Publisher Account.

Go to the integration guide →

Features

Authentication

  • OAuth 2.0 protocol-based authentication.
  • Classic login (username/email and password).
  • Social login.
  • Social login on the user’s device via a social network client.
  • Login via a launcher (Steam or Xsolla Launcher).
  • Login via a device ID.
  • Passwordless login via a one-time code or a link sent via SMS or email.
  • Xsolla Login widget that currently supports classic, social, and passwordless login. The widget opens in the built-in browser and can’t be used for native social login.

User management

  • User attributes to manage additional information.
  • Cross-platform account linking.
  • Secure Xsolla storage for user data. Alternatively, you can connect PlayFab, Firebase, or your custom storage.

INFO: You can also manage user accounts and access rights via 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 apply a discount on items in the cart with promo codes.

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

  • Sell items in one click or via the shopping cart.
  • 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 game logic.
  • Consume virtual currency according to the in-game logics (for example, when opening a location or purchasing level for some currency).
  • Synchronize all purchases and premium rewards of the user across all platforms.

Requirements

System requirements

  • 64-bit OS
  • Windows 7 and later
  • macOS 10.13.6 and later
  • XCode 11.1 and later (for macOS)
  • Visual Studio 2017 and later
  • Unreal Engine 4.27 and later

Target OS

  • iOS
  • Android
  • macOS
  • Windows 64-bit

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

NOTE: To modify the SDK for your application specifics, follow the SDK modification instruction.

Usage

To send requests to Xsolla servers and receive responses, the SDK provides the XsollaStoreSubsystem, XsollaLoginSubsystem, and XsollaInventorySubsystem classes. If you want to implement your own logic for buying items or inventory management, and don’t want to write boilerplate code for API calls, these classes are a good place to start.

Follow the step-by-step tutorials to get started with basic SDK features.

Explore code reference documentation to learn more about SDK methods.

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 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 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