Skip to content

Commit 12529d3

Browse files
authored
Update README.md
1 parent 1a13239 commit 12529d3

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,31 @@ Custom Deflemask .vgm based playback engine for the Nintendo Game Boy.
33

44
**this engine only works Deflemask generated .vgms and is not intended for other .vgms**
55

6-
# Register Dump command format
6+
7+
## Usage
8+
`DeflemaskGBVGMConverter <.vgm file> [arguements...]`
9+
**REQUIRES patchROM.gb**
10+
#### simple usage
11+
### arguments
12+
* `-r <engine rate>` set the engine rate in Hz (Clock value in Deflemask). Required if you use a engine tick speed other than NTSC.
13+
* `-o <output path>` set the output filename (defaults to "out")
14+
* `-asm` export song data as .bin to include in a GB rom.
15+
16+
#### .bin export
17+
include all exported .bin files in your asm ROM. Each .bin takes up an entire ROM bank.\
18+
19+
example:
20+
```
21+
SECTION "SoundData0",ROMX,BANK[1]
22+
incbin "ExampleData/ahoy/ahoy0.bin
23+
....
24+
....
25+
SECTION "SoundData9",ROMX,BANK[10]
26+
incbin "ExampleData/ahoy/ahoy9.bin"
27+
```
28+
29+
30+
## Register Dump command format
731
Commands are formatted so that each bit is a flag that represents a command.
832
### Format Description
933

@@ -17,3 +41,4 @@ Commands are formatted so that each bit is a flag that represents a command.
1741

1842
#### Sync command
1943
Sync signals use the 0x80 (write high) command to write their values to the address specified in `DEFAULT_SYNC_HIGH_ADDRESS`in the converter (default `0xFA`). In deflemask use the `EExx` command to write the value xx to `DEFAULT_SYNC_HIGH_ADDRESS`.
44+

0 commit comments

Comments
 (0)