diff --git a/README.md b/README.md index 41efdfe..2617847 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,27 @@ -# Preface +# bm2dnix Helper Scripts This repo may seem erratic with no documentation whatsoever. This is because resources listed here are part of a bigger private repository. +## s3p_to_2dx + +*This script is currently in its proof of concept stage. Please examine it before trying to run it, I reccommend copying your sound data elsewhere and running the script in there.* + +Helper script to convert .s3p .wma containers to .2dx .wav containers. Needed for songs in 25+ to play properly without *disable-fx* patches applied. + +Dependencies (must to be registered to /usr/bin): +- bash +- ffmpeg +- [ifstools](https://github.com/mon/ifstools) +- [2dxTools](https://github.com/mon/2dxTools) +- [s3p_extract](https://github.com/mon/s3p_extract) (Thank you mon/xyen!) + +Usage: +- Define your sound directory in `SOUND_DIR` +`./s3p_to_2dx` + +## etc + You don't have to use anything from this repo to get games running as these are just there to make process feel more seamless. That being said part of a guide listed at pages may be harder to follow without any system integration whatsoever, therefore this repository exists, providing the minimal wrappers setup that should work with guide provided.