3dsconv 技术文档

3dsconv 技术文档

3dsconv Python script to convert Nintendo 3DS CCI (".cci", ".3ds") files to the CIA format 项目地址: https://gitcode.com/gh_mirrors/3d/3dsconv

3dsconv 是一个专为 Nintendo 3DS 用户设计的开源工具，由 Python 3 编写。它能够将 CTR Cart Image 文件（CCI，通常带有 .cci 或 .3ds 扩展名）转换为 CTR 导入归档格式（CIA）。这款工具适用于游戏备份管理和转换，尤其是对于那些想要在自制系统环境下管理他们的游戏库的用户。

安装指南

基础安装

首先确保你的计算机上已安装了 Python 3 环境。推荐使用最新稳定版本的 Python 3.x，但请注意，若要打包成Windows可执行文件，需要使用 Python 3.4 版本。

通过 pip 安装依赖

1. 安装 pyaes 加密库，它是处理加密文件所必需的。

   pip install pyaes
   

高级安装

对于开发者或者希望从源代码构建的用户：

1. 克隆 3dsconv 的 GitHub 仓库到本地。
2. 在命令行中，导航到克隆后的目录并执行以下命令来安装所有必要的依赖（如果你打算打包为可执行文件，这一步不是必需的）：

   python3 setup.py install
   

项目的使用说明

基本使用

• 对于 Windows 用户，可以直接拖拽 .3ds 文件到 3dsconv.exe 上进行转换。
• 在非 Windows 平台上，打开终端，并运行如下命令：

  python3 3dsconv.py game.3ds
  

高级选项

你可以通过加入特定参数来调整行为：

• 使用 --output=<dir> 指定转换文件保存的目录。
• 加上 --boot9=<file> 提供 ARM9 启动ROM的路径，以支持原生NCCH加密的解密。
• 使用 --overwrite 以覆盖已存在的转换文件。
• 添加 --ignore-bad-hashes 忽略无效哈希值并继续转换。
• 使用 --verbose 获取更详细的日志信息。
• 若要用于开发者单元，添加 --dev-keys。

项目API使用文档

虽然此工具主要作为命令行脚本使用，但在自定义集成时，可以视作API调用。核心功能在于 3dsconv.py 中的主函数，可以通过导入该脚本并在其他Python程序中调用其转换逻辑，比如：

from 3dsconv import convert_to_cia

# 假设你有游戏文件路径和指定输出路径
game_path = 'path/to/game.3ds'
output_dir = 'path/to/output'
convert_to_cia(game_path, output_dir)

注意：上述示例中的 convert_to_cia 函数是假设性的，实际使用前需要查看项目源码确认具体接口。

项目编译与分发

为了便于没有 Python 环境的用户使用，你可以将 3dsconv 脚本打包成Windows独立执行文件：

1. 确保拥有 Python 3.4（由于 py2exe 的限制）。
2. 使用 py2exe 将脚本打包：

   py -3.4 -m py2exe.build_exe 3dsconv.py -b 0
   

3. 完成后，dist 目录下会生成 3dsconv.exe。

注意事项

• 加密问题：正确处理加密文件需要对应的 ARM9 启动ROM，以及了解可能涉及的不同加密类型。
• 开发者单位支持：使用 --dev-keys 选项时，还需考虑证书链的正确配置。
• 兼容性提示：随着 3DS 在线服务的关闭，一些功能可能会受到影响，但这不影响 3dsconv 工具的本地操作。

通过遵循以上步骤，用户和开发者可以有效利用 3dsconv 来满足他们在 Nintendo 3DS 游戏管理上的需求。

3dsconv Python script to convert Nintendo 3DS CCI (".cci", ".3ds") files to the CIA format 项目地址: https://gitcode.com/gh_mirrors/3d/3dsconv