Checkpoint 开源项目使用教程

1. 项目的目录结构及介绍

Checkpoint 项目的目录结构如下：

Checkpoint/
├── 3ds/
│   ├── Checkpoint/
│   │   ├── config.json
│   │   ├── saves/
│   │   └── extdata/
│   └── ...
├── switch/
│   ├── Checkpoint/
│   │   ├── config.json
│   │   └── saves/
│   └── ...
├── common/
│   ├── ...
│   └── ...
├── LICENSE
├── Makefile
├── README.md
└── ...

目录结构介绍

• 3ds/: 包含适用于 3DS 平台的文件和目录。
  • Checkpoint/: 3DS 平台的主要工作目录，包含配置文件和保存数据的目录。
    • config.json: 3DS 平台的配置文件。
    • saves/: 存储 3DS 平台游戏的保存数据。
    • extdata/: 存储 3DS 平台游戏的扩展数据。
• switch/: 包含适用于 Switch 平台的文件和目录。
  • Checkpoint/: Switch 平台的主要工作目录，包含配置文件和保存数据的目录。
    • config.json: Switch 平台的配置文件。
    • saves/: 存储 Switch 平台游戏的保存数据。
• common/: 包含项目中通用的代码和资源。
• LICENSE: 项目的开源许可证文件。
• Makefile: 项目的编译配置文件。
• README.md: 项目的介绍和使用说明文件。

2. 项目的启动文件介绍

Checkpoint 项目的启动文件主要是通过 Makefile 进行编译和启动。Makefile 文件定义了项目的编译规则和依赖关系。

Makefile 文件介绍

Makefile 文件的主要内容包括：

• 编译目标: 定义了项目的编译目标，如 all, clean, install 等。
• 依赖关系: 定义了各个目标之间的依赖关系，确保编译过程的正确性。
• 编译命令: 定义了具体的编译命令，如 gcc, g++ 等。

通过执行 make 命令，可以启动项目的编译过程，生成可执行文件。

3. 项目的配置文件介绍

Checkpoint 项目的主要配置文件是 config.json，分别位于 3DS 和 Switch 平台的 Checkpoint 目录下。

config.json 文件介绍

config.json 文件的主要内容包括：

• filter: 定义了需要过滤的游戏或应用。
• favorites: 定义了用户收藏的游戏或应用。
• additional_save_folders: 定义了额外的保存数据目录。
• additional_extdata_folders: 定义了额外的扩展数据目录。
• nand_saves: 定义是否启用 NAND 保存数据。
• version: 定义配置文件的版本。

示例配置文件内容如下：

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

通过编辑 config.json 文件，用户可以自定义 Checkpoint 的行为和功能。