Checkpoint/README.md

48 lines
2.9 KiB
Markdown
Raw Normal View History

2017-10-01 10:34:32 +00:00
# Checkpoint
2017-12-31 16:24:55 +00:00
A fast and simple save manager for cfw/rosalina-based Homebrew Launchers written in C++.
2017-10-01 10:34:32 +00:00
2017-10-05 15:47:38 +00:00
![](https://i.imgur.com/Nttk8hX.png)
2017-10-01 10:34:32 +00:00
## Why using Checkpoint?
Checkpoint is created with the ideas of simplicity and efficiency. The UI has been designed to condense as many options as possible, while keeping it simple to work with.
2017-10-01 10:34:32 +00:00
Moreover, Checkpoint is extremely lightweight and is built using very few (and up-to-date) libraries. It contains minimal assets, while being packaged with a nice graphic user interface.
2017-10-01 10:34:32 +00:00
Checkpoint supports DS cartridges, normal titles, and demos. It also automatically checks and filters homebrew titles which may not have a save archive to backup or restore, which is done without an external title list and filters. For this reason, Checkpoint doesn't need constant user maintenance to retain full functionality.
2017-10-01 10:34:32 +00:00
## Working path
Checkpoint uses the following folders to store the files it generates. Note that all the working directories are automatically generated on first launch (or when Checkpoint finds a new title that doesn't have a working directory yet).
* **`sdmc:/3ds/Checkpoint`**: root path
* **`sdmc:/3ds/Checkpoint/saves/<unique id> <game title>`**: root path for all the save backups for a generic game
* **`sdmc:/3ds/Checkpoint/extdata/<unique id> <game title>`**: root path for all the extdata backups for a generic game
2017-10-01 10:34:32 +00:00
## Usage
You can use Checkpoint with both cfw and Rosalina-based Homebrew Launcher. *hax-based Homebrew Launchers are not supported by Checkpoint.
2017-10-01 10:34:32 +00:00
2017-12-31 16:24:55 +00:00
The first launch will take considerably longer than usual (usually 1-2 minutes depending on how many titles you have installed), due to the working directories being created - Checkpoint will be significatively faster upon launch from then on.
2017-10-01 10:34:32 +00:00
You can scroll between the title list with the DPAD/LR and target a title with A when the selector is on it. Now, you can use the DPAD or the touchscreen to select a target backup to restore/overwrite.
## Issues
Checkpoint displays error codes when something weird happens or operations fail. If you have any issues, please ensure they haven't already been addressed, and report the error code and a summary of your operations to reproduce it.
2017-10-01 10:34:32 +00:00
## Building
2017-10-17 20:59:50 +00:00
Checkpoint uses [latest libctru](https://github.com/smealum/ctrulib), [latest citro3d](https://github.com/fincs/citro3d) and [latest pp2d](https://github.com/BernardoGiordano/Checkpoint/tree/master/source/pp2d).
2017-10-01 10:34:32 +00:00
## License
This project is licensed under the GNU GPLv3. See [LICENSE.md](https://github.com/BernardoGiordano/Checkpoint/blob/master/LICENSE) for details.
## Credits
Even though this is the result of independent research and work, this couldn't be possible without J-D-K's [JKSM](https://github.com/J-D-K/JKSM), which is an incredible piece of software that you should all be using. Best regards JK, hope you're fine.
TuxSH for [TWLSaveTool](https://github.com/TuxSH/TWLSaveTool), from which SPI code has been taken.