Skip to content

Latest commit

 

History

History
359 lines (186 loc) · 19.9 KB

README.md

File metadata and controls

359 lines (186 loc) · 19.9 KB

This method (used first by tunip3) allows apps to be installed to an Xbox in retail mode that would normally only be available in dev mode. Note that there are better options available if you just want to run RetroArch on your Xbox. This is intended for those that want to create their own storefront containing RetroArch or those that want to self-host.

Guide to Installing Apps to an Xbox in Retail Mode

Table of Contents

Introduction

This guide will describe the process of uploading a Universal Windows Platform (UWP) app to the Microsoft Store for use on an Xbox in retail mode. Apps that you install to your Xbox in this way will not need to be sideloaded in dev mode. This is useful for several reasons: allowing use of Xbox remote play, avoiding having to restart the Xbox, and bypassing the 2 GB file size limit imposed on dev mode.

There are some things you should be aware of if you choose to follow this guide. Installing emulation apps to an Xbox in retail mode is against Microsoft’s terms of service. For example, it is possible to install RetroArch and PPSSPP to an Xbox in retail mode. The consequences of breaking these terms of service, if any, are unknown. In addition, you will need to pay $20 in order to acquire a developer account from Microsoft. However, there is a method to bypass this, bringing the price down to around $1 USD. If you can currently sideload apps in dev mode, you have already paid and you don’t need to pay again.

To summarize what must be done, you must first create a template for an app on Microsoft Partner Center (used for releasing UWP apps to the Microsoft Store), indicate that the app will either be available to a private or public audience, associate the app’s source code with the project you created in Partner Center, generate a package that can be uploaded to Partner Center, upload the package to Partner Center, submit the Partner Center project to Microsoft, create a website with a link to your app’s Microsoft Store page, and then click on that link using your Xbox’s Edge browser (or paste the app's link directly into the Xbox's edge broweser).

Requirements

To follow this guide, you will need $20 (unless you already have a Microsoft developer account), a computer running Windows, git, and Visual Studio 2017 or 2019. You may be able to just pay $1 if you have access to a credit card that will pass verification. The installation of Visual Studio and git is not within the scope of this guide.

Step 1: Sign up for a developer account

If you have a Microsoft account that you log into on your Xbox and $1, you have everything you need to complete this step. If you have a developer account already, skip this step.

1. Go to this URL (https://developer.microsoft.com/en-us/store/register/) and click on the “sign up” button.

2. If you are not already signed in with your Xbox’s Microsoft account, sign in using the prompt displayed.

3. You will then be presented with a dropdown menu for selecting your region. If you choose Argentina, you will end up paying around $1 USD, as long as you can submit payment using a credit card or other card that will pass verification. If you choose United States or most other countries, you will end up paying around $20.

4. Once you select a region, the account type options will be displayed. Select “individual” account type option. AccountType

5. Scroll down to the “publisher display name (company name)” textbox and enter your desired publisher name. This can be anything as long as it hasn’t already been claimed by someone else.

6. Scroll down and fill in the “contact info” textboxes. Then, press the “next” button at the bottom of the page.

7. On the next page, click on “add a new payment method.”

8. Enter your payment information, go to the Review page, and complete the purchase. You now have a Microsoft developer account.

Step 2: Create an application in Microsoft Partner Center

Now we will use the Partner Center to create an app that you can submit to your own private Microsoft Store. This will be the bulk of the required work.

Step 2.1: Enter availability settings

1. Navigate to this URL (https://partner.microsoft.com/overview).

2. Press the "create a new app" button.

3. Enter an app name into the "name" field and click on the "reserve product name" button. Like the publisher name, your app's name can be anything that has not already been reserved.

4. The application overview page is now displayed. Click on the "start your submission" button.

5. All these sections will need to be completed in order to create your app. Click on the "pricing and availability" link first.

availability

6. In the visibility section of the next page, click on the "private audience" radio button, and then click on the "create a new group" link. If you instead select the "public audience" and "direct link only" options, anyone will be able to access your app without a whitelist, but you may have difficulty updating your apps. If you choose to go public instead, you don't have to worry about creating groups, so you can skip to step 14.

7. Enter anything you desire in the "group name" textbox, and then enter your email address into the bottom textbox.

8. Click on the "save" button.

9. First, place your cursor on the symbol with three squares on the left-hand portion of the page. Then, click on the name of your app.

return

10. Click on the "submission 1" link under the "submissions" heading.

11. Click on the "pricing and availability" link again.

12. Select "private audience" again in the visibility section.

13. Click on the checkbox for the customer group that you just created.

customers

14. Scroll down to the discoverability section and click on the radio button for "make this product available but not discoverable in the Microsoft Store."

15. Make sure the "direct link only" radio button is also selected.

directlink

16. Scroll down to the pricing section and choose "free" in the base price dropdown list.

17. Scroll all the way down and click on the "save draft" button.

Step 2.2: Enter properties settings

1. Click on the "properties" link.

properties

2. In the topmost dropdown list, select "games" for the category.

3. Click on the checkbox for any genre.

4. Click on the "yes" button for the privacy policy section and enter a valid URL.

policy

5. No further input is required. Scroll all the way down and click on the "save" button.

Step 2.3: Enter age ratings settings

1. Click on the "age ratings" link.

ageratings

2. Go ahead and select the radio buttons that best describe your app. Nothing specific is required here except for the last question.

3. Scroll down and select the "no" radio button for the final question.

ratingsboard

4. Click on the "save" button.

Step 2.4: Enter store listing settings

1. Click on the "add/remove languages" link in the store listings section.

addlanguage

2. Type "English" into the first textbox and press the enter key.

3. A new window is displayed. Type "English" into the textbox and click on the "English" checkbox.

languages

4. Click on the "update" button.

5. Click on the "save" button at the bottom of the screen.

6. Click on the "English" link that is now displayed in the store listings section.

englishlink

7. Enter the app's description into the required "description" textbox.

8. Scroll down to the screenshots section. Click on the "Xbox" option. You will now need to upload at least one .png screenshot with dimensions between 1920x1080 and 3840x2160.

9. Once you have found a suitable image, click on the plus button and upload it.

10. Once the upload is complete, no further input is required for this page. Scroll down and click the "save" button at the bottom of the page.

Step 3: Prepare the application's package for upload

If you need to create the package from the source code (occasionally necessary when the app uses .NET), follow the steps in 3.1. If you don't have the source code or know that your app does not use .NET, skip 3.1 and follow the steps in 3.2.

Step 3.1: You have the source code

We will now need to generate a .msixupload or .appxupload file for submission to the Microsoft Store. This step will involve git and Visual Studio.

3.1.1. Enter "cmd" in the Windows search bar and click on the first search result.

3.1.2. Using the "cd" command, navigate to the folder that will hold the app's source code.

3.1.3 Enter the following into cmd.exe and press the enter key. Replace the URL I am using with the URL that links to your app's source code.

For RetroArch, use this:

git clone --recursive https://github.com/libretro/RetroArch.git

3.1.4. Double-click on the resulting .sln file that corresponds to your app. If the source code has multiple .sln files, make sure to click on the one that is specifically intended for generating a UWP package.

3.1.5. For RetroArch, you will need the 2019 .sln file in the RetroArch/pkg/msvc-uwp/ directory.

3.1.6. For RetroArch, download the cores here (http://buildbot.libretro.com/nightly/windows/x86_64/RetroArch_cores.7z). Choose which ones you want to use and place them in the RetroArch/pkg/msvc-uwp/RetroArch-msvc2019-UWP/cores/x64/cores/ directory. Note that not all cores work on Xbox. If you want to use Mupen64 (N64) or Flycast (Dreamcast), you will need to use the cores here instead (http://195.90.212.190/Files/Angle%20Cores/).

3.1.7. For RetroArch, download the other .dll files here (https://mega.nz/file/3dAhEYJZ#OjZvEp9UTubxiQY4RbziWjP7Zg0cIh3lQaGDEj12p5Y) and place them in the RetroArch/pkg/msvc-uwp/RetroArch-msvc2019-UWP/cores/x64/ directory.

3.1.8. Visual Studio will launch. Click on the "sign in" button at the top-right of the screen.

VSsignin

3.1.9. Log in with the Microsoft account that is linked to your Xbox.

3.1.10. For RetroArch, expand the project in the right-hand solution window.

3.1.11. Right-click on the UWP project in the Solution Explorer, place the mouse over the "publish" option, and then click on "associate app with the store."

associate

3.1.12. Press the "next" button, click on the name of your app, and then click on the "next" button again.

3.1.13. Click on the "associate" button. The window will close.

3.1.14. For RetroArch, select the ReleaseANGLE and x64 configurations.

configurations

3.1.15. Right-click on the UWP project in the Solution Explorer, place the mouse over the "publish" option, and then click on "create app packages."

createpackage

3.1.16. Click on the topmost radio button next to the text containing your app's name. Then, click on the "next" button.

3.1.17. Click on the checkbox for "automatically increment" and uncheck all checkboxes that are not related to the x64 configuration. Make sure the middle drop-down menu is set to ReleaseANGLE.

3.1.18. Uncheck the checkbox for "generate artifacts to validate..."

makepackagefile

3.1.19. Click on the "create" button.

3.1.20. Click on the "output location" link.

linktopackage

Step 3.2: You don't have the source code or don't want to compile the app

We will now use an open-source application named AppxPacker (made by tunip3) to repackage your app so that you can upload it to the Microsoft Store. For this step, you must have a .appx file that you will extract and repackage. This will not work if your app uses .NET, in which case you cannot currently add the app to an Xbox in retail mode (to the best of my knowledge).

3.2.1. Navigate to the Identity Center page by first clicking on the "product management" menu item and then clicking on the "product identity" menu item.

gotoidentity

3.2.2. Download this .zip file (https://mega.nz/file/1oQzyKwC#iHrjUSLUa2F7Kdf1hsowjtnTSOAKnGHPLt1Iju4H64s) and extract it to an easily accessible folder.

3.2.3. Right-click your .appx file and open it with WinRar. There are many sources of RetroArch packages that will run on an Xbox. The official ones are here, listed by version number: https://buildbot.libretro.com/stable/. Bundle files will need to be opened with WinRar in order to extract the .msix or .appx file inside it. You can rename a .msix file to give it a .appx file extension, and it should still work.

3.2.4. Extract the contents of the .appx file to a separate directory.

3.2.5. Double-click on the "Appx packer.exe" file that you extracted in step 3.2.2. The application will launch.

3.2.6. In the "app path" textbox, enter the full path of the folder from step 3.2.4. containing the contents of the .appx file (you should specify a folder, not a file).

3.2.7. In the "output folder" textbox, enter the full path of any folder you'd like. The folder you specify will contain the repackaged .appx file (again, this should be a folder and not a file).

3.2.8. Uncheck the "patch for XB1" checkbox.

3.2.9. Copy over the package name, publisher name, publisher display name, and package display name from the identity center webpage to the AppxPacker application as shown in the image below.

copydetes

3.2.10. Click on the "create appx" button in the AppxPacker application.

3.2.11. You will be prompted for a password several times. Just enter "test" for every prompt. (If sign failed, try blank password instead)

3.2.12. If the process is completed successfully, you will see a pop-up window indicating that the package was created and signed.

3.2.13. You will find the package that you will need to upload to the Microsoft Store in the output folder that you specified in step 3.2.7.

Step 4: Upload the application to the Microsoft Store

Now that we have generated the package, we need to upload it to our private Microsoft Store.

1. Navigate to the Partner Center (https://partner.microsoft.com/en-us/dashboard/windows/overview).

2. Click on the "continue submission" button for your app.

3. Click on the "packages" link.

packagessection

4. Drag the .appxupload, .msixupload, or repackaged .appx file into the packages section.

uploadfile

5. Select the "Windows 10 desktop" and "Windows 10 Xbox" checkboxes in the device family availability section.

6. Scroll all the way down and click on the "save" button.

7. Remove any languages in the store listings section that you don't want to include in your app.

8. Click on the "Xbox Live creator's program" link.

XboxLive

9. Click on the "enable" button on the top-right of the page.

10. Click on the "confirm" button.

11. Scroll all the way down and click on the "test" button.

12. Once "success" is displayed, return to the app overview page.

13. Scroll down and click on the "submit to the store" button.

submit

14. Scroll all the way down and click on the "save" button.

15. If necessary, click on the "submit to the store" button again.

16. The app has now been submitted to the store. Wait to receive an email indicating that the app was published.

Step 5: Create a website that links to the app or copy over the link

Once the app has been published, it is time to find a way to install it to your Xbox or distribute it to others. You can copy and paste the app's link directly into your Xbox's Edge browser, or you can create a website that will link to your app in the Microsoft Store. If you are creating a storefront, you will probably want to create a website. I will not detail this process extensively, but I will say what the website must contain.

1. Return to the Partner Center (https://partner.microsoft.com/en-us/dashboard/home) and go to your app's overview page.

2. Click on "product management" and then on "product identity."

identity

3. At this point, you can either copy the "store protocol link" and paste it into your Xbox's Edge browser or create a website. If you want to make a website, follow the steps below.

3. Scroll down and write down the URL labeled as "URL if your app is only visible to certain people (requires authentication)."

URL

4. Create a new text file with the following contents and save it as index.html.

<HTML>
    <BODY>
         <p>
            <a href="ms-windows-store://pdp/?productid=##">App Name</a>
         </p>
    </BODY>
</HTML>

5. Replace the "##" characters in the above file with the product ID from your URL. It should look something like this:

 <a href="ms-windows-store://pdp/?productid=9NC9ZRXZWPXS">App Name</a>

6. You will now need to host the index.html file. One common choice for creating websites like these is github.io (https://pages.github.com/).

Step 6: Install the app to your Xbox in retail mode

1. Turn on your Xbox and open the Edge app.

2. Navigate to the URL of your website.

3. Click on the link you created for your app.

4. The Microsoft Store will launch. Select the install button to add your app to your Xbox in retail mode.