VR Jester API (虚拟现实顽皮者API)

VR Jester API (虚拟现实顽皮者API)

---

Github | 相关wiki | 源站链接

支持: fabric , forge , quilt

这是一个为Vivecraft和QuestCraft设计的虚拟现实手势识别API，用于Minecraft VR。

## 介绍：
Play Vivecraft或者QuestCraft？喜欢使用MOD？希望MOD更兼容虚拟现实？不用再等待了，这个API的发布解决了玩家和开发者的苦恼！

这个API能够让Minecraft的MOD开发者更方便地实现他们的MOD与虚拟现实兼容。创建**任何**自定义手势并映射到**任何**按键并触发事件。不再需要将控制器的按键与键盘的按键进行映射。有了这个API，你的身体就是控制器。

## Demos:
- [点击查看Demo]( 链接)
- [点击观看Demo]( 链接)
- [点击查看Demo]( 链接)
- [点击观看Demo]( 链接)

## 安装:

1. 安装所需的依赖MOD。需要注意的是[Questbind]( 链接) 仅适用于QuestCraft。
2. 下载 VR Jester API 模组 并将其放入 `mods` 文件夹中。
3. 运行Minecraft。必要的配置文件将在初始化时生成。

## 使用：

1. 在Minecraft VR中，将你的控制器按钮之一绑定到“手势侦听触发器”。我建议使用抓握按钮。对于Vivecraft，你必须通过Steam VR的控制器绑定菜单来完成。对于QuestCraft，你需要通过QuestBind来完成这一步。
2. 创建手势有两种方式：
- 使用 `/gesture` 命
- 直接修改 `config/gesture_store.json`文件，其中存储了手势。样本手势存储如下:
json
"GESTURE 1": {
"RIGHT_CONTROLLER|LEFT_CONTROLLER": [
{
"vrDevice": "RIGHT_CONTROLLER|LEFT_CONTROLLER",
"movement": "forward",
"elapsedTime": 0,
"speed": 0.0,
"direction": {
"x": 0.0,
"y": 0.0,
"z": 0.0
},
"devicesInProximity": {}
}
]
},
...

3. 创建手势后，你可以在 `config/VRJesterAPI.cfg` 中创建键-值对象, 将手势映射到按键。你可以在 `.minecraft/options.txt` 中找到按键名称。“KEY_ACTION”字段确定了识别手势触发单击键还是长按键的行为。当你识别手势后保持手势不变，就会触发长按。
json
"GESTURE_KEY_MAPPINGS": {
"GESTURE 1": {
"KEY_MAPPING": "examplemod.key.ability_1",
"KEY_ACTION": "click"
},
"GESTURE 2": {
"KEY_MAPPING": "key.hotbar.2,key.sneak",
"KEY_ACTION": "hold"
},
"GESTURE 3": {
"KEY_MAPPING": "key.keyboard.j",
"KEY_ACTION": "click"
}
}

## 下载:  [![modrinth下载链接]]( 链接)  [![curseforge下载链接]]( 链接)

## 信息:

- 请将方括号[ ]中的每个对象视为手势的一个*部分*。你可以添加多个这样的**GestureComponent**对象。这个API可以识别你想要的任何复杂手势！只需要知道，手势越复杂，正确执行手势的难度就越大。
- *"movement"* 的不同值包括 `forward, back, left, right, up, down`。运动方向是相对于你此刻面朝的方向的。比如，朝向相同方向的向前出拳会被识别为“向前”。
- *"vrDevice"* 的不同值包括 `RIGHT_CONTROLLER, LEFT_CONTROLLER, HEAD_MOUNTED_DISPLAY`。如果你想要在多个VR设备上识别手势，你可以使用管道`|`进行逻辑或的组合，像这样 `RIGHT_CONTROLLER|LEFT_CONTROLLER|HEAD_MOUNTED_DISPLAY`。
- *"