From 6e68991949bf2a83fc61bad36ee827fd713cd01c Mon Sep 17 00:00:00 2001 From: RinlovesYou Date: Wed, 17 Mar 2021 21:21:20 +0100 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 87f410a..19684ac 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ A Flipnote encoder written in C# +built with [PPMLib](https://github.com/miso-xyz/PPMLib) + uses binaries from [ffmpeg](https://ffmpeg.org) for video manipulation. [![ForTheBadge built-with-swag](http://ForTheBadge.com/images/badges/built-with-swag.svg)](https://github.com/RinLovesYou) @@ -19,23 +21,16 @@ uses binaries from [ffmpeg](https://ffmpeg.org) for video manipulation. # config.json Located inside the Root folder is a config.json. Should it not exist, a new one will be created by the program. Here you can see all the config Items with a description of how to use them: -```Java -{ - // One of 14 possible Dithering algorithms. Most of these don't require imagemagick to be installed, except for the last one. - // 0 = None, 1-3 = Bayer8x8/4x4/1x1, 4 = Floyd Steinberg, 5 = Atkinson, 6 = Burkes, 7 = Jarvis, 8 = StevensonArce, 9 = Sierra2, 10 = Sierra3 - // 11 = SierraLite, 12 = Stucki, 13 = Ordered3x3, 14 = imagemagick (needs to be installed) - // Different Algorithms will look better on different videos. - "DitheringMode": 1, - // Wether or not to turn the Video into 30FPS to fix sound sync issues. Is on by default to avoid these issues. Can save a bit on filesize for <30FPS videos. - "Accurate": true, - // Adds the option for contrast bump, helps with visual clarity in some cases - "Contrast": 0, - // Not working, once implemented will split the video into parts that are all playable on a dsi/3ds - "Split": false, - // Self Explanatory - "DeleteOnFinish": true -} -``` + + * "DitheringMode": 1, - refer to (wiki)[https://github.com/RinLovesYou/Flipnote-Encoder/wiki/Dithering-Modes] + * "ColorMode": 1, - refer to (wiki)[https://github.com/RinLovesYou/Flipnote-Encoder/wiki/Color-Modes] + * "Accurate": true, - Wether to force 30FPS or not. Fixes audio sync. + * "Contrast": 0, - How much contrast to add + * "InputFolder": "frames", + * "InputFilename": "input.mp4", + * "Split": false, - Wether or not to split the resulting Flipnote. + * "SplitAmount": 2, - Unused at the moment. Encoder automatically tries to pick the best split amount + * "DeleteOnFinish": true - I don't even think i added a case for this. Why wouldn't you want this? Deletes all temp frames. Expect bugs and report them in the [issues](https://github.com/RinLovesYou/Flipnote-Encoder/issues) section please. @@ -55,12 +50,19 @@ it won't sign a flipnote if no `fnkey.pem` exists, you can still play it back wi ## Special Thanks * [khang06](https://github.com/khang06) For his awesome encoder, being the inspiration, and his help in understanding audio. * [NotImplementedLife](https://github.com/NotImplementedLife) For their FlipnoteDesktop program, which helped a lot in understanding the structure of a Flipnote. +* [JoshuaDoes](https://github.com/joshuaDoes) For being really. really. really patient. * guys from [DSiBrew](https://dsibrew.org/wiki/Main_Page) and [Flipnote Collective](https://github.com/Flipnote-Collective) for their awesome documentation on .PPM file format. +## Credits +* [PPMLib](https://github.com/miso-xyz/PPMLib) +* [FFMpegCore](https://github.com/rosenbjerg/FFMpegCore) +* [ImageSharp](https://github.com/SixLabors/ImageSharp) + # Note Flipnote Studio is a trademark of Nintendo. This project is not linked to them in any way. It is intended for educational purposes only. -This is a program, not responsible for any use that does not follow Sudomemo's TOS, I do not take responsibility for misuse of the tool. Reminder of Section 4.1.1 from Sudomemo Terms of Use: The following activities are prohibited when using Sudomemo: Exploits or content that wasn’t created in the original Flipnote Studio software on a Nintendo DSi or Nintendo 3DS. Plus, animating on a DS is much more fun :) . That's all +I am not responsible for how this tool is used. It is against Sudomemo TOS to upload encoded flipnotes there. +Consider [Freenote](https://discord.gg/jHAgKe2uJs) instead :) [![forthebadge](https://forthebadge.com/images/badges/mom-made-pizza-rolls.svg)](https://forthebadge.com)