sendnrw/gaseous-server
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Adding ROMs (markdown)

Michael Green
2024-02-02 21:37:05 +11:00
parent 9bbcd64b71
commit c2c1c1823e
1 changed files with 34 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
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
<img width="97" alt="Screenshot 2024-02-02 at 9 28 11 pm" src="https://github.com/gaseous-project/gaseous-server/assets/84688932/9a2e3342-edbb-4ad1-abc0-2480f2e9c288">
3. Go to Settings in the left hand navigation bar
<img width="163" alt="Screenshot 2024-02-02 at 9 29 14 pm" src="https://github.com/gaseous-project/gaseous-server/assets/84688932/cc29928c-964b-42df-a499-7c625ada437c">
4. Click the New Library button
5. The New Library dialog will appear
<img width="344" alt="Screenshot 2024-02-02 at 9 30 15 pm" src="https://github.com/gaseous-project/gaseous-server/assets/84688932/50cdb29c-d327-42a9-ac2f-34ceff363d46">
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
<img width="972" alt="Screenshot 2024-02-02 at 9 33 15 pm" src="https://github.com/gaseous-project/gaseous-server/assets/84688932/f6f7774b-8736-4874-8141-61ecd4035d1d">
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