ashley
/
reskit
1
0
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases Wiki Activity

Update Using the Soundtrack Tool

master
Ashley N. 2023-08-26 23:10:32 +00:00
parent ed917fee3c
commit 40741cddbe
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Using-the-Soundtrack-Tool.md

@ -3,12 +3,36 @@
This tool converts a tracker module (e.g. Deflemask) into a format that can be played on-console, usually with a sound driver (e.g. Echo Sound Engine).
## Quick Start
### Basic
This example converts a Deflemask DMF module to an Echo Sound Engine ESF stream, additionally exporting instruments and an asm file (for the `asmx` assembler) which makes it easy to integrate into your project.
```
reskit soundtrack -i module.dmf -o module.esf
```
Use `reskit soundtrack --help` to view more options.
### Change the Instrument Export Location
This example does the same as above but allows you to control where instruments (or "artifacts", secondary files required by the main track) are exported.
```
reskit soundtrack -i module.dmf -o module.esf --artifact-output-directory instruments/
```
### Change the Label Used for the Main Track
This example allows you to change the label/identifier for the generated code export. This is the label you use in your homebrew game to point to the main track.
```
reskit soundtrack -i module.dmf -o module.esf --soundtrack-label MuzHeyYa
```
The generated asm file you can include in your project then looks similar to this:
```
; Echo instrument definitions file
; Generated by reskit v0.0.2
MuzHeyYa:
incbin 'resources/music/heyya.esf'
...
```
## Supported Tracker Formats (0.0.x)
* Deflemask (DMF)