Skip to content

Latest commit

 

History

5 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

disasmdb

Annotations For retrodisasm License: CC0-1.0

Community-maintained ROM annotations for retrodisasm across classic game systems. Annotation files provide names, comments, and code/data boundaries for generating readable disassemblies from your own ROMs.

Benefits

  • Share disassembly knowledge without distributing ROMs or game code: annotations describe the ROM, while users supply its bytes locally.
  • Generate assembly that reassembles byte-for-byte to the original ROM. Use -verify with a supported installed assembler to check the match.
  • Reuse the same annotations across assembler formats. For NES, retrodisasm supports ca65, asm6, NESASM, and retroasm output via -a.

Layout

Files are grouped by console and then the first letter of the game title:

nes/
  s/
    sample-game-world.ini

Use lowercase console folders and title initials (az, or 0-9 for digits). Keep leading articles such as “The”. Use kebab-case filenames, adding region and revision where needed.

Usage

Use a retrodisasm version that supports -annotations. From this repository:

retrodisasm -annotations "<console>/<initial>/<game>.ini" -a ca65 -o game.asm game.nes

Replace the annotation path and ROM filename with your game's files. retrodisasm rejects ROMs that do not match the annotation's checksums.

See the annotation format documentation for supported sections and expressions.

Contributing

  • Follow the console/title layout and identify the supported region and revision.
  • Include ROM checksums and preserve source attribution in the annotation file.
  • Validate annotations with a matching ROM and inspect the generated output.
  • Keep ROMs, generated assemblies, and build artifacts outside this repository.

License

Original contributions are provided under CC0 1.0 Universal. Third-party material retains its applicable rights; this dedication does not relicense the referenced games or upstream sources.

Sharing annotations does not automatically eliminate copyright concerns. Use original comments and material you have permission to share. Under U.S. copyright guidance, facts are not protected, but their creative expression may be.

About

Community-maintained ROM annotations and reconstructed disassemblies for retrodisasm across classic game systems

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors