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-09-02 15:53:39 +00:00
parent 787ee81533
commit a721cf479e
1 changed files with 8 additions and 2 deletions

10
Using-the-Soundtrack-Tool.md

@ -1,6 +1,6 @@
# Soundtrack Tool # Soundtrack Tool
This tool converts a tracker squence into a format that can be played on-console, usually with a sound driver. If you are familiar with [`dmf2esf`](https://github.com/BigEvilCorporation/dmf2esf), this utility serves as a successor and a rewrite which supports the newer version(s) of Deflemask DMF format. This tool converts a tracker sequence into a format that can be played on-console, usually with a sound driver. If you are familiar with [`dmf2esf`](https://github.com/BigEvilCorporation/dmf2esf), this utility serves as a successor and a rewrite which supports the newer version(s) of Deflemask DMF format. `soundtrack` can convert a single sequence and export its instruments (also known as "artifacts"), or it can convert multiple sequences and generate a combined instrument list for all of them.
Impatient? [Jump to Quick Start](https://git.ne0ndrag0n.com/ashley/reskit/wiki/Using-the-Soundtrack-Tool#user-content-quick-start) Impatient? [Jump to Quick Start](https://git.ne0ndrag0n.com/ashley/reskit/wiki/Using-the-Soundtrack-Tool#user-content-quick-start)
@ -38,11 +38,17 @@ Impatient? [Jump to Quick Start](https://git.ne0ndrag0n.com/ashley/reskit/wiki/U
reskit soundtrack --help reskit soundtrack --help
``` ```
### Convert a single DMF module to ESF format ### Convert a single DMF module to ESF format, export instruments, and source file
``` ```
reskit -i track.dmf -o track.esf reskit -i track.dmf -o track.esf
``` ```
### Convert multiple DMF modules to ESF format, generate a combined set of instruments, and source file
```
reskit -i track1.dmf -i track2.dmf -o output/path/
```
Note that when converting multiple files, the `-o` option is instead a pathname to export multiple sequences.
## `soundtrack` Roadmap ## `soundtrack` Roadmap
The eventual vision of `reskit` is to serve as an ffmpeg-like tool for converting assets to and from 8-bit and 16-bit console media formats. `soundtrack` aims to eventually support the following: The eventual vision of `reskit` is to serve as an ffmpeg-like tool for converting assets to and from 8-bit and 16-bit console media formats. `soundtrack` aims to eventually support the following:
* VGM format conversions * VGM format conversions