Skip to content

Commit de9da62

Browse files
authored
Update README.md
1 parent a059656 commit de9da62

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

README.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,41 @@
22
(Revived) .NET Library to edit Flipnotes
33

44
**_Important_:** *Please check the notes below before using this software.*
5+
(if you want a VB.NET version of the library, please go on the `VB-Latest` branch)
56

6-
PS: This project uses a lot of code from FlipnoteDesktop, it has been optimised and turned into this Library. Thanks to [NotImplementedLife](https://github.com/NotImplementedLife) for his help with this project aswell as making FlipnoteDesktop.
7+
This library can be used to read & write flipnotes, application such as players or exporters can be made with this library
78

8-
No releases will be made until a stable version of PPMLib is published.
9+
We will not provide the private key required to sign flipnotes, you will have to find it online or get the key yourself.
10+
11+
# Latest Changelog
12+
(No releases will be made until a stable version of PPMLib is published)
913

10-
# Changelog
1114
v0.3a:
1215
<pre>
1316
- Restructured Library
1417
- Added Audio Decoding (working!)
1518
- Author's names are Unicode-compatible thanks to the explanation provided by <a href="https://github.com/Sudomemo/Sudofont">Sudofont</a> [may be buggy]
1619
</pre>
1720

18-
# Currently Able
19-
- Metadata
20-
- Get Current Author
21-
- Get Audio as .wav (now including SFX)
22-
- Get Current Author ID
23-
- Get Current Filename
24-
- Get "Locked?"
25-
- Get Last-Edited Frame Index
26-
- Get "Loop Flipnote?"
27-
- Get OffsetTableSize
28-
- Get Parent Author
29-
- Get Parent Author ID
30-
- Get Parent Filename
31-
- Get Playback Speed
32-
- Get Root Author
33-
- Get Root Filename Fragments
34-
- Get Thumbnail Frame Index
35-
- Get Timestamp
36-
- Get Total Frames
37-
38-
# Problems
21+
# Working On
22+
- Frame Rendering
23+
- Audio Replay
24+
- Ease-of-use
3925

26+
# Problems
4027
- Emojis are currently not working in author names
4128

4229
# Notes
43-
- This is a library, not responsible for any tools using PPMLib that does not follow Sudomemo's TOS or sum idk, I'm just not responsible for what you do with PPMLib. We remind Section 4.1.5 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
30+
- This is a library, we are not responsible for any tools using PPMLib that does not follow Sudomemo's TOS or sum idk, I'm just not responsible for what you do with PPMLib. We remind Section 4.1.5 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 :). We will try our best to prevent any third-party edits to appear which breaks Sudomemo's TOS.
31+
32+
# Credits
33+
This project would not have seen the light of day without the help of the following people, please support them!
34+
<pre>
35+
- <a href="https://github.com/NotImplementedLife">NotImplementedLife - Nil</a> | Author of FlipnoteDesktop, Helped a bunch with frame rendering & metadata reading
36+
- <a href="https://github.com/RinLovesYou">RinLovesYou - Rin</a> | Author of FlipnoteEncoder, Helped a bunch with frame rendering & sound reading
37+
- <a href="https://github.com/miso-xyz">Misonothx - Miso</a> | Mainly worked on metadata reading & minimal stuff such as descriptions
38+
39+
Special Thanks
40+
- Triangle (MKDS Hacking Server) - Came up with the idea
41+
- XGone (MKDS Hacking Server)
42+
</pre>

0 commit comments

Comments
 (0)