Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
meladroit committed Sep 6, 2015
1 parent 2eae964 commit 5755542
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -12,17 +12,17 @@ For games that don't handle gfxInitDefault() well for some reason (Animal Crossi
These functions are available for all games, not just misbehaving ones.

When svdt starts up, it checks for whether the target game is on a gamecard or the SD card.
* If the target is a gamecard, svdt automatically fetches the game title (the short English title in exeFS:/icon)
* If the target is a gamecard, svdt automatically fetches the game title (the short English title in exeFS:/icon).
* If the target is a digital game, svdt asks you to pick the game title from a list of all titles on the device. This is because at present, svdt does not have an automatic way to fetch the title ID. Use left/right buttons on the D-pad to browse through the title list, and press A to select a title. (You can also press B to skip this step.)

While the game title is unnecessary for actually accessing data, svdt uses it for naming backups of all save data. Emergency backups go to sd:/svdt/[title]/[timestamp], while interactive ones go to sd:/[current working directory]/[title]_[timestamp]).

### Brief UI guide
* There are two panes in view. The left pane lists files and directories in the target app's save data. The right pane does the same for the SD card. Both listings start at root.
* A cursor to the left of the active listing indicates the current selected entry. Use up/down on the D-pad to move the cursor up and down the listing. Use L/R D-pad or shoulder buttons to switch which listing is selected (SD versus save data).
* The top listing of each pane is the current working directory, either in full or truncated.
* Selecting this with the cursor and pressing A refreshes the listing.
* Selecting this with the cursor and pressing Y dumps the contents of the working directory onto a subdirectory in the other working directory (save to SD, or vice versa). If / is dumped, the subdirectory is named with a timestamp. If a non-root directory is dumped, the subdirectory just takes on the name of the directory. *This does not check for overwrites. Proceed with caution.*
* The top listing of each pane is the current working directory path, either in full or truncated. (The full path is always shown in the debug output when the directory is first selected.)
* Selecting this line with the cursor and pressing A refreshes the whole listing.
* Selecting this line with the cursor and pressing Y dumps the contents of the working directory onto a subdirectory in the other working directory (save to SD, or vice versa). If / is dumped, the subdirectory is named with a timestamp. If a non-root directory is dumped, the subdirectory just takes on the name of the directory. *This does not check for overwrites. Proceed with caution.*
* The second listing of each pane is a dummy entry for the parent directory. Selecting this with A or pressing B at any time navigates to the parent directory.
* All further listings are files and directories in the working directory.
* Press A to navigate inside a subdirectory.
Expand All @@ -37,4 +37,4 @@ While the game title is unnecessary for actually accessing data, svdt uses it fo
* The homebrew launcher may hang while trying to start svdt, on a blue or white or otherwise abstract screen. I swear it's not my fault.
* The homebrew launcher doesn't always show the target app selection screen. svdt has no mechanism in place at the moment to check whether there is a target app, but this should be fairly straightforward to implement (check for target app name?). If svdt starts without a target, then the output is garbled slightly at first, but it functions for the most part as a SD data browser. There are better SD card browsers, so using svdt in this way is not recommended.
* svdt does not handle running out of space gracefully. *This is because if the save data does run out of space, then trying to continue writing to save data (even after reinitialising FS handles and archives) may corrupt it.* For now, if svdt detects any problem at all with manipulating files, it just throws a fatal error and asks you to quit out. There may not really be a better option.
* The code is a mess.
* The code is a mess. There will eventually be more helpful comments.

0 comments on commit 5755542

Please sign in to comment.