The Xbox Live Unity Plugin provides a way for developers to quickly and easily integrate Xbox Live functionality into their Unity based game. To get access to the Xbox Live service, please apply to the ID@Xbox program.

The Unity Plugin is broken into the following parts

• Assets contains the Unity project content.

  • Xbox Live contains the actual plugin assets that are included in the published .unitypackage.
    • Editor contains scripts that provide the basic Unity configuration UI and processes the projects during build.
    • Examples contains a set of simple scene files that show how to use the various prefabs and connect them together.
    • Images is a small set of images that are used by the prefabs.
    • Libs is where the Xbox Live libraries will be stored. This will only contain .meta files when you initially clone the repository. You must build the SDK to pull those files in.
    • Prefabs contains various Unity prefab objects that implement Xbox Live functionality. See the prefabs documentation for more information.
    • Scripts contains all of the code files that actually call the Xbox Live APIs from the prefabs. This is a great place to look for examples about how to properly call the Xbox Live APIs. See the scripts documentation for more detail.
    • 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.

• External contains additional resources used by the plugin

  • xbox-live-api-csharp is a submodule where the Xbox Live API comes from. You can choose to build the SDK from this sub-module or directly from the repository.

• ProjectSettings contains standard Unity project settings files.

If you're just looking to integrate Xbox Live functionality into your Unity game, you can download the latest UnityPackage from Releases. If you want to make changes or you need to debug something, you can do so directly from this source.

• Windows 10 Anniversary Update
• Unity 5.5
  • Currently 5.5 is the minimum supported version, but we are looking into supporting some earlier versions in the future.
  • You need to include the following components when installing.
    • Microsoft Visual Studio Tools for Unity
    • Windows Store .NET Scripting Backend
• Visual Studio 2015
  • Any version of Visual Studio should work for this including Community Edition.
  • Make sure to select everything under Universal Windowsn App Development Tools when installing. You can modify the installation to include these features for an existing installation as well.
• Powershell
  • If you've never used powershell before make sure that you have enabled powershell scripts to run.

1. Open up a powershell window.

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

3. Run the Setup powershell script to get all of the pre-requisites built and configured.

   .\Build\Setup.ps1

4. If you want to make any modifications to the scripts or prefabs in the package, open up the project (the xbox-live-unity-plugin folder) in Unity and make your changes.

5. Generate the XboxLive.unitypackage that you can import into any other project:

   .\Build\BuildPackage.ps1
   

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.

• Issue Tracker
• ID@Xbox

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.