Reporting unknown MD5 checksums

From ScummVM :: Wiki
Revision as of 14:20, 10 February 2008 by Md5 (talk | contribs) (Added a page with details on how to obtain and submit MD5 checksums)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This page contains instructions on what to do if you got a version of a game that the ScummVM team is not aware of (perhaps a rare version, or a less known one, or perhaps an unknown non-English version). In such cases, here's what you can do to get your version supported under ScummVM:

To get the MD5 sums:

  • The easiest way would be to check the ScummVM console window, which will report the unknown MD5s you got. If you can't see the console window, you can redirect ScummVM's output to a text file, by running ScummVM as follows:
scummvm > file.txt
  • If for some reason you can't see ScummVM's window or don't get any output in the text file, you need to follow a bit harder process. The MD5 based detection in ScummVM uses the first bytes of each file to determine its MD5 checksum. This is necessary to speed up the detection process and to avoid having to calculate the MD5 checksums of large files, which would make game detection very slow.

Each engine in ScummVM uses a different number of bytes to calculate their MD5 checksums.

Number of bytes in each engine, to compute an MD5 hash:
AGI, AGOS, Cine, Cruise, Drascula, Gob, Parallaction, Saga - 5000 bytes
Igor, Lure - 1024 bytes
Kyra, Scumm - 1024 * 1024 bytes
Touche - 4096 bytes

queen, Sky, Sword1, Sword2 use a different detection

To get the correct MD5 checksum, run the following:

Under *nix:

 head -c size file | md5sum

Under Windows, download md5deep and run it like this:

 md5deep -p size file | find /i "offset 0-size"

Where size depends of the engine, as described above

After you get the MD5 sums of the game files, you can report them by using our [bug tracker]. It's much preferred over a post in the forums