The Xbox Live UWP plugin provides access to Xbox Live services when using the Xbox UWP (WebView2) export option in Construct. It currently supports:
- Sign in, and information about the signed in user
- Presence
- Update achievement
- Title storage (upload, download and delete blobs)
Microsoft documentation
For general information about setting up and testing Xbox Live services in your app, refer to Microsoft's documentation on UWP on Xbox One. This documentation only describes details specific to Construct and some other general advice.
Setting up
To be able to use the plugin features, you will first need to use the Microsoft Partner Center dashboard to create a new app and activate Xbox Live services. This will provide you with a Title ID and Service Configuration ID (SCID). Copy and paste these values in to the appropriate properties in the Xbox Live UWP plugin in your Construct project. Also make sure the Creators title checkbox is ticked if you are publishing with the Xbox Live Creators Program.
Then you can export your project with the Xbox UWP (WebView2) option, and extract the files to a folder. This then provides you with a Visual Studio solution to configure, test and publish your game. Before the Xbox Live features work, you will first need to use the Associate App with the Store option in Visual Studio to associate the project with the corresponding app from the Microsoft Partner Center dashboard. You can usually find this by right-clicking the project (not the solution) in the Solution Explorer in the Publish submenu. Now you should be able to test your Xbox Live features work.
Testing
You can test some features, such as sign in and title storage, on a Windows PC. However some features only work when running on an Xbox device.
To test on a Windows PC, in Visual Studio make sure the configuration is set to Debug and x64, and then click the 'Play' button labelled Local machine.
To test on an Xbox, it will first need to be in developer mode and on the same local network as your Windows development PC. Then in the Visual Studio project properties, in the Debugging section, change the dropdown to Remote Machine and for Machine name enter the IP address of the Xbox device. Then you can click the dropdown in the toolbar by the Local machine button and select Remote machine. Then clicking the button will launch your game on the Xbox.
Test accounts and sandbox
To successfully allow signing in during development, you must authorize Xbox Live test accounts on the Microsoft Partner Center (which includes clicking the "Test" button to publish changes). Then you will need to switch the Xbox sandbox to match the sandbox ID displayed for your app in the Partner Center. An Xbox in developer mode has a user interface to do this. On a Windows PC there are a couple of ways to change the sandbox, but the most straightforward is probably to use the Xbox Live PC Sandbox Switcher tool in the Development Tools for Xbox Live (see here).
Once you have correctly set up a title, the Construct project, test accounts, switched to the right sandbox, exported your project, and associated the app with the store, then you should be able to successfully sign in with one of your approved test accounts.