romm README

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

romm logo

A beautiful, powerful, self-hosted ROM manager and player.

Trendshift hackernews badge
selfh.st badge Discord

Overview

Scan, enrich, browse and play your ROM collection from one beautiful & free self-hosted app. Metadata from 10+ providers, save sync across your devices, and support for over 400 platforms. RomM is a must-have for anyone who plays on emulators.

Browsing a library and playing a game in RomM

Features

Installation

The easiest way to start is with the Quick Start Guide in the docs. If you're having trouble with setup, please review the page for troubleshooting steps.

Prefer a hosted deploy over wiring up the stack yourself?

Deploy on Hostinger
Starting at $6.49/mo · Setup guide

Deployment and infrastructure support for this install is handled by Hostinger. Prices are indicative and may not reflect current offerings. Signups through the link above send a share of the revenue back to us, which helps fund the project.

Official apps

Playnite libraryPlaynite logo Playnite plugin

Effortlessly integrate your retro game collection into Playnite, the open-source game library manager that provides a unified interface for all of your games on PC.

Windows Desktop QR pairing

Install  by @gantoine


Argosy libraryArgosy logo Argosy

Sync your library, download games on demand and track your achievements, from a gamepad-first interface designed for Anbernic, Retroid Pocket, Odin, and similar devices.

Android Handhelds QR pairing Save sync

Download  by @tmgast


Grout multi-selectGrout logo Grout

A lightweight client for your favorite handheld custom firmwares*. Download games, box art and BIOS files wirelessly, and sync your saves automatically as you play.

Linux Handhelds Save sync

Quick start  by @BrandonKowalski

*Supports Allium, Batocera, Knulli, MinUI, muOS, NextUI, Onion, ROCKNIX, Spruce and TrimUI.

Community

Here are some cool projects maintained by members of our community. Please note that our team does not regularly review their source code.

Mobile

Desktop

Handhelds

Other

Support the project

Consider supporting this project on Open Collective. Funds cover hosting, development, and maintenance, and we pass some along to community projects to nurture a healthy ecosystem of apps.

Open Collective

Our Friends

Here are a few projects that we think you might like:

Supported By

These companies support us by providing their tools for free:

Greptile Aikido

romm (rommapp/romm)

Searching Database…

13.8K ·GitHub
What is this?RomM (ROM Manager) is a self-hosted web app that scans, organizes, enriches and lets you play your retro game ROM collection, pulling metadata and artwork from multiple providers and covering 400+ platforms.
Is this an app I install on my device, or a server I host myself?It's a self-hosted server you run with Docker and access through a web browser; official companion apps exist for Playnite (Windows), Android handhelds and Linux-based handheld firmwares.
How do I get it running?Follow the Quick Start Guide in the docs, which deploys RomM using Docker Compose; there's also a troubleshooting page if setup goes wrong.
Do I need Docker to self-host it?Yes, RomM is distributed as a Docker image with a provided docker-compose setup, and that's the officially recommended way to deploy it.
Does RomM include the emulators, or just manage my ROM files?It focuses on scanning, organizing and enriching your library; actual play happens in-browser via the bundled EmulatorJS and RuffleRS engines, with no extra emulator setup needed.
Which devices can I actually play my games on?Besides any web browser, there are official apps for Playnite on Windows, Argosy on Android handhelds, and Grout for Linux-based handheld firmwares like Batocera, MinUI, muOS and ROCKNIX.
Does RomM track usage or charge for features?No, it's AGPL-3.0 licensed and free forever, with no telemetry, no paid tiers, and you keep full control of your data since it runs on your own server.
Where does the game metadata and artwork come from?RomM pulls metadata from IGDB, Screenscraper, LaunchBox and MobyGames, fetches box art from SteamGridDB, and tracks achievements via RetroAchievements.
Can I apply romhacks or translation patches?Yes, RomM has a built-in ROM patcher that applies romhacks and translations on the fly.
Can my save files sync across devices?Yes, saves and save states sync across your devices with automatic conflict resolution.
Can I share my library with family or use single sign-on?Yes, you can grant granular per-user permissions and log users in via OIDC single sign-on.
Creator
rommapp
Size
442.3 MB
Stars
13.8K
Age
3y
Commits · 90 Days