AGB

适用于Game Boy Advance的Rust

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

agb提供了以下功能

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

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

入门

开始使用agb的最佳方式是使用模板，无论是此存储库中的template目录中的模板，还是克隆模板仓库。

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

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

帮助/支持

如果您需要任何帮助，请访问讨论页面，这是从创建者和贡献者那里获得帮助的好地方。

欢迎在问答类别中创建新的讨论，我们会尽力帮助您！

为agb本身做贡献

为了为agb本身做出贡献，您需要一些额外的工具，而不仅仅是使用此库为Game Boy Advance编写游戏所需的工具。

• 请参阅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 - 一个接受elf文件而不是二进制的gbafix实用程序的干净房重实现

agb-hashmap - 一个针对Game Boy Advance优化的no_std hashmap实现

agb-image-converter - 一个将图像转换为Game Boy Advance支持的格式的crate

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

agb-sound-converter - 一个将wav文件转换为Game Boy Advance支持的格式的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 发布