vtubestudio-cli (vts)

向 VTube Studio API 发送单次请求的 CLI 程序。它连接到 WebSocket，进行身份验证，执行一个或两个其他请求，然后断开连接并退出。

主要用例是执行不频繁的操作，例如触发热键或注册自定义参数，而不需要建立长时间运行的 WebSocket 连接。

对于更复杂的任务，您可能需要查看客户端库，如 vtubestudio-rs（此程序在底层使用的 Rust 库）。

下载

请查看 发布页面 下载您平台预构建的二进制文件。

否则，您可以使用 cargo install vtubestudio-cli 或使用 cargo build --release 从此仓库手动构建。

初始化

vts 从一个 JSON 配置文件中读取身份验证令牌信息，该文件的默认位置取决于平台。

要生成默认位置的配置文件，您可以运行

vts config init

这将注册插件与 VTube Studio API（用户将在应用程序中收到确认提示）并保存令牌以供将来调用使用。插件名称和开发者名称可以使用 --plugin-name 和 --developer-name 分别自定义。

配置文件位置

默认情况下，配置文件可以在以下位置找到

• Windows: %USERPROFILE%\AppData\Roaming\walfie\vtubestudio-cli\config.json
• macOS: $HOME/Library/Application Support/com.github.walfie.vtubestudio-cli/config.json
• Linux: $XDG_CONFIG_DIR/vtubestudio-cli/config.json 或者 $HOME/.config/vtubestudio-cli/config.json

此路径可以通过设置环境变量 VTS_CONFIG 或传递 --config-file 标志来覆盖。

您还可以运行 vts config path 来显示配置路径，或 vts config show 来显示配置文件内容。

用法

热键

• 列出热键

  vts hotkeys list
  

• 通过ID触发热键

  vts hotkeys trigger e50ef5139b114d63af342eb65072a5e3
  

• 通过名称触发热键

  vts hotkeys trigger --name MyHotkeyName
  

Artmeshes

• 列出artmeshes

  vts artmeshes list
  

• 调整artmesh颜色（彩虹色）

  vts artmeshes tint --rainbow --duration 5s --tag-contains shirt sleeves
  

  VTube Studio在插件断开连接时重置artmesh颜色。由于此CLI程序通常在执行命令后立即断开（否则会重置颜色），因此 --duration 标志在之后添加延迟，以保持颜色激活。

• 调整artmesh颜色（十六进制颜色）

  vts artmeshes tint --color ff0000 --duration 5s --tag-contains eye
  

  十六进制颜色也支持透明度，因此类似于 ff0000aa 的值也有效。

参数

• 创建参数

  vts params create MyParameterName --default 0 --min 0 --max 50
  

• 注入参数值

  vts params inject MyParameterName 5
  

• 获取参数值

  vts params get MyParameterName
  

模型

• 列出模型

  vts models list
  

• 通过ID加载模型

  vts models load 8caf15fa0c664f489873386e43835a7f
  

• 通过名称加载模型

  vts models load --name Akari
  

• 移动模型

  vts models move --relative --duration 0.5s --rotation 180
  

表情

• 获取表情列表。

  vts expression list --details
  

• 激活表情。

  vts expression activate myExpression_1.exp3.json
  

物理

• 获取物理设置。

  vts physics get
  

• 设置基础物理强度（默认500毫秒）。

  vts physics set base strength 50
  

• 设置3秒的基础风力强度。

  vts physics set base wind 50 --duration 3s
  

• 设置强度乘数。

  vts physics set multiplier strength 1 --id PhysicsSetting1
  

• 设置风力乘数。

  vts physics set multiplier wind 0.5 --id PhysicsSetting1
  

其他

vts --help