From c2c1c1823eab6c4b4818bc0b61d6b5080d5f1744 Mon Sep 17 00:00:00 2001 From: Michael Green <84688932+michael-j-green@users.noreply.github.com> Date: Fri, 2 Feb 2024 21:37:05 +1100 Subject: [PATCH] Updated Adding ROMs (markdown) --- Adding-ROMs.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/Adding-ROMs.md b/Adding-ROMs.md index 3f5476a..9a4768e 100644 --- a/Adding-ROMs.md +++ b/Adding-ROMs.md @@ -26,3 +26,37 @@ There are three ways to add ROMs to Gaseous: 3. Import errors are sent to the ``~/.gaseous-server/Data/Import Errors`` directory ## Custom Library +Gaseous can have one or more unmanaged custom libraries added. These are useful if you already have a collection of ROMs and don't want to duplicate them, or re-arrange them. + +To add a custom library: +1. Ensure the server can see the files + * this could be another location on your host, or a bind mount if using docker or docker-compose + * also ensure that permissions are correct - it's recommended that the server only have read-only access to your files +2. Go to Settings in the banner +Screenshot 2024-02-02 at 9 28 11 pm + +3. Go to Settings in the left hand navigation bar +Screenshot 2024-02-02 at 9 29 14 pm + +4. Click the New Library button +5. The New Library dialog will appear +Screenshot 2024-02-02 at 9 30 15 pm + +6. Give the library a name +7. Set the default platform for the ROMs found within + * this helps Gaseous identify ROM files if it can't determine the platform + * if the hash of a ROM file matches to a different platform, the matched platform is used rather than the default +8. Set the path to the ROM files +9. Click OK +10. The new library should be displayed under the default library +Screenshot 2024-02-02 at 9 33 15 pm + +11. If the library is incorrect, press the delete button on the right and try to recreate the library + +**Notes** +* New libraries are not scanned immediately - they are only scanned when the Library Scan process is running. +* The Library Scan process can be started manually by: + 1. Go to the System page under settings + 2. Find the process "Library Scan" in the list + 3. Click Start on the right +* Depending on the size of the library, it may take some time for Gaseous to identify all the files within \ No newline at end of file