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之前，请先提交一个问题，这样我们可以讨论您想要进行的更改。

仓库结构

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

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

agb-gbafix - gbafix实用程序的干净房重实现，接受elf文件而不是二进制文件

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

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

agb-macros - 必须位于不同crate中的各种proc-macros

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

agb - 主要库代码

agb/examples - 靶向单个功能的简单示例，您可以使用just run-example <example-name>运行这些示例

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 承担的令人惊叹的工作，使得这一切成为可能
• 用于加载 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 许可下发布