diff --git a/README.md b/README.md index 0b2a4a523..cf54db8f0 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ [![discord-badge-img]][discord-badge] [![unraid-badge-img]][unraid-badge] -[![wiki-badge-img]][wiki] +[![docs-badge-img]][docs] @@ -30,7 +30,6 @@ - [Preview](#preview) - [Installation](#installation) - [Configuration](#configuration) - - [Folder Structure](#folder-structure) - [Configuration File](#configuration-file) - [Scheduler](#scheduler) - [Naming Convention](#naming-convention) @@ -48,7 +47,7 @@ RomM (ROM Manager) allows you to scan, enrich, browse and play your game collect - Scans and enhance your game library with metadata from [IGDB][igdb-api], [Screenscraper][screenscraper-api] and [MobyGames][mobygames-api] - Metadata available for [400+ platforms][platform-support] -- Play games directly from the browser using [EmulatorJS][wiki-emulatorjs] +- Play games directly from the browser using [EmulatorJS][docs-emulatorjs] - Share your library with friends with limited access and permissions - Official apps for [Playnite][playnite-app] and [muOS][muos-app] - Supports mutli-disk games, DCLs, mods, hacks, patches, and manuals @@ -63,138 +62,23 @@ RomM (ROM Manager) allows you to scan, enrich, browse and play your game collect # Installation -To start using RomM, check out the [Quick Start Guide][wiki-quick-start-guide] in the wiki. If you are having issues with RomM, please review the page for [troubleshooting steps][wiki-troubleshooting] and common issues, or join the [Discord][discord-invite] for support from the community. +To start using RomM, check out the [Quick Start Guide][docs-quick-start-guide] in the docs. If you are having issues with RomM, please review the page for [troubleshooting steps][docs-troubleshooting] and common issues, or join the [Discord][discord-invite] for support from the community. # Configuration -## Folder Structure - -As mentioned in the installation section, RomM requires a specific folder structure. The two supported structures are as follows: - - - - - - - - - - - - - -
Structure A (recommended) - Structure B (fallback)
- library/roms/gbc/game_1.gbc - - library/gbc/roms/game_1.gbc -
- 
-        library/
-        ├─ roms/
-        │  ├─ gbc/
-        │  │  ├─ game_1.gbc
-        │  │  └─ game_2.gbc
-        │  │
-        │  ├─ gba/
-        │  │  ├─ game_3.gba
-        │  │  └─ game_4/
-        │  │     ├─ game_4.gba
-        │  │     ├─ dlc
-        │  │     │  ├─ game_4_dlc_1.7z
-        │  │     │  └─ game_4_dlc_2.7z
-        │  │     ├─ hack
-        │  │     │  └─ game_4_hardmode.rar
-        │  │     ├─ manual
-        │  │     │  └─ game_4_manual.pdf
-        │  │     ├─ mod
-        │  │     │  └─ game_4_crazy_mode.zip
-        │  │     ├─ patch
-        │  │     │  └─ game_4_patch_v1.1.zip
-        │  │     ├─ update
-        │  │     ├─ demo
-        │  │     ├─ translation
-        │  │     └─ prototype
-        │  │
-        │  └─ ps/
-        │     ├─ game_5/
-        │     │   ├─ game_5_cd_1.iso
-        │     │   └─ game_5_cd_2.iso
-        │     │
-        │     └─ game_6.iso
-        │
-        └─ bios/
-           ├─ gba/
-           │  └─ gba_bios.bin
-           │
-           └─ ps/
-              ├─ scph1001.bin
-              ├─ scph5501.bin
-              └─ scph5502.bin
-
- 		- 
-        library/
-        ├─ gbc/
-        │  └─ roms/
-        │     ├─ game_1.gbc
-        │     └─ game_2.gbc
-        │
-        ├─ gba/
-        │  ├─ roms/
-        │  │  ├─ game_3.gba
-        │  │  └─ game_4/
-        │  │     ├─ game_4.gba
-        │  │     ├─ dlc
-        │  │     │  ├─ game_4_dlc_1.7z
-        │  │     │  └─ game_4_dlc_2.7z
-        │  │     ├─ hacks
-        │  │     │  └─ game_4_hardmode.rar
-        │  │     ├─ manuals
-        │  │     │  └─ game_4_manual.pdf
-        │  │     ├─ mods
-        │  │     │  └─ game_4_crazy_mode.zip
-        │  │     ├─ patch
-        │  │     │  └─ game_4_patch_v1.1.zip
-        │  │     ├─ update
-        │  │     ├─ demo
-        │  │     ├─ translation
-        │  │     └─ prototype
-        │  │
-        │  └─ bios/
-        │     └─ gba_bios.bin
-        │
-        └─ ps/
-           ├─ roms/
-           │  ├─ game_5/
-           │  │  ├─ game_5_cd1.iso
-           │  │  └─ game_5_cd2.iso
-           │  │
-           │  └─ game_6.iso
-           │
-           └─ bios/
-              ├─ scph1001.bin
-              ├─ scph5501.bin
-              └─ scph5502.bin
-
-
- -> [!TIP] -> For folder naming conventions, review the [Platform Support][platform-support] section. To override default system names in the folder structure (if your directories are named differently), see the [Configuration File][configuration-file] section. - ## Configuration File RomM's "understanding" of your library can be configured with a `config.yaml` file or through the `config` tab in the `Control Panel` under the `Settings` section. Refer to the [example config.yml][configuration-file-example] file for guidance on how to configure it and the [example docker-compose.yml][docker-compose-example] file on how to mount it into the container. ## Scheduler -The scheduler allows you to schedule async tasks that run in the Redis container at regular intervals. Jobs can be run at a specific time in the future, after a time delta, or at recurring internals using cron notation. The [wiki page on the scheduler][wiki-scheduled-tasks] has more information on which tasks are available and how to enable them. +The scheduler allows you to schedule async tasks that run in the Redis container at regular intervals. Jobs can be run at a specific time in the future, after a time delta, or at recurring internals using cron notation. The [docs page on the scheduler][docs-scheduled-tasks] has more information on which tasks are available and how to enable them. # Naming Convention ## Platform Support -If you adhere to the [RomM folder structure][folder-structure], RomM supports all platforms listed on the [Supported Platforms][wiki-supported-platforms] page. **The folder is case-sensitive and must be used exactly as it appears on the list.** When scanning your library, RomM will use the folder name to determine the platform and fetch the appropriate game information, metadata, and cover art. +If you adhere to the [RomM folder structure][folder-structure], RomM supports all platforms listed on the [Supported Platforms][docs-supported-platforms] page. **The folder is case-sensitive and must be used exactly as it appears on the list.** When scanning your library, RomM will use the folder name to determine the platform and fetch the appropriate game information, metadata, and cover art. ## Tag Support @@ -246,14 +130,14 @@ Here are a few projects that we think you might like: [docker-compose-example]: examples/docker-compose.example.yml [configuration-file-example]: examples/config.example.yml - + -[wiki]: https://docs.romm.app/latest/ -[wiki-supported-platforms]: https://docs.romm.app/latest/Platforms-and-Players/Supported-Platforms/ -[wiki-troubleshooting]: https://docs.romm.app/latest/Troubleshooting/ -[wiki-emulatorjs]: https://docs.romm.app/latest/Platforms-and-Players/EmulatorJS-Player/ -[wiki-scheduled-tasks]: https://docs.romm.app/latest/Maintenance/Scheduled-Tasks/ -[wiki-quick-start-guide]: https://docs.romm.app/latest/Getting-Started/Quick-Start-Guide/ +[docs]: https://docs.romm.app/latest/ +[docs-supported-platforms]: https://docs.romm.app/latest/Platforms-and-Players/Supported-Platforms/ +[docs-troubleshooting]: https://docs.romm.app/latest/Troubleshooting/ +[docs-emulatorjs]: https://docs.romm.app/latest/Platforms-and-Players/EmulatorJS-Player/ +[docs-scheduled-tasks]: https://docs.romm.app/latest/Maintenance/Scheduled-Tasks/ +[docs-quick-start-guide]: https://docs.romm.app/latest/Getting-Started/Quick-Start-Guide/ @@ -265,7 +149,7 @@ Here are a few projects that we think you might like: [discord-badge]: https://discord.gg/P5HtHnhUDH [unraid-badge-img]: https://img.shields.io/badge/Unraid-f57842?style=for-the-badge&labelColor=ee512b [unraid-badge]: https://forums.unraid.net/topic/149738-support-eurotimmy-romm-rom-manager-by-zurdi15/ -[wiki-badge-img]: https://img.shields.io/badge/Wiki-736e9b?style=for-the-badge +[docs-badge-img]: https://img.shields.io/badge/docs-736e9b?style=for-the-badge [docker-pulls-badge-img]: https://img.shields.io/docker/pulls/rommapp/romm?style=for-the-badge&label=pulls [docker-pulls-badge]: https://hub.docker.com/r/rommapp/romm