skylyrac/blocksds

BlocksDS SDK Docker镜像文档

镜像概述

BlocksDS SDK Docker镜像是基于BlocksDS SDK（https://github.com/blocksds/sdk%EF%BC%89%E6%9E%84%E5%BB%BA%E7%9A%84%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83%E9%95%9C%E5%83%8F%EF%BC%8C%E6%97%A8%E5%9C%A8%E4%B8%BANintendo DS自制软件（homebrew）开发提供预配置的、开箱即用的开发环境。通过该镜像，开发者可避免手动安装和配置编译工具链、依赖库等繁琐步骤，快速投入Nintendo DS自制软件的开发工作。

核心功能与特性

1. 预配置开发环境

• 集成BlocksDS SDK完整工具链，包括编译器（arm-none-eabi-gcc等）、链接器、汇编器及相关工具
• 预装开发所需依赖库和配置文件，无需手动安装
• 与官方BlocksDS SDK功能保持一致，确保开发兼容性

2. 简化开发流程

• 无需手动配置系统环境变量、路径等，容器启动即可使用开发工具
• 支持直接在容器内编译、链接Nintendo DS项目，输出可运行的NDS文件

3. 跨平台兼容性

• 基于Docker容器化技术，可在任何支持Docker的操作系统（Linux、macOS、Windows）上运行，解决不同系统环境差异问题

使用场景

• Nintendo DS自制软件开发者：快速搭建开发环境，专注于代码编写而非环境配置
• 学习Nintendo DS开发的新手：降低入门门槛，避免因环境配置错误导致的开发障碍
• 项目协作与CI/CD：作为统一的开发环境用于团队协作，或集成到CI/CD流程中实现自动化构建

使用方法

前提条件

• 已安装Docker Engine（参考https://docs.docker.com/engine/install/%EF%BC%89
• 熟悉Docker基本操作（如docker pull、docker run等）

1. 获取镜像

从Docker Hub或其他镜像仓库拉取BlocksDS SDK镜像（具体镜像名称请参考https://blocksds.github.io/docs/setup/options/docker/%EF%BC%89%EF%BC%9A

bash
docker pull docker.xuanyuan.run/blocksds/sdk:latest

2. 运行容器

启动容器并挂载本地项目目录，以便在容器内访问和编译项目文件：

bash
docker run -it --rm -v /path/to/your/project:/project docker.xuanyuan.run/blocksds/sdk:latest

• -it：以交互模式运行容器并分配终端
• --rm：容器退出后自动删除
• -v /path/to/your/project:/project：将本地项目目录挂载到容器内的/project目录

3. 编译项目

进入容器后，导航至挂载的项目目录，使用BlocksDS SDK工具编译项目（具体命令需根据项目Makefile或构建脚本执行）：

bash
cd /project
make  # 假设项目使用Makefile构建

配置参数说明

常用挂载目录

• /project：推荐挂载项目目录，用于访问源代码和输出编译结果
• /blocksds：可选，挂载BlocksDS SDK配置文件目录（如需自定义SDK配置）

环境变量

• BLOCKSDS：SDK安装路径（容器内默认已配置，通常无需修改）
• PATH：工具链路径（容器内已包含SDK工具路径，无需额外配置）

注意事项

• 镜像版本更新：建议定期拉取最新镜像以获取功能更新和bug修复
• 项目兼容性：确保项目Makefile或构建脚本兼容BlocksDS SDK语法和工具链
• 详细配置与高级用法：完整的使用说明（如自定义编译选项、多阶段构建等）请参考https://blocksds.github.io/docs/setup/options/docker/

参考链接

• https://github.com/blocksds/sdk
• https://blocksds.github.io/docs/setup/options/docker/
• Nintendo DS Homebrew开发社区