From 88f7041a98569375950da6abc654f3f48d725db7 Mon Sep 17 00:00:00 2001 From: Glenn Forbes Date: Tue, 17 Mar 2020 20:41:15 +0000 Subject: [PATCH] Create README.md --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a928444 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# popntowav +Tool for rendering pop'n music IFS/chart files to 16-bit PCM wav. + +## Dependencies + +Currently this tool relies on [IFSTools](https://github.com/mon/ifstools), which should be used either from an installed Python package, or through its exe distributions. +Additionally, this tool uses the following node packages: + - wav + - node-libsamplerate (Requires C build tools to install) + +## Usage +```node popntowav [IFS file]``` + +I'll probably add further options for chart/container files not inside an IFS file at some point. Maybe some tweaking for desired sample rate, etc. + +## Acknowledgements + +Thanks to [Emi](https://github.com/EmiMidnight) and though for help with this nonsense. + +## License + +Yar har. Just think of me if you want to use this. Maybe even write my name down on a piece of paper somewhere.