mgbdis icon indicating copy to clipboard operation
mgbdis copied to clipboard

Published 20 hours ago • verified publisher icon mattcurrie

Documentation on .sym files

Open ijacquez opened this issue 5 years ago • 3 comments

I can't seem to find more documentation on the .sym file format.

Does mgbdis implement a subset of it?

ijacquez avatar Oct 02 '19 16:10 ijacquez

Hi,

The symbol file support in mgbdis is based on a combination of the output of RGBDS, some custom magic/reserved labels, and Nocash's documentation here:

https://problemkaputt.de/gbahlp.htm#symbolicdebuginfo

mattcurrie avatar Oct 02 '19 21:10 mattcurrie

Ah, I wouldn't have thought was from no$gba. It's rather limited, unfortunately...

I have a few "hacks" that I can help integrate better into mgbdis.

For example, in the .sym file, I have:

00:C501 C501_SomeConstant

I pass --include-file constants.asm to mgbdis and in game.asm, the constants.asm file is included. In constants.asm, I define C501_SomeConstant:

C501_SomeConstant EQU $C501

This is to avoid breaking compatibility with no$gba and BGB.

ijacquez avatar Oct 03 '19 21:10 ijacquez

See gbdev/rgbds#483.

ISSOtm avatar Jan 31 '21 13:01 ISSOtm