retropassdev / RetroPass

Retro Pass is a simple frontend for emulators running on Xbox.
GNU General Public License v2.0
105 stars 42 forks source link

RetroPass

Retro Pass is a simple frontend for emulators running on Xbox.

Video

This frontend is made specifically for Xbox console and hopefully, should feel familiar to Xbox users right from the start.

Supported emulators

Limitations

Prerequisites

Installation

  1. Download latest RetroPass binaries
  2. Connect to Xbox through Xbox Device portal and install:
    • RetroPass_x.y.z.0_x64.msix
    • 3 appx dependencies in /Dependencies/x64/ folder.

Setup

RetroPass can't download box art and game screenshots directly from Xbox because it doesn't have a built in scraper and doing all the configuration directly on Xbox would be fairly difficult. Instead, RetroPass is made compatible with:

LaunchBox is a preferred option, because it gives the best results when properly set up. Mainly:

Choose any of the above options and follow the link to set it up. After configuring, connect external storage to Xbox and start RetroPass. Follow Add DataSource section.

Settings

You can further configure RetroPass in Settings.

  1. Source - Add, activate and deactivate your LaunchBox and EmulationStation data sources
  2. Personalization - Set light or dark theme, the way video is played, etc...
  3. Logging - Turn on/off logger and view log entries.

Controls

Troubleshooting

If after installation and setup you don't see your content, inspect log,

Thumbnail Caching

Build from source

  1. Install Visual Studio 2019
  2. Get the latest source code from master branch or release
  3. Open RetroPass.sln
  4. Under Package.appxmanifest -> Packing, create and choose a different Certificate if needed.
  5. Set Configuration to Release
  6. Set Platform to x64
  7. Project -> Publish -> Create App Packages...
  8. Choose Sideloading, turn off Enable automatic updates
  9. Yes, select a certificate or Yes, use the current certificate
  10. Under Architecture check only x64
  11. Package is built and ready to install.
  12. Optionally, for smaller package size, it is safe to delete:
    • Add-AppDevPackage.resources
    • Dependencies\arm
    • Dependencies\arm64
    • Dependencies\x86
    • TelemetryDependencies
    • Add-AppDevPackage.ps1
    • Install.ps1

Roadmap and Contributing

The main goal of RetroPass is to provide a way to launch content in a way that is familiar to Xbox users. We feel RetroPass fulfills this goal. For a roadmap and possible new features check milestones. We'll keep fixing bugs so feel free to report any issues you find.

Feel free to fork the repository and further develop the app to your liking.