script_dump_en - unagi Wiki - unagi

anago script file reference - dump mode

Script Files

Anago loads two script files: flashcore.nut and the spcified .ad file. Do not change dumpcore.nut.

.ad file must define a variable and two functions. There are 'board', 'cpu_dump()' and 'ppu_dump()'. It's possible to define another function with brief scripting.

Required Variables and Functions on ROM Dump Mode

board

• mappernum: default number for iNES header mapper value.
• cpu_romsize: default rom capacity for target Program ROM
• cpu_banksize: variable bank size for target mapper on CPU region
• ppu_romsize: default rom capacity for target Charcter ROM
• ppu_banksize: variable bank size for target mapper on PPU region
• ppu_ramfind: If assigned as "true", anago will autodetect the type of charcter memory ROM or RAM.
• vram_mirrorfind: If assigned as "true", anago will autodectect the vram conncetion. If the target mapper is controlled by the program, it must be set as "false."

The unit of xxx_romsize and xxx_banksize are in bytes. It is possible to change values via the commandline.

cpu_dump()

function cpu_dump(d, pagesize, banksize)

Arguments

• d: userpointer
• pagesize: board.cpu_romsize * scale / board.cpu_banksize. This is used to specify the loop term condition.
• banksize: board.cpu_romsize. It is used to specify an argument for cpu_read()

Returns

nothing

Description

This function is assigned to the dump ROM data on CPU region. This is used for the 'loop' and 'dump' variables, as well as for fixed rombanks.

ppu_dump()

function ppu_dump(d, pagesize, banksize)

Arguments

• d: userpointer
• pagesize: board.ppu_romsize * scale / board.ppu_banksize. It is used to be term condition 'for' loop.
• banksize: board.ppu_romsize. It is used to be a argument for ppu_read()

Returns

nothing

Description

If ppu_romsize is 0, this function is unnecessary. When ppu_ramfind() returns true and charcter memory is connected RAM, this function is not called. This function is assigned to dump ROM data on PPU region. Please use this for loop and dump variable rombank.

Available functions for .ad file

cpu_write()

see decsription script_common_en.

cpu_read()

function cpu_read(d, address, length)

Arguments

• d: userpointer
• address: target address. Available range is 0x8000 to 0xffff.
• length: read length. Available range is 0 to 0x3fff.

Returns

nothing

Description

This function dumps program ROM data from the specified CPU region target address. When length is 0, the host will read data, but will not save any of it. Please note that this function is required when using MMC2 and MMC4 mappers.

ppu_read()

function ppu_read(d, address, length)

Arguments

• d: userpointer
• address: target address. Available range is 0x0000 to 0x1fff.
• length: read length. Available range is 1 to 0x1fff.

Returns

nothing

Description

This function dumps charcter ROM data from the PPU region's target address.