Add Romm (#310)
* Add Romm * Update docker-compose.yml * Remove Comments * Review Updates * Update config.json
This commit is contained in:
DrMxrcy
GitHub
parent
0ce25347de
commit
5248989b08
44
apps/romm/config.json
Normal file
44
apps/romm/config.json
Normal file
|
|
@ -0,0 +1,44 @@
|
|||
{
|
||||
"$schema": "../schema.json",
|
||||
"name": "RomM",
|
||||
"port": 8178,
|
||||
"available": true,
|
||||
"exposable": true,
|
||||
"id": "romm",
|
||||
"tipi_version": 1,
|
||||
"version": "1.6.2",
|
||||
"categories": ["gaming"],
|
||||
"description": "RomM (Rom Manager) is a web based retro roms manager integrated with IGDB.",
|
||||
"short_desc": "RomM (Rom Manager) is a web based retro roms manager integrated with IGDB.",
|
||||
"author": "Zurdi15",
|
||||
"source": "https://github.com/zurdi15/romm",
|
||||
"form_fields": [
|
||||
{
|
||||
"type": "random",
|
||||
"label": "ROMM_MYSQL_PASSWORD",
|
||||
"min": 32,
|
||||
"env_variable": "ROMM_MYSQL_PASSWORD"
|
||||
},
|
||||
{
|
||||
"type": "text",
|
||||
"label": "IGDB Client ID",
|
||||
"hint": "IGDB Client ID",
|
||||
"required": true,
|
||||
"env_variable": "ROMM_IGDB_CLIENT_ID"
|
||||
},
|
||||
{
|
||||
"type": "text",
|
||||
"label": "IGDB Client Secret",
|
||||
"hint": "IGDB Client Secret",
|
||||
"required": true,
|
||||
"env_variable": "ROMM_IGDB_CLIENT_SECRET"
|
||||
},
|
||||
{
|
||||
"type": "text",
|
||||
"label": "Steam Grid DB API",
|
||||
"hint": "Steam Grid DB API",
|
||||
"required": false,
|
||||
"env_variable": "ROMM_STEAMGRIDDB_API_KEY"
|
||||
}
|
||||
]
|
||||
}
|
||||
0
apps/romm/data/config.yml
Normal file
0
apps/romm/data/config.yml
Normal file
48
apps/romm/docker-compose.yml
Normal file
48
apps/romm/docker-compose.yml
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
version: "3"
|
||||
|
||||
services:
|
||||
romm:
|
||||
image: zurdi15/romm:1.6.2
|
||||
container_name: romm
|
||||
environment:
|
||||
- ROMM_DB_DRIVER=mariadb
|
||||
- DB_HOST=romm-db
|
||||
- DB_PORT=3306
|
||||
- DB_USER=tipi
|
||||
- DB_NAME=romm
|
||||
- DB_PASSWD=${ROMM_MYSQL_PASSWORD}
|
||||
- CLIENT_ID=${ROMM_IGDB_CLIENT_ID}
|
||||
- CLIENT_SECRET=${ROMM_IGDB_CLIENT_SECRET}
|
||||
- STEAMGRIDDB_API_KEY="${ROMM_STEAMGRIDDB_API_KEY}"
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- ${ROOT_FOLDER_HOST}/media/data/roms:/romm/library
|
||||
- ${APP_DATA_DIR}/data/romm-resources:/romm/resources
|
||||
- ${APP_DATA_DIR}/data/config.yml:/romm/config.yml
|
||||
ports:
|
||||
- ${APP_PORT}:80
|
||||
depends_on:
|
||||
- romm-db
|
||||
networks:
|
||||
- tipi_main_network
|
||||
labels:
|
||||
traefik.enable: ${APP_EXPOSED}
|
||||
traefik.http.routers.romm.rule: Host(`${APP_DOMAIN}`)
|
||||
traefik.http.routers.romm.entrypoints: websecure
|
||||
traefik.http.routers.romm.service: romm
|
||||
traefik.http.routers.romm.tls.certresolver: myresolver
|
||||
traefik.http.services.romm.loadbalancer.server.port: 80
|
||||
|
||||
romm-db:
|
||||
image: lscr.io/linuxserver/mariadb:latest
|
||||
container_name: romm-db
|
||||
environment:
|
||||
- MYSQL_ROOT_PASSWORD=${ROMM_MYSQL_PASSWORD}
|
||||
- MYSQL_DATABASE=romm
|
||||
- MYSQL_USER=tipi
|
||||
- MYSQL_PASSWORD=${ROMM_MYSQL_PASSWORD}
|
||||
volumes:
|
||||
- ${APP_DATA_DIR}/data/mysql/config:/config
|
||||
restart: "unless-stopped"
|
||||
networks:
|
||||
- tipi_main_network
|
||||
170
apps/romm/metadata/description.md
Normal file
170
apps/romm/metadata/description.md
Normal file
|
|
@ -0,0 +1,170 @@
|
|||
# Overview
|
||||
|
||||
Inspired by [Jellyfin](https://jellyfin.org/) and after found that the awesome [Gameyfin](https://github.com/grimsi/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](https://hub.docker.com/r/zurdi15/romm) (amd64/arm64)
|
||||
|
||||
## [](https://github.com/zurdi15/romm#-features)⚡ 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
|
||||
|
||||
## [](https://github.com/zurdi15/romm#-roadmap)🛠 Roadmap
|
||||
|
||||
- Upload games directly from your web-browser - [issue #54](https://github.com/zurdi15/romm/issues/54)
|
||||
- Manage save files directly from your web-browser - [issue #55](https://github.com/zurdi15/romm/issues/55)
|
||||
- Set a custom cover for each game - [issue #53](https://github.com/zurdi15/romm/issues/53)
|
||||
- Multiple files games support - [issue #40](https://github.com/zurdi15/romm/issues/40)
|
||||
|
||||
# [](https://github.com/zurdi15/romm#prerequisites)Prerequisites
|
||||
|
||||
## [](https://github.com/zurdi15/romm#️-folder-structure)⚠️ 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
|
||||
```
|
||||
|
||||
# [](https://github.com/zurdi15/romm#configuration)Configuration
|
||||
|
||||
## [](https://github.com/zurdi15/romm#️-config-yml-file)⚙️ 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'
|
||||
```
|
||||
|
||||
# [](https://github.com/zurdi15/romm#naming-convention)Naming convention
|
||||
|
||||
## [](https://github.com/zurdi15/romm#-platforms-support)🎮 Platforms support
|
||||
|
||||
If the RomM [folder structure](https://github.com/zurdi15/romm#%E2%9A%A0%EF%B8%8F-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 | ❌ |
|
||||
| c64 | Commodore C64/128/MAX | ✅ |
|
||||
| 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 | ✅ |
|
||||
| ps3 | PlayStation 3 | ✅ |
|
||||
| ps4 | ps4 | ❌ |
|
||||
| psp | PlayStation Portable | ✅ |
|
||||
| psvita | PlayStation Vita | ✅ |
|
||||
| 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) | ✅ |
|
||||
| wiiu | Wii U | ✅ |
|
||||
| xbox | Xbox | ✅ |
|
||||
| xbox360 | Xbox 360 | ✅ |
|
||||
| xboxone | Xbox One | ✅ |
|
||||
|
||||
## [](https://github.com/zurdi15/romm#-tags-support)📑 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.
|
||||
BIN
apps/romm/metadata/logo.jpg
Normal file
BIN
apps/romm/metadata/logo.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.5 KiB |
Loading…
Reference in New Issue
Block a user