Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…into main
  • Loading branch information
RinLovesYou committed Mar 1, 2021
2 parents 8c27e88 + 6a3c795 commit 295f1c1
Showing 1 changed file with 29 additions and 14 deletions.
43 changes: 29 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,37 @@

A Flipnote encoder written in C#

uses binaries from [ffmpeg](https://ffmpeg.org) and [imagemagick](https://imagemagick.org/index.php) video/image manipulation
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)

# How to use
### DELETE OLD `frames` CONTENT BEFORE DOING A NEW ONE
[![Support Server](https://img.shields.io/discord/815244291366453259.svg?label=Support_Server&logo=Discord&colorB=7289da&style=for-the-badge)](https://discord.gg/MBM9ZeAjna)

# Quickstart
* download and unzip the latest [release](https://github.com/RinLovesYou/Flipnote-Encoder/releases)
* place the video called `input.mp4` in the `frames` folder)
* (Optional) Replace the flipnote in DummyFlipnote with one of your own! It'll embed your user information in the encoded Flipnote
* place the video called `input.mp4` in the `frames` folder, make sure no other files exist there
* Replace the Dummy Flipnote with one of your own. This will embed your User Information
* (Optional) place the Flipnote Studio Private Key (good luck getting that one) called `fnkey.pem` in the same folder as the exe

As long as you have your `input.mp4` located in `frames` you can just double click `EncodeAndSign.exe` it should work (Playback on a real dsi with 1mb+ flipnotes is not guaranteed)

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

it won't sign a flipnote if no `fnkey.pem` exists, you can still play it back with most online players like [rakujira](https://flipnote.rakujira.jp)
# 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 7 possible Dithering algorithms. Most of these don't require imagemagick to be installed, except for the last one.
// 0 = None, 1 = Floyd Steinberg, 2 = Atkinson, 3 = Burkes, 4 = Jarvis, 5 = Sierra, 6 = Imagemagick Mogrify Bilevel (This one requires Imagemagick)
// 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. Saves a bit on filesize if turned to false
"Accurate": true,
// Not working, once implemented will split the video into parts that are all playable on a dsi/3ds
"Split": false
}
```

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

it won't sign a flipnote if no `fnkey.pem` exists, you can still play it back with most online players like [rakujira](https://flipnote.rakujira.jp) though.

![screenshot](https://media.discordapp.net/attachments/738116823035150356/812439551930007582/unknown.png)

Expand All @@ -26,13 +41,13 @@ it won't sign a flipnote if no `fnkey.pem` exists, you can still play it back wi
* Q: Can you give it to me? A: no good luck googling for it
* Q: Can you add x? A: Yes! Maybe! suggest in [issues](https://github.com/RinLovesYou/Flipnote-Signer/issues)

discord: `Rin#6969`
[discord:](https://discord.gg/MBM9ZeAjna) `Rin#6969`

twitter: `@does_rin`
[twitter:](https://twitter.com/does_rin) `@does_rin`

## Special Thanks
* [khang06](https://github.com/khang06) For his awesome encoder, being the inspiration, and his help in understanding audio
* [miso-xyz](https://github.com/miso-xyz) For his FlipnoteDesktop program, which helped a lot in understanding the structure of a Flipnote
* [khang06](https://github.com/khang06) For his awesome encoder, being the inspiration, and his help in understanding audio.
* [miso-xyz](https://github.com/miso-xyz) For his FlipnoteDesktop program, which helped a lot in understanding the structure of a Flipnote.
* 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.

# Note
Expand Down

0 comments on commit 295f1c1

Please sign in to comment.