diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..085b761 --- /dev/null +++ b/README.md @@ -0,0 +1,98 @@ +# 🗃 `para` + + + +## What? + +A decoder and utility for the Flipnote Studios `.ppm` animation format. + +## Why this implementation over [the original](https://github.com/Flipnote-Collective/ppm-parser)? + +This implementation is + +- [SIGNIFICANTLY faster](#speed), +- implemented in safe Rust (a language with strict type-checking!), +- and being actively updated. + +### Speed + +In a two-hundred-forty-four frame `.ppm` benchmark running the command +`$ para ./benchmark.ppm gif benchmark.gif` on a twelve-core, +twenty-four-thread Ryzen 9 processor, para took an average of 566.9893 milliseconds, +while ppm-parser took an average of 50.4171397 seconds. + +Running the command `$ para ./benchmark.ppm 0 benchmark.png` on a twelve-core, +twenty-four-thread Ryzen 9 processor, para took an average of 8.6251 milliseconds, +while ppm-parser took an average of 358.2232 milliseconds. + +Rust versus Python isn't very fair, however, this benchmark shows the speed improvements +that para brings to the table. + +## Things To Come + +- Support for other formats (namely `.kwz`) +- Optimizations here and there +- Friendlier CLI +- Possible GUI + +## Getting up and Running + +### Installation + +Prebuilt binaries for x86_64-based Linux systems and Windows are available in the +[releases](https://github.com/Usugata/para/releases/latest). If you are using +a different operating system or architecture such as macOS, you'll have to build +and install the tool yourself! + +```shell +$ cargo install --git https://github.com/Usugata/para --branch main +``` + +If you are building and installing yourself, you must have +[Rust](https://www.rust-lang.org/) installed! + +### Usage + +```shell +usage: para <in> <index option> <out> +index options: + gif + thumb + dump + integer(u16) +``` + +### Examples + +- `$ para ./example.ppm 23 example.png` will output the twenty-fourth frame + of `example.ppm` to `example.png` +- `$ para ./example.ppm thumb example.png` will output the thumbnail of + `example.ppm` to `example.png` +- `$ para ./example.ppm dump example.json` will output the metadata of + `example.ppm` to `example.json` +- `$ para ./example.ppm gif example.gif` will output `example.ppm` + to `example.gif` + +### Prebuilt Binaries + +Prebuilt binaries for the latest release may or may not be found +[here](https://github.com/Usugata/para/releases/latest). + +## Credits + +- [jaames](https://github.com/jaames) for completing PPM reverse-engineering and + writing the [original](https://github.com/Flipnote-Collective/ppm-parser) implementation. +- [bricklife](http://ugomemo.g.hatena.ne.jp/bricklife/20090307/1236391313), + [mirai-iro](http://mirai-iro.hatenablog.jp/entry/20090116/ugomemo_ppm), + [harimau_tigris](http://ugomemo.g.hatena.ne.jp/harimau_tigris), and other members + of the Japanese Flipnote community who started reverse-engineering the PPM format + almost as soon as the app was released. +- Midmad and WDLMaster for identifying the adpcm sound codec used. +- [steven](http://www.dsibrew.org/wiki/User:Steven) and + [yellows8](http://www.dsibrew.org/wiki/User:Yellows8) for the PPM documentation on DSiBrew. +- [PBSDS](https://github.com/pbsds) for more PPM reverse-engineering, as well as + writing [hatenatools](https://github.com/pbsds/Hatenatools) + +## License + +[MIT License](./LICENSE) |