Skip to main content
This is unreleased documentation for the next Zaparoo Core release.
For up-to-date documentation, see the latest version (Stable).
Version: Next

RetroPie

Experimental

RetroPie support is experimental and not listed as a supported platform yet. Expect missing features and rough edges.

Zaparoo Core on RetroPie launches games through RetroPie's own runcommand. Release builds are available for x86-64, ARM, and ARM64 systems.

Install​

Open a terminal on the device or connect to it over SSH, then run:

curl -fsSL https://zaparoo.org/install.sh | sh

Run the installer as the user RetroPie runs as, usually pi, not as root. It installs Core to ~/.local/bin/zaparoo, adds hooks to RetroPie's autostart.sh, runcommand-onstart.sh, and runcommand-onend.sh in /opt/retropie/configs/all, and asks for your password through sudo to install a systemd service.

Core supports RetroPie set up to boot to EmulationStation from the console. The install stops with an error on a system that starts EmulationStation from a desktop session.

Once Core is running, write your first token from the Zaparoo App or the built-in web UI at http://<device-ip>:7497/app/.

Uninstall​

~/.local/bin/zaparoo -uninstall

This removes the service and the RetroPie hooks. Delete ~/.local/bin/zaparoo, and the config and data directories if you also want to remove your settings.

File paths​

ItemPath
Config file~/.config/zaparoo/config.toml
Data directory~/.local/share/zaparoo
Log file~/.local/share/zaparoo/logs/core.log
Mappings directory~/.local/share/zaparoo/mappings

Where ~ is the home directory of the RetroPie user, usually pi.

Client security​

RetroPie requires remote clients to pair. Pair the Zaparoo App, a browser, or another client with the six-digit PIN Core shows when you run ~/.local/bin/zaparoo -pair. The PIN expires after five minutes. See encryption for how paired clients and their permissions work.

Readers​

Each reader's page has setup steps and troubleshooting. See readers to compare them.

Launchers​

Core adds a launcher for each RetroPie system and indexes games from ~/RetroPie/roms. To launch a game, Core closes EmulationStation, runs the game through runcommand the same way EmulationStation would, and brings EmulationStation back when the game exits. Games started from EmulationStation also show as playing in Zaparoo.

The RomM launcher downloads games from a RomM server. See Media Servers.

Stopping a game is the only launcher control available.

Input commands are accepted but nothing is typed.

Shell scripts can also be launched. Add them to the allow_file list in config.toml.