Skip to content

dsh-openbone-plugin

Verified

dsh-openbone-plugin · v0.4.2 · Web UI

Create, edit and preview OpenBone skeletal animations through DSH.

Install

dsh plugin add dsh-openbone-plugin

Confirm the layer applied with dsh --profile default --dump-config — see the install guide.

Source

Tags

Creators

Readme

OpenBone Studio:在 DSH 中制作骨骼动画

English

通过对话查看和调整骨骼动画,在浏览器中播放预览,再根据效果继续修改。插件已内置 Web Runtime,无需另外下载预览播放器。

安装插件

当前 0.4.0 为候选版本,请在 DSH 插件安装界面选择管理员提供的安装包:

dsh-openbone-plugin-0.4.0.tgz

安装完成后,重启对应的 DSH profile。也可以使用命令行安装:

dsh plugin --profile <你的profile> add ./dsh-openbone-plugin-0.4.0.tgz

请选择实际运行 DSH 网页版或桌面版的 profile。

连接 OpenBone

使用前需要兼容的 DSH、Node.js 24.9 或更新版本,以及管理员提供的 OpenBone 服务地址。自动体验需要 DSH 的持久凭据存储功能;手动账号仍支持 DSH 0.2.1-rc.3 或更新版本(低于 0.3.0)。

自动体验

将 OPENBONE_LIBRARY_URL 设为服务根地址,例如 https://animation.example.com/,不配置 OPENBONE_LIBRARY_TOKEN,然后重启对应的 DSH profile。第一次使用 OpenBone 工具时,插件会自动领取体验账号并将连接凭据保存在 DSH 凭据库,无需复制密钥到聊天。

同一安装身份重试会继续使用原账号。默认体验 7 天、最多 2 个工程,实际有效期和配额可在工程绑定结果中查看。到期后联系管理员;插件不会自动换号。请保留 DSH 的凭据数据,以便继续访问自己的工程。

管理员开通的手动账号

在运行 DSH 的服务器上配置以下环境变量:

变量 填写内容
OPENBONE_LIBRARY_URL 管理员提供的服务地址
OPENBONE_LIBRARY_TOKEN 手动账号的访问密钥;自动体验时不配置

如果使用远程 DSH 网页版,应配置服务器端环境。修改连接配置后,重启 DSH。

托管账号地址形如 https://animation.example.com/u/alice/,请保留用户路径和末尾 /。每位用户使用独立密钥,管理员会提供包含上述两个值的私密 JSON 文件。不要把密钥发到聊天中。

例如,在运行 DSH 的机器使用 PowerShell:

$connection = Get-Content -Raw ./my.credentials.json | ConvertFrom-Json
$env:OPENBONE_LIBRARY_URL = $connection.OPENBONE_LIBRARY_URL
$env:OPENBONE_LIBRARY_TOKEN = $connection.OPENBONE_LIBRARY_TOKEN
dsh --profile <你的profile>

如果 DSH 由系统服务启动,请由管理员将这两个变量配置到服务环境中。

开始制作

在启用插件的聊天中,先让 DSH 连接工程:

列出可用的 OpenBone 工程,并把当前聊天连接到我要修改的角色。

新开通的托管账号包含一个空白 starter 工程。可以让 DSH 连接它并创建骨骼和动画,也可以指定名称新建空白工程;托管服务会自动启动编辑。参考库初始为空,需由管理员导入选定参考。

接着查看已有动画:

这个工程有哪些动画?先帮我看一下行走动作。

提出具体的修改需求:

把行走动画的手臂摆动幅度稍微减小,然后生成预览。

也可以从动作参考开始:

找一个适合小短腿角色的行走参考,帮我基于它创建新工程。

托管服务会自动启动从参考创建的工程。旧式固定端点服务若返回 connected: false,需联系管理员配置该工程后再连接。

查看动画预览

让 DSH 生成预览后,打开返回的链接。可以在 DSH 浏览器或自己的浏览器中观看。

播放器支持:

  • 切换动画和皮肤。
  • 播放、暂停、循环和调速。
  • 拖动时间轴、适应画面。
  • 保存 PNG 截图。
  • 切换中英文界面。
  • 选择 OpenBone 或 Spine WebGL 播放方式。

Spine WebGL 的使用遵循随包附带的许可说明。

再次修改动画后,请让 DSH 生成新的预览;已经打开的预览不会自动更新。链接失效时,重新生成即可。

反馈、撤销和保存

根据看到的效果继续反馈:

落地还是有点生硬,把结束前身体旋转的变化放缓,再让我看一下。

需要还原时:

撤销上一次修改,重新生成预览。

确认效果后:

保存当前 OpenBone 工程。

服务重启前请先保存工作。每个聊天可以连接一个工程;需要切换时,让 DSH 列出可用工程并更换连接。

托管服务重启后自动恢复最后保存的工程。继续修改前先重新读取当前状态;撤销历史和旧预览链接不跨服务重启保留。

常见问题

情况 处理方式
安装后没有可用工具 重启安装插件时使用的同一个 DSH profile。
无法连接服务 请管理员检查服务地址、访问密钥和服务运行状态。
没有可用工程 请管理员将工程设为可用,再让 DSH 重新列出工程。
预览仍然是修改前的效果 在修改完成后请求生成新的预览。
预览链接失效 让 DSH 重新生成预览。
修改或保存提示冲突 让 DSH 重新读取当前工程状态,再继续操作。

插件内置的是预览播放器;编辑和保存工程仍需连接 OpenBone 服务。

服务管理员请参阅托管部署与用户开通。