Skip to content

Custom Deflemask .vgm based playback engine for the Nintendo Game Boy

License

Notifications You must be signed in to change notification settings

Pegmode/Deflemask-GB-Engine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Deflemask Game Boy Engine (DGB)

Custom Deflemask .vgm based music playback engine for the Nintendo Game Boy. Now the official Deflemask ROM exporter as of Deflemask v1.0.3.

this engine only works with Deflemask generated .vgms and is not intended for other .vgms

supports EExx event commands from Delfemask and uses proper engine timings instead of .vgm update timings. Converter converts .vgm to either .gbs, .bin or .gb.

"High on time efficiency, low on space efficiency."

Formerly known as Deflemask GBVGM (DMGBVGM)

Usage

  1. Download the latest release here
  2. run DeflemaskGBVGMConverter.exe like this
    DeflemaskGBVGMConverter.exe <.vgm file> [arguments...]

arguments

  • -r <engine rate> set the engine rate in Hz (Clock value in Deflemask). Required if you use a engine tick speed other than NTSC.
  • -o <output path> set the output filename (defaults to "out")
  • -bin export song data as .bin to include in a GB rom.
  • -g export .gbs
  • -ti <offset> increase tma offset timing (speed up song if using custom engine speed).
  • -td <offset> decrease tma offset timing (slow down song if using custom engine speed).

custom ROM

if you want to add this player to your game boy assembly program check out this page on the wiki.

Projects that use this engine

More info

For more info, check out the wiki

Sync command

Sync signals write to HRAM with the address specified in DEFAULT_SYNC_HIGH_ADDRESS in the converter (default 0x80). In deflemask use the EExx command to write the value xx to DEFAULT_SYNC_HIGH_ADDRESS.