Reference

Reference

Supported formats

Raw ROMs (all cartridge consoles), .zip (pre-loaded ROM, Arduboy FX, DOSZ/Zip64/DOSC), .m3u playlists, discs (.cue/.bin/.iso/.gdi/.chd, GameCube/Wii .rvz/.wia — RVZ/WIA hashed live, no conversion), 3DS .cia/.3ds/.3dsx (keys required), and Neo Geo .neo carts.

Console list: NES/Famicom, SNES/SFC, N64, GB/GBC/GBA, Master System, Mega Drive/Genesis, Game Gear, 32X, SG-1000, PCE/TG-16, PCE-CD, Saturn, Sega CD, Dreamcast, PS1, PS2, PSP, 3DO, PC-FX, Jaguar(+CD), Neo Geo Pocket(+Color), Neo Geo CD, NDS/DSi/3DS — the full rcheevos console table (~59 consoles), including classic microcomputers.

Library API

• RcHash.GenerateFromFile(out hash, consoleId, path) — hash a file.
• RcHash.GenerateFromBuffer(out hash, consoleId, buffer, bufferSize) — hash in-memory data (e.g. the first entry of a zip).
• HashEngine.FromFile / HashEngine.FromBuffer — per-console dispatch.
• HashIterator / RcHashIterator — iterate API for ? auto-detection.
• Hash3Ds.InitHash3Ds(systemDir) — load 3DS key files (aes_keys.txt, optionally seeddb.bin).

Full API reference: https://purelogiccode.github.io/RetroAchievementsSharp/reference/public-api/

Known quirks (reproduced from the original)

• 64 MiB whole-file cap for buffered formats.
• Console keys only accepted for consoles with a non-empty RA group (NULL-group consoles need numeric ids).
• atoi console-key fallback (the key 3DS resolves to console 3).
• Wildcard path construction splits on \ only (Windows).

Full list: known-quirks

Resources

• Parity evidence
• Hashing semantics
• Console table