From 6e3f3c9ea695737a8f2f01f03f1658ddeef5cc63 Mon Sep 17 00:00:00 2001 From: Zurdi <34356590+zurdi15@users.noreply.github.com> Date: Tue, 28 Mar 2023 22:48:22 +0200 Subject: [PATCH] Update readme.md --- readme.md | 122 +++++++++++++++++++++++++++--------------------------- 1 file changed, 61 insertions(+), 61 deletions(-) diff --git a/readme.md b/readme.md index 62f825deb..688d833a0 100644 --- a/readme.md +++ b/readme.md @@ -10,7 +10,7 @@ Inspired by [Jellyfin](https://jellyfin.org/) and after found that the awesome [ For now, it is only available as a docker [image](https://hub.docker.com/r/zurdi15/romm) (amd64/arm64) -## 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 @@ -21,7 +21,7 @@ For now, it is only available as a docker [image](https://hub.docker.com/r/zurdi * Responsive design * Light and dark theme -## Roadmap ๐Ÿ›  +## ๐Ÿ›  Roadmap * Set a custom cover for each game * Upload games directly from your web-browser @@ -29,7 +29,7 @@ For now, it is only available as a docker [image](https://hub.docker.com/r/zurdi # Prerequisites -## Folder structure โš ๏ธ +## โš ๏ธ Folder structure To allow RomM scan your retro games library, it should follow the following structure: @@ -53,11 +53,11 @@ library/ # Preview -## Desktop ๐Ÿ–ฅ +## ๐Ÿ–ฅ Desktop https://user-images.githubusercontent.com/34356590/227992371-33056130-c067-49c1-ae32-b3ba78db6798.mp4 -## Mobile ๐Ÿ“ฑ +## ๐Ÿ“ฑ Mobile https://user-images.githubusercontent.com/34356590/228007442-0a9cbf6b-4b62-4c1a-aad8-48b13e6337e8.mp4 @@ -65,7 +65,7 @@ https://user-images.githubusercontent.com/34356590/228007442-0a9cbf6b-4b62-4c1a- Last version of the docker [image](https://hub.docker.com/r/zurdi15/romm/tags) -## Installation ๐Ÿณ +## ๐Ÿณ Installation Check the [docker-compose.yml](https://github.com/zurdi15/romm/blob/master/docker/docker-compose.example.yml) example @@ -73,69 +73,69 @@ Get API key from [IGDB](https://api-docs.igdb.com/#about) for the CLIENT_ID and # Platforms support -## Naming convention ๐ŸŽฎ +## ๐ŸŽฎ Naming convention If the RomM folders 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 | 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 โ› +| 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 | โœ… | +| 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 | โœ… | + +## โ› 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 ๐Ÿงพ +## ๐Ÿงพ References * Complete [changelog](https://github.com/zurdi15/romm/blob/master/CHANGELOG.md)