The Xbox Live Unity Plugin provides a way for developers in the Xbox Live Creators Program to quickly and easily integrate Xbox Live functionality into their Unity based game. For [email protected] developers, this Xbox Live Unity Plugin does not yet support all the features you will need. Instead, contact your Microsoft representative.
One vector of accessibility in game development is reducing the friction and technical complexity required to build and publish games to a store.
In February 2021 we removed the requirement for UWP games to integrate with Xbox Live to publish to Xbox and are phasing out software needed to support Xbox Live on UWP. The Store policy has been updated at UWP Store Policies
We'd also like to mention that the GDK is now available to all developers free of charge, to help developers learn how to build games for the Xbox App on Windows and Game Pass; no license required for learning: https://aka.ms/gdk
The Microsoft Game Development Kit (GDK) contains the common tools, libraries, and documentation needed to build games for the Xbox App on Windows 10, Xbox Game Pass for PC, Xbox consoles (Xbox Series X|S, Xbox One), and Xbox Game Pass cloud gaming.
The Xbox Live Unity Plugin provides a way for developers in the Xbox Live Creators Program to quickly and easily integrate Xbox Live functionality into their Unity based game. For more information about the Xbox Live Creators Program go to http://aka.ms/xblcp.
For [email protected] developers, this Xbox Live Unity Plugin does not yet support all the features you will need. Instead, read the document Get Stated with Xbox Live for ID and Managed Partners for guidance.
The Unity Plugin is broken into the following parts
Assets contains the Unity project content.
.metafiles when you initially clone the repository. You must build the SDK to pull those files in.
Inside this folder, you'll also find a folder called GameSave where you'll see the Game Save (Connected Storage) plugin and its scripts. * Tools/AssociationWizard contains the Xbox Live Association Wizard, used to pull down application configuration from DevCenter for use within Unity.
Build contains scripts to generate the .unitypackage and handle other project setup tasks.
CSharpSource contains source for the Xbox Live API that is used by the plugin
ProjectSettings contains standard Unity project settings files.
Clone the project, and be sure to include and sync all the required submodules.
git clone https://github.com/Microsoft/xbox-live-unity-plugin --recursive cd xbox-live-unity-plugin
Run the Setup powershell script to get all of the pre-requisites built and configured.
Note: Ensure Unity was installed with Windows Store .NET Scripting Backend, and you have the Microsoft Visual Studio Tools for Unity installed.
If you want to make any modifications to the scripts or prefabs in the package, open up the project (the
xbox-live-unity-pluginfolder) in Unity and make your changes.
XboxLive.unitypackagethat you can import into any other project:
See the docs at https://docs.microsoft.com/en-us/gaming/xbox-live/get-started/setup-ide/creators/unity-win10/cr-unity-win10_nav
.\Build\BuildPackage.ps1script is run, the
XboxLive.unitypackageis generated. When that unity package is imported into a unity project, the
GameSavefolder within the
Xbox Live\Assets\Scripts\folder will contain the
GameSave.unitypackagewhich contains scripts for integrating with Connected Storage.
For an example of how to use Connected Storage, you'll need to first add Sign In to your game. Afterwards, drag the
GameSaveUI.csscript and drop it on any object in your scene. That will kick-off a simple UI to test your integration to Connected Storage.
Please make sure to check out the best practice and documentation of how to use Connected Storage at: Connected Storage Documenation.
Is there a feature missing that you'd like to see, or found a bug that you have a fix for? Or do you have an idea or just interest in helping out in building the plugin? Let us know and we'd love to work with you. For a good starting point on where we are headed and feature ideas, take a look at our requested features and bugs. See the contribution guidelines for details.
Big or small we'd like to take your contributions back to help improve the Xbox Live Unity plugin for everyone.
We'd love to get your review score, whether good or bad, but even more than that, we want to fix your problem. If you submit your issue as a Review, we won't be able to respond to your problem and ask any follow-up questions that may be necessary. The most efficient way to do that is to open a an issue in our issue tracker.
Any questions you might have can be answered on the MSDN Forums. You can also ask programming related questions to Stack Overflow using the "xbox-live" tag. The Xbox Live team will be engaged with the community and be continually improving our APIs, tools, and documentation based on the feedback received there.
For developers in the Xbox Live Creators Program, you can submit a new idea or vote on existing idea at our Xbox Live Creators Program User Voice