diff --git a/Soundtrack-tool.md b/Soundtrack-tool.md new file mode 100644 index 0000000..ec6fa00 --- /dev/null +++ b/Soundtrack-tool.md @@ -0,0 +1,16 @@ +# Soundtrack Tool + +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 +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. + +## Supported Tracker Formats (0.0.x) +* Deflemask (DMF) + +## Supported Consoles/Drivers (0.0.x) +* Echo Sound Engine (ESF) for Sega Megadrive \ No newline at end of file