godot-rust中文文档

godot-rust中文文档是对gdext用户指南的翻译，gdext是Godot 4的Rust绑定。该文档涵盖了大量的概念，并且补充了 API 文档。对于 Godot 3，可以参考 gdnative-book。

Tip

该文档部署在 colinwttt.github.io/godot-rust-book-chinese.

本地设置

本书是使用 mdBook 和插件 mdbook-toc、mdbook-admonish 构建的。要安装它们并在本地构建本书，可以运行以下命令：

cargo install mdbook mdbook-toc mdbook-admonish
mdbook build

要在编辑本书时运行带有自动更新的本地服务器，请使用：

mdbook serve --open

格式化与拼写检查

markdownlint 强制对 Markdown 文件应用一致的风格。它会在 CI 过程中自动运行，但如果你有 npm 工具链，你也可以在本地运行它：

npm install --global markdownlint-cli2
./lint.sh

# 直接修复某些错误：
./lint.sh fix

Oxipng

我们使用 oxipng 来优化图像文件的大小。你可以通过 cargo install oxipng 安装它，然后按如下方式运行：

oxipng --strip safe --alpha -r src

贡献

该仓库仅用于文档。如果需要更改库本身，请在 主仓库 中打开拉取请求和问题，并阅读 贡献指南。

许可

与 gdext 本身一样，gdext 手册也使用 MPL 2.0 许可证。