3个版本
| 0.2.2 | 2022年11月17日 |
|---|---|
| 0.2.1 | 2022年4月30日 |
| 0.2.0 | 2022年4月30日 |
#2005 in 游戏开发
33 个月下载量
在 2 crates 中使用
17KB
254 行
Rrise-Headers
什么是Rrise-Headers？
这个crate基本上是一个构建脚本，它会生成一个常量文件。这个crate打算与rrise crate一起使用。
一旦通过Wwise生成了音效库，你通常会找到一个包含音效库定义的伴侣.txt文件：所有事件、状态、RTPCs、开关、触发器等，按名称和ID排列。
Rrise-Headers将解析这个定义文件，并生成一个Rust文件，使用常量来复制它，这些常量可以在代码中使用。
这将允许你在Wwise项目更新时及早失败。例如，如果某些事件丢失，你的代码在没有修复这些仍然发布的陈旧事件的情况下将无法编译。
使用方法
配置
以下环境变量可用：
| 变量 | 描述 |
|---|---|
BANK_PATH |
你的生成音效库文件夹 |
入门
- 将BANK_PATH环境变量设置为你的生成音效库文件夹。不要包含平台文件夹，而是包含将包含你的音效库每个平台目录的文件夹。
- 确保你的Wwise项目设置中的音效库路径以Linux和Windows结尾。如果不这样做，这个crate将期望音效库直接在BANK_PATH中。
- 将此crate添加到项目的依赖项中。
- 将
use rrise_headers::rr添加到需要引用Wwise生成资源（如事件或RTPCs）的文件中。 - 你现在可以使用像
rr::ev::MyEvent这样的常量，并在输入rr::时从你的IDE的自动补全中受益。
关于标识符
在翻译Wwise标识符时，
- 结果Rust标识符的大小写与Wwise项目中的大小写相同。
- 空格和其他无效字符被替换为
_。 - 如果标识符以数字开头，则在其前面添加
_。 - 允许使用Unicode字符。
命名空间
以下是rrise-headers如何在rr模块中组织你的Wwise资源的方式
rr
|-- bnk // Init + your soundbanks defined as string constants
|-- ev // Events
|-- d_ev // Dialog events
|-- rtpc // Game parameters
|-- trg // Triggers
|-- bus // Busses
|-- xbus // Auxiliary busses
|-- dev // Audio Devices
|
|-- st // States
|---- <... YourStateGroup ...> // State group ID *and* module
|------ <... states available in YourStateGroup ...> // State values are namespaced in their group
|
|-- sw // Switches
|---- <... YourSwitchGroup ...> // Switch group ID *and* module
|------ <... switches available in YourSwitchGroup ...> // Switch values are namespaced in their group
法律事务
Wwise 和 Wwise 标志是 Audiokinetic Inc. 的商标，在美国和其他国家注册。
本项目与 Audiokinetic 没有任何关联。
无运行时依赖
~0–1MB