Updated Signatures (markdown)

Michael Green
2024-02-02 16:31:09 +11:00
parent 896cdebfed
commit e107047734

@@ -1,6 +1,10 @@
While games can be added to the server without them, it is recommended adding some signature DAT files beforehand to allow for better matching of ROMs to games.
Signatures are used to match a ROM to a game name using the hash of the ROM (MD5 or SHA1). Without access to a signature database, Gaseous will attempt to "guess" the game name from the file name.
These signature DAT files contain a list of titles with hashes for many of the ROM images that have been found by the community.
# Local Signatures
This is the default method.
Local signatures are also always checked if no other source (see below) is available, enabled, or able to provide a match.
Currently supported DAT's:
* TOSEC: https://www.tosecdev.org/downloads/category/56-2023-01-23
@@ -8,7 +12,7 @@ Currently supported DAT's:
If there are other DAT's you'd like to see support for, please raise an issue with a link to the DAT's.
## Adding signature DAT files
## Adding signature DAT files to the local database
### TOSEC
1. Download the DAT files from the source website. For example; from https://www.tosecdev.org/downloads/category/56-2023-01-23
2. Extract the archive
@@ -22,4 +26,16 @@ If there are other DAT's you'd like to see support for, please raise an issue wi
### MAME MESS
1. Download the DAT files from the source website. For example; from https://www.progettosnaps.net/dats/MAME
2. Extract the archive
3. Copy the file name ``MAME 0.257 (mess).dat`` files to ``~/.gaseous-server/Data/Signatures/MAME MESS/``
3. Copy the file name ``MAME 0.257 (mess).dat`` files to ``~/.gaseous-server/Data/Signatures/MAME MESS/``
# Other Signature Sources
**Note:** This is still experimental.
## Hasheous
Hasheous is an open source project that provides an API that Gaseous can access to match a ROM hash to a game title. It also (at the time of writing) provides IGDB match information for hashes that have been submitted before. This can result in a much faster match when importing ROMs.
There are two config.json options required to enable:
* ``SignatureSource`` set to ``Hasheous``
* ``HasheousHost`` set to a Hasheous server URL. The current project server is hosted at ``https://hasheous.org/``