A beautiful, powerful, RomM app for muOS.

Overview

An app for CFWs that connects to your RomM instance and allows you to fetch games wirelessly from your handheld device.

Screenshots

Installation

muOS

We leverate the muOS Archive Manager to install/update the app.

1. Head to the latest release and download the romm_muOS_install_x.x.x.zip file.
2. Move the compressed ZIP file to /mnt/mmc/ARCHIVE on your device.
3. Launch the manager from Applications > Archive Manager and select romm_muOS_install_x.x.x.zip.
4. Once installed, make a copy of /mnt/mmc/MUOS/application/RomM/env.template, rename it to /mnt/mmc/MUOS/application/RomM/.env, edit it (any method is fine, we recommend SSH) and set HOST, USERNAME and PASSWORD.
5. Launch the app from Applications > RomM and start browsing your collection.

EmulationStation

We use PortMaster to install the app on devices running EmulationStation.

1. Download the RomM App.sh file and RomM/ folder to the roms/ports on your device.
2. Make the RomM App.sh file executable by running chmod +x RomM App.sh.
3. Launch EmulationStation and navigate to the Ports section.

Support

Note

Your device must connect to your RomM instance or home server over Wi-Fi. The easiest method is to keep them on the same network and set HOST to the server's IP and the port where RomM is running. Advanced users or those using reverse proxies can configure their network and DNS settings as needed, using a URL with a domain like https://romm.domain.com.

If you have any issues with the app, please open an issue in this repository. If the issue is with RomM itself, open an issue in the RomM repository.

Join us on Discord, where you can ask questions, submit ideas, get help, showcase your collection, and discuss RomM with other users. You can also find our team is the muOS Discord.

Contributing

We use uv to manage python dependencies, install it with:

curl -LsSf https://astral.sh/uv/install.sh | sh

And activate it:

uv venv
source .venv/bin/activate

Then install python and the required dependencies:

uv python install
uv sync --all-extras --dev

To build the app, you'll need to install just, then run:

just build

Just can also push the app to your device, but you need to set up an .env file with your device's IP and SSH credentials. Create a file called .env in the root of the project and add the following:

DEVICE_IP_ADDRESS=
PRIVATE_KEY_PATH=
SSH_PASSWORD=

Then run just, which will clean, build and push the app to your device.