From 3410ee519c60f5369c1900714e76496ea09c8581 Mon Sep 17 00:00:00 2001 From: Ashley N Date: Sat, 2 Sep 2023 15:25:05 +0000 Subject: [PATCH] Update Using the Soundtrack Tool --- Using-the-Soundtrack-Tool.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/Using-the-Soundtrack-Tool.md b/Using-the-Soundtrack-Tool.md index fd7786c..321803d 100644 --- a/Using-the-Soundtrack-Tool.md +++ b/Using-the-Soundtrack-Tool.md @@ -11,6 +11,10 @@ This tool converts a tracker squence into a format that can be played on-console * Echo Sound Engine (ESF) for Sega Mega Drive * Version 1.68 ([tree c83e424](https://github.com/sikthehedgehog/Echo/tree/c83e424e7736d07690ace2488bf9195ed27f7af4)) +### Supported Source File Export Formats +* `asmx` assembler + * Users of `asm68k` or `snasm68k` can edit the source file to reduce the size of filenames and symbols. These two targets will be exported soon! + `soundtrack` is currently in **alpha** and such is very likely to fail in common scenarios. You can give it a try for your DMF -> ESF conversion requirements, but as of now it may not work for all tracks. In my experience, 80% of tracks using effects supported will play properly. I will fix these issues as I encounter them while converting compositions for my Sega Mega Drive homebrew game, or as issues are reported in the issue tracker. Thank you for your patience! @@ -25,7 +29,18 @@ This tool converts a tracker squence into a format that can be played on-console * `20xx` Noise generator mode (SN4) * `ECxx` Note cut -## Roadmap +## Quick Start +### Get help and supported options +``` +reskit soundtrack --help +``` + +### Convert a single DMF module to ESF format +``` +reskit -i track.dmf -o track.esf +``` + +## `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: * VGM format conversions * E.g. VGM to ESF, ESF to VGM. Build a sequence from VGM so that developers can make use of features offered by their sound engines, such as FM and PSG sound effects.