mirror of
https://github.com/rommapp/romm.git
synced 2026-06-28 14:56:01 +00:00
3c9fcaebdc2e22e96ae39a5aaeacc9ee8c491693
Overview
Inspired by Jellyfin and after found that the awesome Gameyfin project is not supported for arm64 architectures (since my own homelab is only made by 3 rpis) and it is a general game library manager, I decided to develop my own game library solution, focused on retro gaming.
For now, it is only available as a docker image (amd64/arm64)
Features
- Scans 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
- Download games directly from your web-browser
- Edit your game files directly from your web-browser
- Set a custom cover for each game [WIP]
- Upload games directly from your web-browser [WIP]
- Manage save files directly from your web-browser [WIP]
- Responsive design
- Light and dark theme
Prerequisites
To allow RomM scan your retro games library, it should follow the following structure:
library/
├─ gbc/
│ ├─ roms/
│ ├─ rom_1.gbc
│ ├─ rom_2.gbc
|
├─ gba/
│ ├─ roms/
│ ├─ rom_1.gba
│ ├─ rom_2.gba
|
├─ gb/
│ ├─ roms/
│ ├─ rom_1.gb
│ ├─ rom_1.gb
Preview
Desktop
Mobile
Docker image
Last version of the docker image
Installation
Check the docker-compose.yml example
Get API key from IGDB for the CLIENT_ID and CLIENT_SECRET variables.
Troubleshoot
After the first installation, sometimes the RomM container can have problems connecting with the database. Restarting the RomM container may solve the problem.
Description
Languages
Python
45.1%
Vue
42%
TypeScript
11.7%
CSS
0.7%
Shell
0.2%
Other
0.3%