RecompLauncher README

The project's README from github.com/elripalda/RecompLauncher. As one markdown file: README.md.

RecompLauncher: PC recomps, all in one place.

Download the beta · recomplauncher.com · Discord

Stars Downloads Latest version


RecompLauncher finds, installs, updates and plays PC recomps: native PC versions of console games, made by their developers from the original game. You bring your own copy of the game and the launcher sets it up.

What's in it

A look around

Home

Discover

Discover

A game's page

A game's page

Big Picture mode

Big Picture mode

Saves

Saves

Get it

Windows 10 or 11, 64-bit. Initial macOS support targets Apple Silicon: see the Mac build and test-artifact instructions. Mac test builds support native Mac games packaged as ZIP, DMG, RAR or 7z and are not Apple-notarized releases. If macOS blocks the first launch because it cannot verify the developer, follow the Mac first-launch steps.

Arch Linux x86_64 has a native .pkg.tar.zst build: see the Arch package instructions for building and installing it with pacman.

NixOS and Nix (x86_64): nix run github:elripalda/RecompLauncher, or see the Nix instructions to install it with your system.

Download the setup file from Releases and run it. While the beta is new, Windows may say "Windows protected your PC". Click More info, then Run anyway. Each release lists its file's SHA-256 so you can check you have the real one.

In Settings > General > When you close the window, Run in background controls whether closing the window keeps RecompLauncher in the system tray. Turn it off to exit the launcher and its background work when you close the window. Quit RecompLauncher always exits. The setting is also available in Big Picture mode. It is off by default for new installations; existing saved choices are kept. Games already running keep playing.

No game files

RecompLauncher has no game files and never downloads any. Every recomp comes from its developer's GitHub, and you set it up with your own copy of the game.

Found a bug? Have an idea?

The quickest way is Settings > Beta in the launcher. It goes straight to the developer and can include your PC's details. You can also post in the Discord or open an issue here.

If a game crashes, send the log from the crash screen. Every one helps.

Making a recomp?

Add a recomplauncher.json to your release and players get one-click setup, your settings inside the launcher, and Big Picture mode support. The guide is in docs/DEVELOPERS.md, with examples in docs/examples.

Source code

The full source of the launcher is here: the Rust core in src-tauri/ and the window in ui/. You can read exactly what it does, or build it yourself with the steps in docs/BUILDING.md. It's licensed under the GPL v3 (LICENSE).

Stars over time

RecompLauncher's stars over time

About

Made by Ripalda. If you'd like to support it: Ko-fi.

RecompLauncher is free to download and use. It isn't affiliated with or endorsed by any game's makers or platform holders.

RecompLauncher (elripalda/RecompLauncher)

Searching Database…

What is this?A launcher for PC recomps, which are native PC versions of console games made by their developers from the original game. It finds, installs, updates and plays them from one place, and you supply your own copy of the game.
Is a recomp the same as an emulator?No. A recomp is a native PC port built by the developers themselves from the original game, not a console emulator running the game's code.
How do I get it running?On Windows 10 or 11 (64-bit), download the setup file from the Releases page and run it. During the beta Windows may show a 'Windows protected your PC' warning: click More info, then Run anyway.
Do I need my own copy of the game?Yes. The launcher has no game files and never downloads any. Each recomp comes from its developer's GitHub, and you set it up with your own copy of the game, for example by pointing Easy Setup at your disc image or game folder.
Are there catches with the macOS builds?Yes. They are test builds and not Apple-notarized, so macOS may block the first launch. They support native Mac games packaged as ZIP, DMG, RAR or 7z.
Which platforms does it support?Windows 10 or 11 (64-bit) is the main target. macOS support starts with test builds for Apple Silicon, and Arch Linux has a native .pkg.tar.zst package.
Can I back up or sync my game saves?Saves are backed up before every update, and cloud saves are available with a free account.
What is Big Picture mode?A full-screen interface meant for a controller and a TV. The option to keep the launcher running in the background is also available inside it.
What happens when I close the window?For new installs the launcher exits, because 'Run in background' is off by default. Turn it on under Settings > General to keep it in the system tray. Games already running keep playing.
Can I add my own recomp to the launcher?Yes. Add a recomplauncher.json to your release to get one-click setup, in-launcher settings and Big Picture support. The guide is in docs/DEVELOPERS.md.
Creator
elripalda
Size
17.2 MB
Stars
1.4K
Updated
CommitNov 17
Age
20d
Commits · 90 Days