XBE Doc Release Notes

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

• Continuous Development / Continuous Integration pipelines now exist within the LyraStarterGame repository to verify functionality of the sdk_cpp and sdk_unreal repository on Windows and Linux.

• Tutorials & GuidesAdded new (or revamped) quickstart install guides:

  • Unreal Quickstart

  • Unity Quickstart

  • C++ Quickstart

  • C# Quickstart

• Added new Persona Component Tutorial

• Added new Economy Component Tutorial

• Added new Leaderboard Component Tutorial

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:

  • NodeJS SDK

  • C++ SDK

  • C# SDK

• 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

v2024.8.0

Unity Chess Sample | v5.0.0

• Improved repo README and supporting tutorial docs

Unreal Lyra Sample | v5.0.0

• PS5 compiler flag improvements

Tutorials

• Quest Tutorials

• Live Scripting Tutorials

• Unreal SDK Install Quickstart guide to accompany the Unreal OSS Quickstart video

---

v2024.7.0

• Centralized older release notes (the bottom of this page).

• Synchronized with more standalone repo content.

• Started indexing only the “latest” version for robot crawlers.

• Cleared more warnings, typos, and added alt tags to all images.

• Added open graph metadata for embed previews.

• All typos have been corrected.

• Heavy theme updates.

• Started tracking verbose notes (here).

---

v2024.6.0

Be prepared for significant documentation updates coming your way, starting now with:

• Created a sphinx_repo_manager.py extension to funnel all repository docs into a single doc, eliminating redundancy and effortlessly centralizing all content.

  • These docs will be wrapped under a macro-versioned snapshot, then micro-versioned per-repo as seen above.

• Implemented a repo_manifest.yml file to easily manage tracked doc repos.

• Implemented multi-threading to lower local build time from 3.5m to 25s.

• Normalized all repo /docs dirs and removed irrelevant/dupe docs/images.

• Created a centralized Release Notes section (this doc), offering featured summaries and funneling all individual repo release notes into a single table of contents.

• [WIP] Centralized all API docs via OpenAPI, including an automated OpenAPI spec updater.

• Created a new Components page that centralizes all individual repo framework docs.

• Resolved thousands of doc warnings and started intuitively rearranging the hierarchy.

• Started renaming AXR references to XBE.

• Added smoothing to anchor jumps.