Git 语言文件系统
确保你已经为这个 repo 安装并启用了
Git LFS。如果你不这样做,你会过
得很糟糕。
Rust
如果您还没有安装 Rust,请继续
从官方网站安装它。安装完成后
rustup
,也添加 Android 目标
rustup target add aarch64-linux-android
Android SDK/NDK 和 Java JDK
Android Studio
如果您对 Android Studio 满意,可以
从官方网站将它们一起安装。请注意,您
必须使用 NDK r22b (22.1.7171670) 和 Android SDK 28,因为
ndk-glue
较新版本存在一些问题。
没有Android Studio
如果这不是你的问题,你可以直接在此处下载 NDK ,或者直接从此链接下载 Android 命令行工具
,向下滚动到“命令行工具” ,或者在Windows、
macOS或 Linux上使用系统的包管理器安装它.
安装工具后,请确保使用
sdkmanager
安装 Android SDK 28 和
build-tools
包。如果您以前没有摆弄过,可以阅读
文档sdkmanager
。
重要笔记:
- 确保您使用的是 NDK r22b
- 确保您使用的是 SDK 28
- 确保安装了构建工具
- 确保安装了平台
APK 签名需要 Java JDK,因此您需要单独安装它。建议使用 Oracle 发行版以获得最佳兼容性,但我们还没有收到任何关于使用 OpenJDK 的问题的报告。
cargo APK
cargo apk是一种将 Rust 应用程序打包到 Android APK 中的工具,因此它们可以在移动耳机上运行。你可以安装它:
cargo install cargo-apk
Ninja与 cmake
您需要确保两者兼备,
ninja
并且
cmake
以某种方式可用
PATH
。
在 Windows 上,这可能有点烦人,但您可以通过分别为ninja和
cmake安装 Chocolatey 包来找到一些包来简化此操作。
shaderc
注意:shaderc
确实随 Vulkan SDK 一起提供,因此如果您已经安装了它,则可以跳过此步骤。
我们在构建时使用
shaderc来编译我们的着色器,因此您需要确保它已安装并在您的
PATH
.
可选 - Vulkan SDK
Vulkan
SDK附带了一系列用于 Vulkan 开发的有用工具。如果您还没有安装它,我们建议您安装它。
设置开发环境
首次构建
呸!您通过了所有先决条件。来吧,站起来,舒展一下,给自己泡杯茶/咖啡/
your_beverage_of_choice
。你赚到了!别担心,当你回来时我们仍然会在这里。
完毕?好的。让我们打造这个坏男孩。
建造整个存储库
让我们构建整个存储库、示例和所有内容,以确保您正确地遵循了所有步骤。这是关键时刻:
故障排除
是不是都炸成了一个火球?希望不会。如果是这样,请返回上面的清单几次,看看是否遗漏了什么。如果您仍然遇到问题,只需
跳到 Discord 上,我们就能解决您的问题!
运行示例
一切都建立好了吗?伟大的!现在让我们提高赌注。让我们在您的耳机上运行其中一个示例。可以说,最有趣的示例是“Crab Saber”,所以让我们运行它。
Windows
我们提供了一些 Powershell 脚本来帮助您在 Windows 上实现自动化。在运行它们之前,您需要
遵循这些说明。
从根目录,只需运行:
.\examples\crab-saber\scripts\run_on_device.ps1
运气好的话你应该可以走了。
Linux / macOS
你知道该做什么。从根目录运行:
./examples/crab-saber/scripts/run_on_device.sh
使用模拟器
设置模拟器后,运行示例应该很简单:
cargo run --bin hotham_crab_saber --release
故障排除
在此步骤中可能会出错的地方太多了。如果您仍有问题,
请加入 Discord,我们会帮助您!
下一步
好吧!所以你玩了一个糟糕的 Beat Saber 版本..现在怎么办?好吧,您很可能想要创建您的第一个应用程序。我们仍在对此进行记录,但现在,请尝试将
simple_scene_example
或
beat_saber_example
目录复制到一个新的存储库中,构建它们,看看您可以用它们做什么!