Giter VIP home page Giter VIP logo

romm's Introduction

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
  • Download games directly from your web-browser
  • Edit your game files directly from your web-browser
  • Works with SQLite or MaridDB (SQLite by default)
  • Responsive design
  • Light and dark theme

Roadmap

  • Set a custom cover for each game
  • Upload games directly from your web-browser
  • Manage save files directly from your web-browser

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

romm_readme.mp4

Mobile

RomM.Presentation.-.mobile.mp4

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.

Platforms support

The following table shows how to name your platforms folders in order to get the games metadata. 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 Y
amiga Amiga Y
arcade Arcade Y
atari atari N
coleco coleco N
commodore commodore N
cpc cpc N
cps1 cps1 N
cps2 cps2 N
cps3 cps3 N
daphne daphne N
dc Dreamcast Y
dos DOS Y
fairchild fairchild N
fba2012 fba2012 N
fbneo fbneo N
fds Family Computer Disk System Y
gb Game Boy Y
gba Game Boy Advance Y
gbc Game Boy Color Y
gg gg N
gw gw N
intellivision Intellivision Y
jaguar Atari Jaguar Y
lynx Atari Lynx Y
md md N
megaduck megaduck N
ms ms N
msx MSX Y
n64 Nintendo 64 Y
nds Nintendo DS Y
neocd neocd N
neogeo neogeo N
nes Nintendo Entertainment System Y
ngp ngp N
odyssey odyssey N
pce pce N
pcecd pcecd N
pico pico N
poke poke N
ps PlayStation Y
ps2 PlayStation 2 Y
psp PlayStation Portable Y
scummvm scummvm N
segacd Sega CD Y
segasgone segasgone N
sgb sgb N
sgfx sgfx N
snes Super Nintendo Entertainment System Y
supervision supervision N
switch Nintendo Switch Y

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

romm's People

Contributors

alexkalopsia avatar zurdi15 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.