No description
Find a file
2018-08-08 15:27:31 +02:00
3ds better integrate changes from #113 2018-08-05 17:36:50 +02:00
common completely remove the old StringUtils code 2018-08-08 15:27:31 +02:00
switch Use vasprintf (#113) 2018-08-05 17:26:18 +02:00
.gitignore use citro2d as 2D library 2018-05-14 08:52:41 +02:00
issue_template.md Update issue_template.md 2018-05-13 13:15:26 +02:00
LICENSE Initial commit 2017-09-29 09:45:56 +02:00
Makefile add Makefile to run all the nested ones 2018-05-15 11:53:29 +02:00
README.md update readme 2018-07-23 07:24:13 +02:00

Checkpoint

A fast and simple homebrew save manager for 3DS and Switch written in C++.

Why use Checkpoint?

Checkpoint is created following ideas of simplicity and efficiency. The UI has been designed to condense as many options as possible, while keeping it simple to work with.

Moreover, Checkpoint is extremely lightweight - while being packaged with a nice graphic user interface - and is built using the most recent libraries available.

Checkpoint for 3DS natively supports 3DS and DS cartridges, digital standard titles and demo titles. 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.

Checkpoint for Switch natively supports NAND saves for the titles you have played. Title information are loaded automatically.

Working path

Checkpoint relies on 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).

3DS

  • sdmc:/3ds/Checkpoint: root path
  • sdmc:/3ds/Checkpoint/config.json: custom configuration file
  • 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

Switch

  • sdmc:/switch/Checkpoint: root path
  • sdmc:/switch/Checkpoint/config.json: custom configuration file
  • sdmc:/switch/Checkpoint/saves/<title id> <game title>: root path for all the save backups for a generic game

Usage

You can use Checkpoint for 3DS with both cfw and Rosalina-based Homebrew Launchers. *hax-based Homebrew Launchers are not supported by Checkpoint.

Checkpoint for Switch only runs on homebrew launcher. Make sure you're running up-to-date payloads.

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.

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.

Configuration file

You can add and toggle features to Checkpoint for 3DS by editing the configuration file.

Here's an example:

{
  "filter": [
    "0x000400000011C400",
    "0x000400000014F100"
  ],
  "additional_save_folders": {
    "0x00040000001B5000": {
      "folders": [
        "/3ds/mySaves/1B50",
        "/moreSaves"
      ]
    },
    "0x00040000001B5100": {
      "folders": [
        "/3ds/PKSM/backups"
      ]
    }
  },
  "additional_extdata_folders": {

  },
  "nand_saves": true,
  "version_major": 3,
  "version_minor": 1,
  "version_micro": 1
}

Troubleshooting

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.

Additionally, you can receive real-time support by joining PKSM's discord server.

Discord

Building

Checkpoint for 3DS relies on latest libctru, latest citro3d and latest citro2d.

Checkpoint for Switch relies on latest libnx and switch-freetype, available from dkp-pacman.

License

This project is licensed under the GNU GPLv3. Additional Terms 7.b and 7.c of GPLv3 apply to this. See LICENSE.md for details.

Credits

Even though this is the result of independent research and work, Checkpoint for 3DS couldn't be possible without J-D-K's original JKSM version, which is an incredible piece of software that you should all be using. Best regards JK, hope you're fine.

TuxSH for TWLSaveTool, from which SPI code has been taken.

All the maintainers for nx-hbmenu, for all the Switch rendering functions.

Yellows8 and all the mantainers for switch-examples.

rakujira for the awesome Checkpoint icons he provided!

Hikari-chin and all the other testers for their help with testing.

If you like my work, support me on Patreon!