Release Notes#

Release Highlights#

XBE 2024-12 Release Notes Banner

Social v3#

We’re very excited to announce Social v3, a significant expansion of the component now including profanity filtering across all content, a brand-new social network, an Activity & News Feed system, and Realtime Communication with support for text chat, voice and video conferencing.

Activity & News Feed#

Social v3 activity feed

With the introduction of the Activity and News Feed, you can now create a dynamic social network for your player community. Players can post content to their activity feed, including media attachments such as photos and videos. Other users can engage by commenting, reacting with emojis, or resharing content with their friends and followers. Posts also include comprehensive visibility controls, allowing players to manage who can view or share their content.

The News Feed provides an integrated view of your social community, filtering content based on friends and following lists while excluding blocked users. Its simple, predictable algorithm ensures players see only the content that matters to them. Key features include:

  • Posts: Share updates and activities with the community

  • Comments: Engage in conversations by commenting on posts

  • Reactions: Express emotions with emojis on posts and comments

  • Media Attachments: Upload photos or videos to highlight your gaming moments

  • Reposts: Amplify content by resharing posts with your network

  • News Feed: Stay connected by exploring updates from friends and followers in real time

Realtime Communication#

The new Realtime Communication system brings text chat, VOIP, and video conferencing to your game or application, providing an immersive and seamless communication experience.

Social v3 realtime communication

Key features include:

  • Text, Voice, and Video: Empower players to connect in real time using text, voice, or video chat within the same channel

  • Multiple Channels: Enable users to join and participate in multiple channels simultaneously

  • Moderator Support: Allow channel owners to manage permissions, assign moderators, ban users, and more

  • Reactions: Let users respond instantly to messages with emojis, creating engaging and interactive conversations

  • Threading Support: Organize discussions with sub-threads for deeper and focused interactions

  • Typing Indicator: Show when someone is typing in a channel or thread to improve communication flow

  • Proxy Server: Overcome firewall and routing issues with the built-in proxy server for VOIP and video calls

  • Integration: Add realtime chat functionality to your game or party sessions with ease

Profanity Filtering#

Social v3 now includes automatic profanity filtering across all user-generated content. Key features include:

Social v3 profanity filtering

  • Activity Posts & Comments

  • Channel Messages

  • Player-to-Player Mail

  • Profile Aliases

  • Relationship Aliases

Mail#

The system previously known as Player-to-Player Messaging has been renamed to the Mail System in order to avoid confusion with the new Realtime Communication system.

As a result, all related APIs have been updated to reflect this new terminology and naming conventions.

Relationships#

The system previously known as UserLinks has been renamed to the Relationships System. We hope that this new name will reduce confusion and improve understanding of the purpose of the feature among developers.

All related APIs and SDKs have been updated to reflect this new terminology and naming convention.

Enhanced Console Features#

Console’s latest enhancements focus on simplifying workflows and boosting productivity. Bulk import functionality now allows seamless integration of large datasets, reducing manual effort and providing realtime feedback during the process. Leaderboard management has become more intuitive, offering precise search and editing capabilities for specific leaderboard definitions. More localization support further expands usability, while improved error handling and polished UX elements ensure a smoother, more-reliable experience across the platform.

These improvements aim to speed up tasks, reduce manual effort, and improve accessibility across different environments. Key features include:

Bulk creation of entities through CSV/JSON imports#

We are excited to introduce a new feature to the Console that enables bulk creation of entities directly from CSV or JSON files:

Console bulk create csv|json button

This enhancement streamlines the onboarding process by allowing users to efficiently import large datasets into the system:

Console bulk create csv|json flow

Some of these key features include:

  • File Format Support: Users can upload data in either CSV or JSON formats with the same formats currently supported for export to allow easy upload between different environments:

    Console bulk file format support

  • Realtime Feedback: Progress tracking provides real-time updates on the import process, ensuring per-entry transparency with realtime monitoring:

    Console bulk realtime feedback

  • Partial Imports: For files with entry errors, the system supports partial imports by allowing users to skip invalid rows or make adjustments to entries that may have errored during the import process:

    Console bulk partial imports

  • Bulk Actions: Post-import, users can apply bulk actions to the imported entries in a reviewable panel of entries that have been successfully imported.This new feature simplifies data management and accelerates workflows, reducing what’s otherwise a manually intensive process for large data entry

    • Start leveraging bulk imports with the December release to accelerate faster development!

Improved LeaderboardRecords Management#

Users now have the ability to search records by LeaderboardDefinition to easily review, modify, search and export specific Leaderboards in real time:

Console leaderboard definition search

New Language Support#

Added Korean language support:

Console Korean language support

Enhanced UX#

Enhanced delete behavior, error handling, and UX styles across all views:

Console Improved UX

Improved Documentation & Developer Tools#

  • Revamped SDK references and quickstart guides for C++, C#, and Unreal

  • Introduced new tutorials, including an economy component guide and a leaderboard guide

  • Added high-level Kubernetes and containerization knowledgebase articles

Expanded Node.js SDK Functionality#

  • Added WebSocket API and NotificationServer API for realtime communication and push notification management

  • Introduced EntityWatchdog to Node.js SDK to match offerings in other SDKs

  • Introduced new Social v3 models and services, including Agreements and enhanced user linking

Bug Fixes & Quality Improvements#

  • Improved build pipelines and resolved critical Linux compatibility issues in SDKs

  • Fixed several asset upload, validation, and rendering issues across applications and services


Warning

Compatibility and Breaking Changes

  • Social Services v3 Renames:

    • MessageMail

    • UserLinkRelationship

  • Quest Services QuestReward Renames:

    • quantityvalue

    • entityUidentity

Please see changes in each SDK update for full list of breaking changes per component


Service Updates#

The following services have changed:

account_services | v3.2.0#

  • Added generate shortId to Organization

  • Added checks to verify User.roles is an array

economy_services | v3.2.0#

  • Added ability to do lookup inventory by bank:name

  • Added ability to do a transaction from bank using bank:name

  • Restrict -1 quantity transactions to be to the bank

  • Added more error handling/reporting to TransactionRoute

  • Openapi docs updates

purchasing_services | v3.0.0#

  • Upgrades to latest ComposerJS libraries

  • Added versionUid to Product to provide a link to a ProductVersion

  • Openapi docs updates

  • Added new Models, Routes:

    • Agreements, Agreement Signatures

      • Ability to have such versioned agreements as a EULA presented to the Users and storing a digital, binary or text signature

    • Download Info

      • Provides ability to information about a downloadable software version, including size, checksum and download url

    • Product Version

      • Store download info, notes and the semantic version for a Product

quest_services | v3.0.0#

  • Added Quest rewards processing for Quest/Skill Progress and Item reward

  • Change Quest Reward models:

    • Quantity -> Value

    • EntityUid -> Entity

  • General quest progress fixes and clean up

  • Openapi docs updates

service_monitor | v4.0.0#

  • Added support for sending cluster information to SaaS

social_services | v3.0.0#

Warning

Breaking API Changes for class & property renames:

  • Model, Route Changes:

    • Classes were renamed:

      • MessageMail

      • UserLinkRelationship

      • MessageServiceMailService

      • UserLinkServiceRelationshipService

    • Introduced concept of Channels for real-time messaging

    • Content sent on Channels now is referred to as Message

  • Added new Models, Routes:

    • Channel and Message

    • Provides single-thread for RTC, supporting text, voice and/or video. Allows the ability to be nested through threading

      • Support moderators, topics, typing indicators, etc

    • Post

      • Provides ability for a user to post to through activity feed

    • Comment

      • Provides ability to leave a comment on a user Post

    • Reaction

      • Allows a user to react with an emoji to a Post or channel Message

  • Upgrades to latest ComposerJS libraries

  • Openapi docs updates

world_services | v2.1.1#

  • Fix for scaling when no current shards

Other Updated Docs#


SDK Updates#

C# SDK | v5.0.0#

Warning

Breaking Changes for class & property renames:

  • Renamed findById to FindById in Quests

  • Renamed QuestReward model fields:

    • quantityvalue

    • entityUidentity

  • Renamed a few remaining cases of AXR → XBE: if, for example, you experience errors for AXRObject, rename the following:

    • AXRXBE

    • acceleratxr.ioxsollabackend.com

    • goaxr.cloudgoxbe.io

    • gitlab.acceleratxr.iosource.goxbe.io

    • AcceleratXRXsolla Backend

  • Classes were renamed:

    • MessageMail

    • UserLinkRelationship

    • MessageServiceMailService

    • UserLinkServiceRelationshipService

  • Introduced concept of Channels for realtime messaging

    • Content sent on Channels now is referred to as Message

  • Updated XBE branding in sdk_csharp, sdk_unity, and UnityChessGame

  • Fixed an issue where the server endpoint path was incorrect on the PersonaService’s Update call

  • Fixed an issue where the EntityWatchdog would not poll and therefore never process messages

  • Fixed an issue where the User model would fail with non-initialized lists of user roles and external IDs (the constructor did not initialize them)

  • Fixed an issue where ‘code’ was not escaped in the followup call to LoginEmail with the code from the email

    • See test: testTestFreshUserRegisterUserAndPasswordLoginEmail

  • Fixed a serialization issue when serializing objects within leaderboards and various related objects could cause the program to crash

  • Added OAuth2 Generic API SDK support. Documentation will follow this release

  • Fixed serialization issue where strings are not serialized into Object format

  • Added Economy Component Functionality

  • Added Update functionality to Leaderboards

  • Fixed CreateMany formatting issues in Resource Service and Transaction Service

  • Changed Transaction status to a format that can be easily converted to String

  • Fixed leaderboard Constants to follow formatting of other platforms

Unity SDK (Plugin) | v5.0.0#

Warning

Breaking Changes for class & property renames:

  • Updated version to consume latest changes from C# SDK

  • Updated version to consume latest changes from C# SDK (see release notes above)

C++ SDK | v5.0.0#

Warning

Breaking Changes for class & property renames:

  • Renamed QuestReward model fields:

    • quantityvalue

    • entityUidentity

  • Classes were renamed:

    • MessageMail

    • UserLinkRelationship

    • MessageServiceMailService

    • UserLinkServiceRelationshipService

  • Introduced concept of Channels for realtime messaging

    • Content sent on Channels now is referred to as Message

  • Updated XBE branding in sdk_csharp, sdk_unity, and UnityChessGame

  • Fixed an issue where the server endpoint path was incorrect on the PersonaService’s Update call

  • Fixed an issue where the EntityWatchdog would not poll and therefore never process messages

  • Fixed an issue where the User model would fail with non-initialized lists of user roles and external IDs (the constructor did not initialize them)

  • Fixed an issue where ‘code’ was not escaped in the followup call to LoginEmail with the code from the email (see: test TestFreshUserRegisterUserAndPasswordLoginEmail)

  • Fixed a serialization issue when serializing objects within leaderboards and various related objects could cause the program to crash

  • Added OAuth2 Generic API SDK support. Documentation will follow this release

  • Fixed serialization issue where strings are not serialized into Object format

  • Added Economy Component Functionality

  • Added Update functionality to Leaderboards

  • Fixed CreateMany formatting issues in Resource Service and Transaction Service

  • Changed Transaction status to a format that can be easily converted to String

  • Fixed leaderboard Constants to follow formatting of other platforms

Unreal SDK (Plugin) | v5.0.0#

Warning

Breaking Changes for class & property renames:

  • Updated version to consume latest changes from C++ SDK

  • Fixed an issue where the Unreal Online Subsystem Leaderboards interface was missing a break statement, preventing stats from being collected

  • Updated version to consume latest changes from C++ SDK (see release notes above)

  • Fixed an issue where the Unreal Online Subsystem Leaderboards interface was missing a break statement, preventing stats from being collected

NodeJS SDK | v3.1.0#

Warning

Breaking Changes for class & property renames:

  • Renamed QuestReward fields:

    • quantityvalue

    • entityUidentity

  • Classes were renamed:

    • Message → to Mail

    • UserLink → to Relationship

    • MessageService → to MailService

    • UserLinkService → to RelationshipService

New Features#

  • Added WebSocket API

  • Added NotificationServer API for managing push notifications

  • Added EntityWatchDog

  • Introduced Social v3 models and services:

    • Activity Feed

    • realtime Communication (Text, Voice, Video)

  • Added Agreements

  • Added refreshToken utility function to SDK

Bug Fixes#

  • Fixed login and registration issues

  • Ensured new profiles always have a unique uid

  • Ensured new wallets always have a unique uid

  • Fixed asset uploads in AssetService

  • Fixed ReleaseNotes service path

  • Fixed loggedInUser convenience method for loginOAuth

Enhancements#

  • Added UserSecretMethodType enum for UserSecret’s type

  • Added admin-only endpoints for UserSecret

  • Updated copyright statement where applicable to recent fixes/changes only

    • Non-edited files did not get updated

  • Update arrays to use literals

  • Added updateBulk method to PersonaService, PersonaStatService and PersonaStatDefinitionService

  • Added findNear and findTop to LeaderboardRecordService


App Updates#

Console | v6.7.2#

New Features#

  • Enabled bulk creation of entities through importing by CSV or JSON for entities with create permissions

  • Added /leaderboard/records pages for reviewing LeaderboardRecords

  • Moved Leaderboards page to /leaderboards/definitions

  • Added enabled flag support for OAuthProvider

  • Added Korean language support

  • Introduced code signing for production desktop builds

Bug Fixes#

  • Fixed entity link URLs for Leaderboard and UserSecrets

  • Improved delete behavior on index pages with a temporary ‘deleting’ state

  • Made enum rendering more fault-tolerant

  • Ensured new profiles have unpopulated uid to enforce User linking

  • Fixed asset uploading on the web

  • Fixed relationship validation for users and other fields

  • Bug fix for Wallet validation check

  • Addressed WebSocket issues for non-configured environments

  • Fixed incorrect redirect behavior when deleting entities in embedded dialogs

  • Fixed rendering for preview images defined as embedded SVG data

Enhancements#

  • Updated Social views in Console: Mail, Post, Profiles

  • Updated views to handle the refactor of UserLink to Relationship

  • Reorganized property views for Zone

  • Tweaked styles across the application

  • Improved mobile touch event handling for tooltips in EntityEditor

  • Updated docs and source links to new hosting

  • Various adjustments for Social services models (Mail, Posts)

  • Required hostUid for Matchmaking Tickets

  • Disabled sorting on LeaderboardRecords view

  • Latest shared libraries integrated (major entity index page grid refactor)

Launcher | v4.4.0#

New Features#

  • Added Korean language support

  • Introduced code-signing executables for production builds

Bug Fixes#

  • Fixed login issues related to required data

  • Fixed configuration for required user properties

Enhancements#

  • Updated to use the latest shared libraries

  • Applied style tweaks for purchasing

  • Updated to the latest styles across the application


Documentation Updates#

Tutorial & Example Doc Updates#

Unity Chess Sample | v5.0.0#

  • Updated sample to use latest and greatest from updated SDKs

Unreal Lyra Sample | v5.0.0#

Doc Updates | v2024.12.0#

  • Reworked the “What Is Xsolla Backend?” welcome doc

    • Better explaining the EULA

    • Explained what we mean by pay only 5%

    • Added additional clarifications regarding how to get started

  • Added SDK Reference Docs:

  • Additional AXR->XBE rebranding

  • Fixed Unreal C++ Get OSS declaration examples to work with Unreal 5.x syntax throughout

  • Added new Knowledgebase category; unlike guided tutorials, these are less-guided and more-factual

    • Added KB for Containers (introduction, K8s, & BYOC)

  • [Meta] Released sphinx-repo-manager, our doc generator repo manager tool, as a MIT-licensed FOSS community plugin


Meta#

XBE Discord#

Note

Discuss these updates on the official Xsolla Backend Discord Server!

Older Releases#

  • v2024.08.0 → Open API ref docs, quest tutorial, public browsing launcher

  • v2024.07.0 → Service/console fixes & stability, doc version selector

  • v2024.06.0 → OAuth, SSO, 5% price model, new docs launch

See archive for verbose (per-service) release notes, including older releases.