# VRM

本指南将引导您完成为 SillyTavern 设置和自定义 VRM 扩展的过程。此扩展允许您为角色使用 VRM 动画模型，为您的虚拟角色提供动态和互动元素。

在开始之前，请确保您已满足以下先决条件：

1. 分支选择：确保您使用的是最新版本的 SillyTavern 分支以访问最新功能和更新。

2. 扩展安装：从扩展面板（以堆叠块图标表示）的"下载扩展和资产"菜单中安装"VRM"扩展。

3. 模型文件夹放置：将您的 VRM 模型文件（.vrm）放入 /data/<用户标识>/assets/vrm/model 目录，将您的动画文件放入 /data/<用户标识>/assets/vrm/animation 目录。当前支持的动画文件格式是与 VRM 模型兼容的 .fbx 和 .bvh。这包括您可以从 Mixamo (https://www.mixamo.com/) 获得的任何动画以及您可以从 XR Animator (https://github.com/ButzYung/SystemAnimatorOnline) 等工具导出的任何动画。

VRM 扩展提供各种设置来自定义动画模型的行为。以下是关键设置：

1. 启用：

   • 选中此复选框以激活扩展，允许您的 VRM 模型在 SillyTavern 中进行交互。
   • 如果您只想使用普通精灵，可以禁用此扩展。

2. 看相机：

   • 选中此复选框使 VRM 模型眼睛看向相机。

3. 眨眼：

   • 选中此复选框使 VRM 模型眼睛在随机间隔眨眼。模型表情应正确定义眨眼权重属性，否则模型可能会闭眼眨眼，例如，如果发生这种情况，请：
   • 如果您有 .vroid 文件，请更正模型
   • 不要使用那个不正确的面部表情
   • 使用此复选框完全禁用眨眼

4. TTS 嘴型同步

   • 选中此复选框使 VRM 嘴部动作跟随您的 TTS 播放时的声音。仅适用于由 Sillytavern 本身播放声音的 TTS，如 XTTS（非流式模式）。如果禁用，当收到新的角色消息时，嘴部将根据消息文本长度进行动画。

5. 自动发送交互：

   • 选中此复选框可在点击具有映射消息的区域时自动触发角色交互（有关详细信息，请参阅点击区域部分）。

1. 身体点击框

   • 选中此复选框以激活对 VRM 模型多个部分的点击检测，根据模型可以检测到以下区域：头部/胸部/手/腹股沟/臀部/腿/脚。点击框位置在每一帧计算并跟随身体动画，禁用此选项可以提高性能。

2. 使用模型缓存

   • 选中此复选框在切换模型时将 VRM 模型保留在内存中，允许更快地切换回上一个模型。如果您为同一角色使用不同模型来改变服装或形态，这很有用。可能影响性能。

3. 使用动画缓存

   • 选中此复选框将会话期间播放的所有动画保留在内存中。分配给模型的所有动画也将在模型第一次出现时加载。将增加您第一次加载模型的时间，但使所有动画切换瞬间完成。可能影响性能。

1. 显示网格

   • 选中此复选框以可视化 3D 网格、模型拖动框和身体点击框。

2. 重新加载按钮

   • 点击此按钮重新加载 3D 场景，清除缓存和所有 VRM 模型。如果发生某些错误或缓存开始影响性能，请使用它。

1. 灯光颜色

   • 设置 3D 场景中的灯光颜色。点击重置按钮将其设置回默认白色。根据您的浏览器，您可以使用颜色选择器，例如您可以选择背景图像的颜色以增加沉浸感。

2. 灯光强度

   • 使用滑块设置灯光强度百分比。点击重置按钮将其设置回默认值 100%。VRM 模型对灯光的反应可能不同，具体取决于模型中烘焙的着色器，请调整值并观察效果。

这些设置允许您管理角色并为它们分配 VRM 模型。

1. 刷新按钮：

   • 点击刷新按钮更新当前聊天中的角色列表。

2. 选择角色：

   • 使用下拉列表选择要为其分配 VRM 模型的角色。

3. 删除按钮：

   • 点击此按钮删除角色的分配模型。

1. 刷新按钮：

   • 如果您的 VRM 模型未出现在列表中，请点击刷新按钮。

2. 选择模型：

   • 从列表中选择一个模型分配给选定的角色。
   • 模型必须位于 /data/<用户标识>/assets/vrm/model 目录中。

3. 重置按钮

   • 点击此按钮将模型设置重置为默认值。如果您有对应默认值的动画文件，它们将自动映射。请参阅本 README 末尾的命名映射。

1. 模型缩放：

   • 使用滑块调整模型大小，使其更大或更小。

2. 模型中心 X/Y 偏移：

   • 使用这些滑块更改模型相对于窗口中心的水平/垂直位置。

3. 模型 X/Y 旋转

   • 使用这些滑块更改模型相对于模型臀部的水平/垂直旋转。

- 设置按模型而不是按角色保存，并延续到不同的聊天中。
- 如果您想为两个不同的角色使用具有不同设置的相同模型，请制作 .vrm 文件的副本。
- 您也可以用鼠标拖动模型，这些设置将被更新和保存。左键单击并按住可在屏幕上拖动模型。中键单击并按住旋转模型或使用 shift+左键单击。使用鼠标光标在模型上滚轮可放大或缩小，或使用 ctrl+左键单击。
- 如果您不小心将模型移出视图，请使用这些 UI 设置将模型带回屏幕上。还要选中"显示框架"复选框以清楚地看到可以点击拖动模型的位置。

- 根据模型骨骼定义，可以生成一些点击框区域，它们将在此 UI 部分列出，您可以为每个区域分配表情/动画/消息，当点击该区域时将触发。

1. 要求

   • 需要使用分类表情扩展；否则，它将回退到默认动画。

2. 映射

   • 对于分类扩展检测到的每种情绪，您可以分配表情/动作/消息。消息可以包含命令。

1. /vrmlightcolor
   • 设置灯光颜色
   • 参数：颜色
   • 示例："/vrmlightcolor white" 或 "/vrmlightcolor purple"。
2. /vrmlightintensity
   • 设置灯光强度百分比
   • 参数：强度
   • 示例："/vrmlightintensity 0" 或 "/vrmlightintensity 100
3. /vrmmodel
   • 将 vrm 模型分配给角色
   • 参数：角色，模型
   • 示例：单人聊天中的"/vrmmodel Seraphina.vrm"或群聊中的"/vrmmodel character=Seraphina model=Seraphina.vrm"
4. /vrmexpression
   • 更改模型的表情
   • 参数：角色，表情
   • 示例：单人聊天中的"/vrmexpression happy"或群聊中的"/vrmexpression character=Seraphina expression=happy"
5. /vrmmotion
   • 更改模型的动画
   • 参数：角色，动作，循环，随机
   • "/vrmmotion idle" 或 "/vrmmotion character=Seraphina motion=idle loop=true random=false"

如果您的动画文件按以下方式命名，它们将在重置模型设置时自动映射。例如，名为"assets/vrm/animation/neutral.bvh"和"assets/vrm/animation/neutral1.fbx"的文件将自动映射为默认和中性分类动画的组。点击框也是如此。

// 回退
"default": "assets/vrm/animation/neutral",

// 分类类
"admiration": "assets/vrm/animation/admiration",
"amusement": "assets/vrm/animation/amusement",
"anger": "assets/vrm/animation/anger",
"annoyance": "assets/vrm/animation/annoyance",
"approval": "assets/vrm/animation/approval",
"caring": "assets/vrm/animation/caring",
"confusion": "assets/vrm/animation/confusion",
"curiosity": "assets/vrm/animation/curiosity",
"desire": "assets/vrm/animation/desire",
"disappointment": "assets/vrm/animation/disappointment",
"disapproval": "assets/vrm/animation/disapproval",
"disgust": "assets/vrm/animation/disgust",
"embarrassment": "assets/vrm/animation/embarrassment",
"excitement": "assets/vrm/animation/excitement",
"fear": "assets/vrm/animation/fear",
"gratitude": "assets/vrm/animation/gratitude",
"grief": "assets/vrm/animation/grief",
"joy": "assets/vrm/animation/joy",
"love": "assets/vrm/animation/love",
"nervousness": "assets/vrm/animation/nervousness",
"neutral": "assets/vrm/animation/neutral",
"optimism": "assets/vrm/animation/optimism",
"pride": "assets/vrm/animation/pride",
"realization": "assets/vrm/animation/realization",
"relief": "assets/vrm/animation/relief",
"remorse": "assets/vrm/animation/remorse",
"sadness": "assets/vrm/animation/sadness",
"surprise": "assets/vrm/animation/surprise",

// 点击框
"head": "assets/vrm/animation/hitarea_head",
"chest": "assets/vrm/animation/hitarea_chest",
"groin": "assets/vrm/animation/hitarea_groin",
"butt": "assets/vrm/animation/hitarea_butt",
"leftHand": "assets/vrm/animation/hitarea_hands",
"rightHand": "assets/vrm/animation/hitarea_hands",
"leftLeg": "assets/vrm/animation/hitarea_leg",
"rightLeg": "assets/vrm/animation/hitarea_leg",
"rightFoot": "assets/vrm/animation/hitarea_foot",
"leftFoot": "assets/vrm/animation/hitarea_foot"

感谢您遵循本指南！您的 SillyTavern 体验现在通过动画和互动的 3D 模型得到了丰富。

- 此扩展加载的 VRM 模型是 .vrm 文件，而不是 .vroid 文件。
- 动画文件应与 VRM 兼容，您可以使用 XR animation (https://github.com/ButzYung/SystemAnimatorOnline) 等工具来转换 fbx/bvh 动画文件。
- 您可以通过拥有相同名称但以不同数字结尾的文件来创建动画组，例如："idle1.bvh"、"idle2.bhv"、"idle3.bvh"将被视为一个组"idle"，当在映射中选择时，触发时将随机播放一个，可用于为动画添加多样性。
- 您可以从此存储库获取精心策划的动画：https://github.com/test157t/VRM-Animations-Pack-For-Silly-Tavern
- Nitral 有一些关于如何使用扩展和动画存储库的教程视频：https://www.youtube.com/@nitralai