Skip to content

Adding ROMs

Jump to bottom
Michael Green edited this page Feb 2, 2024 · 4 revisions

There are three ways to add ROMs to Gaseous:

  • Web Upload
  • Import directory
  • Custom library

Notes

  1. Files can be presented as either stand alone files, or as archives - zip, 7z, and RAR are supported
  2. Name the file appropriately.
    • Attempting a search for the game name on https://www.igdb.com can help with file naming. If a hash search is unsuccessful, Gaseous will fall back to attempting to search by the file name.
  3. Duplicate ROMs are not imported. If the hash of a ROM is already in the database, it will be skipped.

Web Upload

  1. Click the Upload button in the page banner
Screenshot 2024-02-02 at 5 15 04 pm
  1. In the upload dialog, optionally set the platform drop down. This can help Gaseous to determine what platform the uploaded ROMs are for if a signature match is not possible.
Screenshot 2024-02-02 at 5 16 24 pm
  1. To upload the ROMs click the "Drop files here to upload" button and select the files, or drag the ROMs into the dialog
  2. The files will be uploaded and processed. These files go into the main managed library.

Import Directory

  1. Copy the ROMs to be added into the ~/.gaseous-server/Data/Import directory
  2. Once a minute a background task named "Title Import" will process these files and move them into the main managed library
  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
  1. Go to Settings in the banner
Screenshot 2024-02-02 at 9 28 11 pm
  1. Go to Settings in the left hand navigation bar
Screenshot 2024-02-02 at 9 29 14 pm
  1. Click the New Library button
  2. The New Library dialog will appear
Screenshot 2024-02-02 at 9 30 15 pm
  1. Give the library a name
  2. 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
  1. Set the path to the ROM files
  2. Click OK
  3. The new library should be displayed under the default library
Screenshot 2024-02-02 at 9 33 15 pm
  1. 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
Clone this wiki locally