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:25:05 +00:00
parent 5bcdb23f79
commit 3410ee519c
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
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 * Echo Sound Engine (ESF) for Sega Mega Drive
* Version 1.68 ([tree c83e424](https://github.com/sikthehedgehog/Echo/tree/c83e424e7736d07690ace2488bf9195ed27f7af4)) * 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! `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) * `20xx` Noise generator mode (SN4)
* `ECxx` Note cut * `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: 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
* 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. * 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.