Skip to content

Commit 7c298ff

Browse files
committed
Merge branch 'main' of https://github.com/RinLovesYou/Flipnote-Encoder into main
2 parents 8784f61 + a59cf1b commit 7c298ff

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
A Flipnote encoder written in C#
44

5+
built with [PPMLib](https://github.com/miso-xyz/PPMLib)
6+
57
uses binaries from [ffmpeg](https://ffmpeg.org) for video manipulation.
68

79
[![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.
1921
# config.json
2022
Located inside the Root folder is a config.json. Should it not exist, a new one will be created by the program.
2123
Here you can see all the config Items with a description of how to use them:
22-
```Java
23-
{
24-
// One of 14 possible Dithering algorithms. Most of these don't require imagemagick to be installed, except for the last one.
25-
// 0 = None, 1-3 = Bayer8x8/4x4/1x1, 4 = Floyd Steinberg, 5 = Atkinson, 6 = Burkes, 7 = Jarvis, 8 = StevensonArce, 9 = Sierra2, 10 = Sierra3
26-
// 11 = SierraLite, 12 = Stucki, 13 = Ordered3x3, 14 = imagemagick (needs to be installed)
27-
// Different Algorithms will look better on different videos.
28-
"DitheringMode": 1,
29-
// 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.
30-
"Accurate": true,
31-
// Adds the option for contrast bump, helps with visual clarity in some cases
32-
"Contrast": 0,
33-
// Not working, once implemented will split the video into parts that are all playable on a dsi/3ds
34-
"Split": false,
35-
// Self Explanatory
36-
"DeleteOnFinish": true
37-
}
38-
```
24+
25+
* "DitheringMode": 1, - refer to [wiki](https://github.com/RinLovesYou/Flipnote-Encoder/wiki/Dithering-Modes)
26+
* "ColorMode": 1, - refer to [wiki](https://github.com/RinLovesYou/Flipnote-Encoder/wiki/Color-Modes)
27+
* "Accurate": true, - Wether to force 30FPS or not. Fixes audio sync.
28+
* "Contrast": 0, - How much contrast to add
29+
* "InputFolder": "frames",
30+
* "InputFilename": "input.mp4",
31+
* "Split": false, - Wether or not to split the resulting Flipnote.
32+
* "SplitAmount": 2, - Unused at the moment. Encoder automatically tries to pick the best split amount
33+
* "DeleteOnFinish": true - I don't even think i added a case for this. Why wouldn't you want this? Deletes all temp frames.
3934

4035
Expect bugs and report them in the [issues](https://github.com/RinLovesYou/Flipnote-Encoder/issues) section please.
4136

@@ -55,12 +50,19 @@ it won't sign a flipnote if no `fnkey.pem` exists, you can still play it back wi
5550
## Special Thanks
5651
* [khang06](https://github.com/khang06) For his awesome encoder, being the inspiration, and his help in understanding audio.
5752
* [NotImplementedLife](https://github.com/NotImplementedLife) For their FlipnoteDesktop program, which helped a lot in understanding the structure of a Flipnote.
53+
* [JoshuaDoes](https://github.com/joshuaDoes) For being really. really. really patient.
5854
* 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.
5955

56+
## Credits
57+
* [PPMLib](https://github.com/miso-xyz/PPMLib)
58+
* [FFMpegCore](https://github.com/rosenbjerg/FFMpegCore)
59+
* [ImageSharp](https://github.com/SixLabors/ImageSharp)
60+
6061
# Note
6162
Flipnote Studio is a trademark of Nintendo. This project is not linked to them in any way. It is intended for educational purposes only.
6263

63-
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
64+
I am not responsible for how this tool is used. It is against Sudomemo TOS to upload encoded flipnotes there.
65+
Consider [Freenote](https://discord.gg/jHAgKe2uJs) instead :)
6466

6567
[![forthebadge](https://forthebadge.com/images/badges/mom-made-pizza-rolls.svg)](https://forthebadge.com)
6668

0 commit comments

Comments
 (0)