Mesen-SX/Docs/content/debugging/DebuggerIntegration.md

title	weight	pre	chapter
Integration with assemblers	40		false

When building homebrew software in assembly or C, it is possible to export the labels used in your code and import them into Mesen-S to simplify the debugging process. This allows the debugger to know which portions of the ROM correspond to which functions in your code, as well as display your code's comments inside the debugger itself.

Integration with assemblers

CC65 / CA65

CC65/CA65 are able to produce .DBG files which can be imported into Mesen-S' debugger.
To make CC65/CA65 create a .DBG file during the compilation, use the --dbgfile command line option.

To import the .DBG file, use the File→Workspace→Import Labels command in the debugger window.

You can also enable the Automatically load DBG/MSL debug symbols option in File→Import/Export→Integration Settings to make Mesen-S load any .DBG file it finds next to the ROM whenever the debugger is opened.
Note: For this option to work, the ROM file must have the same name as the DBG file (e.g MyRom.sfc and MyRom.dbg) and be inside the same folder.

Source View

Source View

When a .DBG file is loaded, an additional option appears in the code window's right-click menu:

• Switch to Source View: This turns on Source View mode, which allows you to debug the game using the original code files, rather than the disassembly. This can be used for both assembly and C projects.

bass

Integration with bass is possible via .sym files. When the Automatically load DBG/MSL debug symbols option in File→Import/Export→Integration Settings is enabled, the debugger will automatically attempt to load .sym files with the same name as the ROM (e.g MyRom.sfc and MyRom.sym)

RGBDS

Integration with RGBDS (for Game Boy projects) is possible via the .sym files that RGBDS produces. When the Automatically load DBG/MSL debug symbols option in File→Import/Export→Integration Settings is enabled, the debugger will automatically attempt to load .sym files with the same name as the ROM (e.g MyRom.sfc and MyRom.sym)

Importing and exporting labels

Import/Export

Mesen-S can also import and export labels in .msl format. The ability to import labels can be used to integrate the debugger with your own workflow (e.g by creating your own scripts that produce .msl files)

Mesen-S Label Files (.msl)

The .msl files used by Mesen-S to import/export labels is a simple text format. For example, this defines a label and comment on byte $100 of PRG ROM:

PRG:100:MyLabel:This is a comment

The format also supports multi-byte labels, defined by giving specifying an address range:

PRG:200-2FF:MyArray

The first part on each row is used to specify the label's type:

PRG: PRG ROM labels
WORK: Work RAM labels (for the SNES' internal 128kb Work RAM)
SAVE: Save RAM labels
REG: Register labels
SPCRAM: SPC RAM labels
SPCROM: SPC IPL ROM labels
IRAM: SA-1 IRAM labels
PSRAM: BS-X PS RAM labels
MPACK: BS-X Memory Pack labels
DSPPRG: DSP Program ROM labels
GBPRG: Game Boy Program ROM labels
GBWRAM: Game Boy Work RAM labels
GBSRAM: Game Boy Cart/Save RAM labels
GBHRAM: Game Boy High RAM labels
GBBOOT: Game Boy Boot ROM labels
GBREG: Game Boy Register labels

Integration Settings

Integration Settings

For fine-grain control over the DBG/MSL file imports, the Integration Settings ( File→Import/Export→Integration Settings) window can be used.
This allows you to configure which types of labels/comments should be imported, as well as choosing whether or not Mesen-S should delete all existing labels before importing DBG/MSL files.