AGB

为Game Boy Advance的Rust

这是一个使用Rust编程语言在Game Boy Advance上制作游戏的库。库的主要重点是提供一个抽象层，允许你开发可以利用GBA功能的游戏，而不需要深入了解其底层实现。

agb提供以下功能

• 简单的构建过程，依赖项最少
• 内置导入精灵、背景、音乐和音效
• 高性能音频混音器和可选的跟踪器，可以播放.xm文件
• 易于使用精灵和瓦片背景
• 全局分配器，允许使用core和alloc

最新版本的文档可以在docs.rs上找到。

入门

使用模板是开始使用agb的最佳方式，您可以在本存储库中的template目录中找到模板，或者克隆模板仓库。

完成此操作后，您将在模板的README中找到进一步说明。

有一个（进行中）教程，您可以在项目网站上找到。

帮助/支持

如果您需要任何帮助，请访问讨论页面，那里是创作者和贡献者提供帮助的好地方。

请随意在问答类别中创建一个新的讨论，我们会尽力帮助您！

为agb本身做贡献

为了为agb本身做出贡献，您需要一些额外的工具，这些工具在仅使用此库为Game Boy Advance编写游戏之外还需要

• 最近的rustup，请访问rust网站获取您操作系统的安装说明。
  • 您可以使用以下命令更新rustup：rustup self update，或者如果您以这种方式获取了rustup，也可以使用您的包管理器。
• libelf和cmake
  • Debian及其衍生版本：sudo apt install libelf-dev cmake
  • Arch Linux及其衍生版本：pacman -S libelf cmake
• mgba-test-runner
  • 在此目录内运行cargo install --path emulator/test-runner
• 'just'构建工具
  • 使用cargo install just进行安装
• mdbook
  • 使用cargo install mdbook进行安装
• miri
  • 部分不安全代码使用miri进行测试，使用以下命令安装：rustup component add miri

安装了所有这些后，您应该可以通过运行以下命令来运行agb的完整构建

just ci

请注意，在您创建PR之前，请先提交一个issue，这样我们就可以讨论您想要更改的内容。

仓库结构

agb-debug - 一个可以用来解码agb堆栈跟踪的工具

agb-fixnum - 一个简单的定点数存储库，因为GBA没有浮点单元，所以需要高性能的十进制数

agb-gbafix - 一个gbafix工具的纯净重实现，它接受elf文件而不是二进制文件

agb-hashmap - 一个no_std hashmap实现，针对在Game Boy Advance上的使用进行了优化

agb-image-converter - 一个crate，可以将图像从正常格式转换为GBA支持的格式

agb-macros - 一些必须放在不同crate中的杂项proc宏

agb-sound-converter - 一个crate，可以将wav文件转换为GBA支持的格式

agb - 主要库代码

agb/examples - 基本示例，通常针对1个功能，您可以使用just run -example 运行这些示例

book - 指南和网站的源代码

book/games - 作为教程的一部分制作的游戏

emulator - Rust对mgba模拟器的绑定，以及您可以用来运行单元测试的测试运行器

examples - 游戏节期间制作的完整游戏的大示例

template - 模板仓库的源代码 模板仓库链接

tools - 用于 agb 本身开发的杂项工具

tracker - 构成 agb-tracker 库的 crate，允许播放 tracker 文件

website - 网站的源代码 网站链接

稳定性

由于 agb 处于预 1.0 阶段，我们遵循半语义版本控制方案以确保小版本之间的兼容性。具体来说，任何 0.x.y 版本保证与另一个 0.x.z 版本兼容，前提是 y > z，但小版本之间可能存在破坏性更改（例如，第二个数字的更改，例如从 0.1 到 0.2）。

一旦 agb 达到版本 1.0，我们将过渡到更强的语义版本控制，这意味着任何破坏性更改将通过主版本号的增加来表示（即第一个数字，例如，从 1.0 到 2.0）。

致谢

没有以下（非详尽）项目的帮助，agb 将无法实现

• rust-console 的出色工作，使其最初成为可能 rust-console 链接
• 用于加载 aseprite 文件的 asefile crate
• 提供常用方法的高性能替代方案 agbabi
• 内置到模拟器中的所有有用的调试/开发工具 mgba

许可证

agb 及其所有子 crate 都在 MPL 2.0 版本下发布。请参阅 LICENSE 文件中的完整许可证文本。

agb 包含来自 agbabi 的代码子集，该代码在 zlib 风格下发布，详细信息可在 agb/src/agbabi 下找到。

模板在 CC0 下发布，以便您可以做出任何更改。

agb 标志在 Creative Commons Attribution-ShareAlike 4.0 下发布

示例中使用的音乐由 Josh Woodward 提供，并按照 Creative Commons Attribution 4.0 发布