Skip to content

Commit d5c4bf2

Browse files
updated README
1 parent 9c5181e commit d5c4bf2

1 file changed

Lines changed: 21 additions & 3 deletions

File tree

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This simple ROM allows you to play flipnotes on Nintendo DS (Lite) using your fl
1313

1414
## How to use
1515

16+
1617
1. Create a new folder named ```/flipnotes``` at the root of your SD card
1718
1. Copy your favorite flipnotes to ```/flipnotes``` directory
1819
1. Copy ```FSPDS.nds``` anywhere to your SD card
@@ -22,6 +23,15 @@ This simple ROM allows you to play flipnotes on Nintendo DS (Lite) using your fl
2223
1. Press ```A``` to play it
2324
1. Use ```L```/```R``` buttons to navigate through bottom-screen tabs
2425

26+
## Features
27+
28+
- Supposing you are a TwilightMenu++ user (or any other DSi CFW), or you use the same SD card for both the DSi and a DS flashcard,
29+
FSPDS automatically detects default flipnote export paths for you so that you are not required to copy those files to a `/flipnotes` directory.
30+
- A screen saver turns off the bottom screen on 5 seconds of inactivity during flipnote playback. Also, this option can be manually
31+
triggered by pressing the screen saver icon on the Player Tab. *
32+
33+
\* Check the [Hardware vs Emulator compatibility](#hardware-vs-emulator-compatibility) section below.
34+
2535
## Screenshots
2636
<p align="center">
2737
<img width="600" src="README_Resources/ss01.png" alt="ROM in action: show thumbnail"></img>
@@ -39,10 +49,16 @@ This simple ROM allows you to play flipnotes on Nintendo DS (Lite) using your fl
3949
## Bugs/Limitations
4050

4151
- FSPDS doesn't detect/play flipnotes larger than 1MB (this is intentional behavior)
42-
- Don't place more than 1024 files in the `/flipnotes` directory, otherwise FSPDS won't be capable to see them all (also intentional behavior, probably will be changed in the future)
43-
- The flipnote's BGM track should be smaller than 512KB in order to be played correctly.
52+
- The flipnote's BGM track should be smaller than 512KB in order to be played correctly. However, the DSi Flipnote Studio only allows
53+
for 1 minute of raw audio (8192Hz) to be encoded into a flipnote, which means at most 240KB of sound data. Therefore, FSPDS should not have
54+
problems playing original flipnotes. Spin-off flipnotes which contain huge audio data may not play correctly with this application.
55+
56+
<b>Tested on DeSmuMe emulator and R4(i) flashcards </b>
57+
58+
### Hardware vs emulator compatibility
4459

45-
### Tested on DeSmuMe emulator and R4(i) flashcards
60+
- On the hardware, loading files from FAT system is substantialy faster.
61+
- For some reason, the screen saver does not work on DeSmuME emulating in R4 mode. This doesn't affect the actual user experience.
4662

4763
## Credits
4864

@@ -51,3 +67,5 @@ This simple ROM allows you to play flipnotes on Nintendo DS (Lite) using your fl
5167
- The authors behind [GodMode9i](https://github.com/DS-Homebrew/GodMode9i "GodMode9i") for the idea of overwriting character fonts
5268
- [Drenn1/GameYob](https://github.com/Drenn1/GameYob "Drenn1/GameYob") repo for helping me figure out how to work with makefiles.
5369
- [RinLovesYou](https://github.com/miso-xyz/PPMLib/commits?author=RinLovesYou) for her [ADPCM to PCM Decode() method from PPMLib](https://github.com/miso-xyz/PPMLib/blob/c7548bf4cdb0e368af552c71a45eb9f96f2e3385/PPMLib/Extensions/AdpcmDecoder.cs#L46-L119)
70+
- [tomrow](https://github.com/tomrow) for their suggestion on [Alternate flipnote browse locations](https://github.com/NotImplementedLife/FSPDS/issues/2)
71+
- Moonshell2 source code for hints on making the screen saver during playback

0 commit comments

Comments
 (0)