Create, Upload, and Publish Game Help
Modify the Sample_Game_Media_App_Manual from the Game_and_App_Help sample available on XGD and test/iterate it locally on your computer browser before uploading. Follow the steps in the following sections in the order presented.
Test Game Help on a computer browser
If you are using a modified Sample_Game_Media_App_Manual, use the following steps to make it work properly on a computer browser:
To test Game Help on a computer browser
- Near the end of index.html is a reference to an external script, HelpSample.js. This script is for use with the sample manual HTML above. At your discretion, you can download a copy of this script and modify it, if you decide to make significant changes to the sample.
- Download a copy of that script to the same folder as index.html.
- Change the script reference to read the file from the local directory. Now when you view index.html in a browser, and allow scripts to run, it should navigate properly.
- To test the help html as it would look in snap mode:
- View index.html in Internet Explorer 11
- Allow scripts to run
- press F12 to activate the developer tools menu
- Select the emulation tab
- Change the orientation to Portrait
- Change the resolution to Custom
- Change the width to 480
- Change the height to 1080
Upload Game Help to XDP
To upload Game Help via XDP follow the instructions in Submit Documentation for Help, Privacy Notice, and Terms of Use.
Publish Game Help to a Sandbox
After uploading Game Help files via XDP to the correct locales, publish them using the rules for any product metadata at Add or Change Art Assets.
Test Game Help on X1
To test your title’s Game Help on your X1 dev kit, you need all of the following to be true:
- Your title’s Game Help files must be published through XDP (not simply uploaded, but fully published)
Note This can take up to a day before it completes.
- You must have your dev kit set to the sandbox to which the Game Help was published.
- You must have your dev kit locale set to the locale you want to test.
- You must be signed in with a dev account that has access to the sandbox you are testing.
- Your title’s appxmanifest must include the ms extension that contains the Title ID and Service Config ID for your title.