Skip to content
/ romm Public
forked from rommapp/romm

RomM (Rom Manager) is a web based retro roms manager integrated with IGDB.

License

Notifications You must be signed in to change notification settings

gerard33/romm

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Gameyfin Logo

RomM (Rom Manager)

Overview

Inspired by Jellyfin and after found that the awesome Gameyfin project is not supported for arm64 architectures 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
  • EmuDeck folder structure compatibility
  • 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
  • Multiple files games support - issue #40

Prerequisites

โš ๏ธ 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.

  • Structure 1 (priority high) - roms folder at root of library folder:
library/
โ”œโ”€ roms/
   โ”œโ”€ gbc/
   โ”‚  โ”œโ”€ rom_1.gbc
   โ”‚  โ”œโ”€ rom_2.gbc
   โ”‚
   โ”œโ”€ gba/
   โ”‚  โ”œโ”€ rom_1.gba
   โ”‚  โ”œโ”€ rom_2.gba
   โ”‚ 
   โ”œโ”€ gb/
      โ”œโ”€ rom_1.gb
      โ”œโ”€ rom_1.gb
  • Structure 2 (priority low) - roms folder inside each platform folder
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

romm_readme.mp4

๐Ÿ“ฑ Mobile

RomM.Presentation.-.mobile.mp4

Installation

๐Ÿณ Docker

Last version of the docker image

Check the docker-compose.yml example

Get API key from IGDB for the CLIENT_ID and CLIENT_SECRET variables.

Configuration

โš™๏ธ Config yml file

RomM can be configured through a yml file. This is used to exclude folders and files with a certain extension to be scanned. For a configuration change to take effect, RomM must be restarted.

Config file example:

exclude:
  folders:
    - 'folder_1_to_exclude'
    - 'folder_2_to_exclude'
  files:
    - 'txt'
    - 'file_extension_to_exclude'

Naming convention

๐ŸŽฎ Platforms 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. Make sure that the platforms folder names are lowercase.

slug name games metadata
3ds Nintendo 3DS โœ…
amiga Amiga โœ…
arcade Arcade โœ…
atari atari โŒ
coleco coleco โŒ
commodore commodore โŒ
cpc cpc โŒ
cps1 cps1 โŒ
cps2 cps2 โŒ
cps3 cps3 โŒ
daphne daphne โŒ
dc Dreamcast โœ…
dos DOS โœ…
fairchild fairchild โŒ
fba2012 fba2012 โŒ
fbneo fbneo โŒ
fds Family Computer Disk System โœ…
gb Game Boy โœ…
gba Game Boy Advance โœ…
gbc Game Boy Color โœ…
gg gg โŒ
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 โŒ
pce pce โŒ
pcecd pcecd โŒ
pico pico โŒ
poke poke โŒ
ps PlayStation โœ…
ps2 PlayStation 2 โœ…
psp PlayStation Portable โœ…
scummvm scummvm โŒ
segacd Sega CD โœ…
segasgone segasgone โŒ
sgb sgb โŒ
sgfx sgfx โŒ
snes Super Nintendo Entertainment System โœ…
supervision supervision โŒ
switch Nintendo Switch โœ…
wii Wii โœ…
win PC (Microsoft Windows) โœ…

๐Ÿ“‘ Tags support

Games can be tagged with region, revision or other tags using parenthesis in the file name. Region and revision tags must be built with the following reserved words:

  • Region tags must be prefixed with "reg-": (reg-EUR) / (reg-USA) / (reg-Japan) / (reg-whatever)
  • Revision tags must be prefixed with "rev-": (rev-1) / (rev-v2) / (rev-whatever)
  • Any other tag can have any structure
  • Example: my_game (reg-EUR)(rev-1)(aditional_tag_1)(aditional_tag_2).gba

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

๐ŸŽ– Credits

โค๏ธ Support RomM

Buy Me A Coffee

About

RomM (Rom Manager) is a web based retro roms manager integrated with IGDB.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 49.7%
  • Vue 41.2%
  • JavaScript 6.2%
  • Dockerfile 1.7%
  • HTML 0.5%
  • Shell 0.4%
  • SCSS 0.3%