The Xbox Live Unity Plugin provides a way for developers to quickly and easily integrate Xbox Live functionality into their Unity based game.
Clone or download

README.md

Welcome!

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 ID@Xbox 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.

Overview

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.

        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.

Getting Started

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.

Prerequisites

Building

  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

Note: Ensure Unity was installed with Windows Store .NET Scripting Backend, and you have the Microsoft Visual Studio Tools for Unity installed.

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

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

    .\Build\BuildPackage.ps1
    

Using the Xbox Live Unity Asset

See the docs at https://docs.microsoft.com/en-us/windows/uwp/xbox-live/get-started-with-creators/develop-creators-title-with-unity

Using the Game Save Plugin

When the .\Build\BuildPackage.ps1 script is run, the XboxLive.unitypackage is generated. When that unity package is imported into a unity project, the GameSave folder within the Xbox Live\Assets\Scripts\ folder will contain the GameSave.unitypackage which 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.cs script 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.

Contribute Back!

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.

Having Trouble?

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

Xbox Live GitHub projects

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.