# 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](https://jellyfin.org/), 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
* Upload games directly from your web-browser
* Set a custom cover for each game
* 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
# Preview
## ๐ฅ Desktop
Expand to preview
## ๐ฑ Mobile
Expand to preview
# The RomM community
[Wiki](https://github.com/zurdi15/romm/wiki)
[Discord](https://discord.gg/P5HtHnhUDH)
# Installation
## ๐ณ Docker
Docker should be installed and set up before running the [image](https://hub.docker.com/r/zurdi15/romm/tags).
1. Generate an API key for [IGDB](https://www.igdb.com/), and set the `IGDB_CLIENT_ID` and `IGDB_CLIENT_SECRET` variables. _This is required to run a library scan._ Instructions on generating the ID and Secret are [here](https://api-docs.igdb.com/#about). Note that IGDB 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](#folder-structure).
3. Create a docker-compose file. See the following example [docker-compose.yml](https://github.com/zurdi15/romm/blob/master/examples/docker-compose.example.yml) file for reference. Customize for your setup and include the `IGDB_CLIENT_ID` and `IGDB_CLIENT_SECRET` variables where indicated in the environment section of the file.
4. Launch the container:
```bash
docker-compose up -d
```
# 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](#platform-support) section for device naming conventions, and the [Configuration file](#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
```
๐ Authentication
If you want to enable the user management system, a redis container and some environment variables needs to be set. In the [docker-compose.yml](https://github.com/zurdi15/romm/blob/master/examples/docker-compose.example.yml) you will find the needed variables and an example of how to spin up a redis container:
- `ROMM_AUTH_ENABLED` and `ENABLE_EXPERIMENTAL_REDIS` must be set as `true`
- `ROMM_AUTH_SECRET_KEY` must be generated with `openssl rand -hex 32`
- `ROMM_AUTH_USERNAME` and `ROMM_AUTH_PASSWORD` can be set as wanted, being both `admin` by default.
- `REDIS_HOST` and `REDIS_PORT` must point to your redis instance
โ๏ธ 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](https://github.com/zurdi15/romm/blob/master/examples/config.example.yml) example.
Check the [docker-compose.yml](https://github.com/zurdi15/romm/blob/master/examples/docker-compose.example.yml) example to see how to bind it.
# Naming convention
If the RomM [folder structure](#๐-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.
Platform support list
| slug | name | games metadata |
|-------------------------|-------------------------------------| :----: |
| 3ds | Nintendo 3DS | โ
|
| amiga | Amiga | โ
|
| acpc | Amstrad CPC | โ
|
| arcade | Arcade | โ
|
| atari | atari | โ |
| atari2600 | Atari 2600 | โ
|
| atari5200 | Atari 5200 | โ
|
| atari7800 | Atari 7800 | โ
|
| coleco | coleco | โ |
| c64 | Commodore C64/128/MAX | โ
|
| cpc | cpc | โ |
| cps1 | cps1 | โ |
| cps2 | cps2 | โ |
| cps3 | cps3 | โ |
| daphne | daphne | โ |
| dc | Dreamcast | โ
|
| doom | doom | โ |
| dos | DOS | โ
|
| fairchild | fairchild | โ |
| fba2012 | fba2012 | โ |
| fbneo | fbneo | โ |
| fds | Family Computer Disk System | โ
|
| game-and-watch | Game & Watch | โ
|
| gb | Game Boy | โ
|
| gba | Game Boy Advance | โ
|
| gbc | Game Boy Color | โ
|
| genesis-slash-megadrive | Sega Mega Drive/Genesis | โ
|
| gamegear | Sega Game Gear | โ
|
| gw | gw | โ |
| intellivision | Intellivision | โ
|
| jaguar | Atari Jaguar | โ
|
| lynx | Atari Lynx | โ
|
| md | md | โ |
| megaduck | megaduck | โ |
| ms | ms | โ |
| msx | MSX | โ
|
| n64 | Nintendo 64 | โ
|
| nds | Nintendo DS | โ
|
| neocd | neocd | โ |
| neogeo | neogeo | โ |
| nes | Nintendo Entertainment System | โ
|
| ngc | Nintendo GameCube | โ
|
| ngp | ngp | โ |
| odyssey | odyssey | โ |
| pc-98 | PC-98 | โ
|
| pce | pce | โ |
| pcecd | pcecd | โ |
| pico | pico | โ |
| pokemon-mini | Pokรฉmon mini | โ
|
| ps | PlayStation | โ
|
| ps2 | PlayStation 2 | โ
|
| ps3 | PlayStation 3 | โ
|
| ps4 | ps4 | โ |
| psp | PlayStation Portable | โ
|
| psvita | PlayStation Vita | โ
|
| saturn | Sega Saturn | โ
|
| sega32 | Sega 32X | โ
|
| scummvm | scummvm | โ |
| segacd | Sega CD | โ
|
| segasgone | segasgone | โ |
| sms | Sega Master System/Mark III | โ
|
| sgb | sgb | โ |
| sgfx | sgfx | โ |
| snes | Super Nintendo Entertainment System | โ
|
| supervision | supervision | โ |
| switch | Nintendo Switch | โ
|
| virtualboy | Virtual Boy | โ
|
| wii | Wii | โ
|
| win | PC (Microsoft Windows) | โ
|
| wiiu | Wii U | โ
|
| wonderswan | WonderSwan | โ
|
| wonderswan-color | WonderSwan Color | โ
|
| xbox | Xbox | โ
|
| xbox360 | Xbox 360 | โ
|
| xboxone | Xbox One | โ
|
## ๐ 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:
| shortcode | region |
|-----------|---------------|
| A | Australia |
| AS | Asia |
| B | Brazil |
| C | Canada |
| CH | China |
| E | Europe |
| F | France |
| FN | Finland |
| G | Germany |
| GR | Greece |
| H | Holland |
| HK | Hong Kong |
| I | Italy |
| J | Japan |
| K | Korea |
| NL | Netherlands |
| NO | Norway |
| PD | Public Domain |
| R | Russia |
| S | Spain |
| SW | Sweden |
| T | Taiwan |
| U | USA |
| UK | England |
| UNK | Unknown |
| UNL | Unlicensed |
| W | World |
*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](https://github.com/zurdi15/romm/blob/master/CHANGELOG.md)
# ๐ Credits
* Pc and Mac icon support - Keyboard and mouse icons created by Flat Icons - Flaticon
* Default user icon - User Default icon by Icons8
