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

Recalbox

Experimental

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

Zaparoo Core on Recalbox launches games through Recalbox's EmulationStation. Release builds are available for x86-64, ARM, and ARM64 devices.

Install​

Enable SSH in Recalbox settings (Network > SSH Server). The default login is root / recalboxroot. Connect to the device over SSH, then run:

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

The installer copies Core to /recalbox/share/system/zaparoo/zaparoo and adds a Recalbox user script that starts it on boot and restarts it if it stops. Recalbox cannot run programs from the share, so the script runs a copy at /tmp/zaparoo-bin/zaparoo-start. Use that path to run Core commands over SSH.

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​

/tmp/zaparoo-bin/zaparoo-start -uninstall

This stops Core and removes the user script. Delete /recalbox/share/system/zaparoo if you also want to remove your settings and data.

File paths​

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

Client security​

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

Readers​

Launchers​

Core adds a launcher for each system in Recalbox's system list, and indexes games from /recalbox/share/roms, the built-in ROMs, and the recalbox/roms folder, roms folder, or root of each USB drive. Games launch through EmulationStation, so a game has to be in one of EmulationStation's ROM folders. 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.