Overview

RomM (stands for Rom Manager) is a game library manager focused in retro gaming. Manage and organize all of your games from a web browser.

Inspired by Jellyfin, allows you to manage all your games from a modern interface while enriching them with IGDB metadata.

⚡ Features

• Scan your game library (all at once or by platform) and enriches it with IGDB metadata
• Access your library via your web-browser
• Possibility to select one of the matching IGDB results if the scan doesn't get the right one
• EmuDeck folder structure compatibility
• Multiple files games support
• Download games directly from your web-browser
• Edit your game files directly from your web-browser
• Region, revision/version and extra tags support
• Works with SQLite or MaridDB (SQLite by default)
• Responsive design
• Light and dark theme

🛠 Roadmap

• Upload games directly from your web-browser - issue #54
• Manage save files directly from your web-browser - issue #55
• Set a custom cover for each game - issue #53

Preview

🖥 Desktop

📱 Mobile

The RomM community

Wiki
Discord

Installation

🐳 Docker

Docker should be installed and set up before running the image.

1. Generate an API key for IGDB, and set the CLIENT_ID and CLIENT_SECRET variables. This is required to run a library scan. Instructions on generating the ID and Secret are here. Note that IDGB requires a Twitch account with 2FA enabled to generate the ID and Secret.
2. Verify that your library folder structure matches one of the options listed in the following section.
3. Create a docker-compose file. See the following example docker-compose.yml file for reference. Customize for your setup and include the CLIENT_ID and CLIENT_SECRET vareiables where indicated in the environment section of the file.
4. Launch the container:

docker-compose up -d

If configured correctly, Romm will automatically run an initial scan on your library.

Configuration

📁 Folder structure

RomM accepts two different folder structure by priority. RomM will try to find the structure 1 and if it doesn't exists, RomM will try to find structure 2.

Review the Platforms support section for device naming conventions, and the Configuration file section to override default system names in the folder structure, if your directories are named differently.

• Structure 1 (high priority) - roms folder at root of library folder:

library/
├─ roms/
   ├─ gbc/
   │  ├─ rom_1.gbc
   │  ├─ rom_2.gbc
   │
   ├─ gba/
   │  ├─ rom_1.gba
   │  ├─ rom_2.gba
   │ 
   ├─ ps/
      ├─ my_multifile_game/
      │   ├─ my_game_cd1.iso
      │   ├─ my_game_cd2.iso
      │
      ├─ rom_1.iso

• Structure 2 (low priority) - roms folder inside each platform folder

library/
├─ gbc/
│  ├─ roms/
│     ├─ rom_1.gbc
│     ├─ rom_2.gbc
|
├─ gba/
│  ├─ roms/
│     ├─ rom_1.gba
│     ├─ rom_2.gba
|
├─ ps/
│  ├─ roms/
│     ├─ my_multifile_game/
│     │  ├─ my_game_cd1.iso
│     │  ├─ my_game_cd2.iso
│     │
│     ├─ rom_1.iso

⚙️ Configuration file

RomM can be configured through a yml file.

For a configuration change to take effect, RomM must be restarted.

Check the config.yml example.

Check the docker-compose.yml example to see how to bind it.

Naming convention

🎮 Platform support

If the RomM folder structure is followed, any kind of platform/folder-name is supported for the core features. For having extra metadata as well as cover images and platforms icons, the following table shows how to name your platforms folders. This will change over the time, adding games metadata for more platforms.

📑 Tags support

Games can be tagged with region, revision or other tags using parenthesis in the file name.

• Regions will be detected according to the following dictionary:

*Aditionally, region can be set adding "reg-" as prefix: (reg-E) / (reg-Spain) / (reg-USA)

• Revision tags must be prefixed with "rev " or with "rev-": (rev v1) / (rev-v1) / (rev-whatever)

• Any other tag can have any structure

• Example: my_game (E)(rev v1)(fav)(aditional_tag).gba

NOTE: Tags can be used with the search bar to help to filter your library.

⛏ Troubleshoot

• After the first installation, sometimes the RomM container can have problems connecting with the database. Restarting the RomM container may solve the problem.

🧾 References

• Complete changelog

🎖 Credits

• Pc and Mac icon support - Keyboard and mouse icons created by Flat Icons - Flaticon