NarraLeaf

Live2D

从下载的 SDK 压缩包将 Live2D Cubism 运行时安装进 Studio 项目,以及安装后 Live2D 角色支持的内容

Live2D Cubism 通过变形一张 2D 插画实现动画:画面本身保持平面,由绑定控制其运动。一个 Cubism 模型是一个目录,包含 .model3.json 清单、.moc3 绑定、贴图页,以及动作、表情、物理与姿态各自的文件

Studio 安装 Cubism 运行时的方式是使用所提供的 SDK 在本机编译。运行时不随 Studio 分发的原因见模型运行时

开始之前

Live2D Cubism 由 Live2D Inc. 授权,而非 NarraLeaf。 从 Live2D 下载 SDK 时即接受 Cubism SDK 许可协议,且在构建的游戏中,分发方为使用者本人。免费使用存在边界:超过 Live2D 公布的年营收阈值后,商业发行需另行向其申请 Publication License。单一标题收录多个独立作品、或读取构建时未包含的模型,属于 Expandable Application,即使免费发行也须在发行前获得 Live2D 批准。发行前请在 Live2D 许可页面 核对现行条款。NarraLeaf 不是该协议的当事方,无法就其授予任何权利

所需文件为 Cubism SDK for Web,不是 Cubism Editor,也不是 SDK for Native。它是单个 .zip 文件,约 20 MB,可从 Live2D 下载页 获取。压缩包保持下载时的原样即可,无需解压,Studio 直接读取压缩包

安装

打开安装器

可从角色进入:通过 新建角色 → Live2D Cubism 创建角色后,选择绘制运行时一行的 安装;也可选择 项目 → 运行时 → Live2D Cubism → 安装

阅读条款

对话框会说明所需同意的内容,并提供 Live2D 下载页链接。Studio 不代取 SDK,因为下载页是接受 Live2D 许可协议的环节。勾选确认后继续

选择压缩包

选择 选择 SDK 压缩包,指定该 .zip 文件。Studio 会校验它是否为 SDK 包,检查项包括 cubism-info.yml、Core、Framework 源码与 shader。若选择的文件不是 SDK 包,Studio 会说明该压缩包的实际内容

构建运行时

Studio 解出 Core、Framework 与 shader 源码,与自带的适配器代码一同编译,并将结果写入项目。该过程耗时一到两秒。完成后,对话框会报告构建所用的 SDK 版本

安装结果如下:

index.js
README.md

index.js 为生成文件,约 1 MB,渲染器编译在其中,并带有 Live2D 的版权声明。licenses/ 保存 Live2D 的许可文本(与压缩包中的内容一致)以及 Core 的可再分发文件清单;README.md 记录生成该文件的 SDK 版本。以上文件均属于项目内容,并会随每个构建产物一同分发

Live2D 的许可涵盖的是「在发行的游戏中再分发 SDK」,不涵盖公开的源码仓库。请将该目录排除在你公开的仓库之外

重新构建(更换较新的 SDK,或 Studio 更新了适配器)只需再次安装并覆盖。项目中不存在对该文件内容的引用,只引用 live2d 这一名称,因此角色不受影响

导入模型

Cubism 模型是一个目录,因此按目录导入。Studio 会定位其中的 .model3.json 并将其作为入口,其余文件(贴图、动作、物理)均按清单的引用方式相对该入口解析

导入模型目录

在角色的 模型 一行中,若项目内已有模型则直接选择,否则导入目录。所选目录须为包含 .model3.json 的一层

读取模型

运行时与模型均到位后,Studio 会挂载模型并查询其内容。预览随即绘制模型,下方字段一并填充

Live2D 角色支持的内容

模型读取完成后,以下内容来自模型:

字段填入
动作清单中的每个动作,命名为 <组>_<序号>,例如 Idle_0Idle_1TapBody_0。也可使用组名(如 Idle),表示该组第一条。清空该字段时,模型停在中性姿态
表情清单中每个表情的 Name
皮肤空。Cubism 没有皮肤概念,为 Live2D 角色设置的皮肤会被忽略并给出警告
参数绑定暴露的每个 Cubism 参数,带其实际的最小值、最大值与默认值,例如 ParamAngleXParamEyeLOpen

另有四个参数来自适配器而非模型,带前缀以避免与绑定自身的参数冲突:

参数范围作用
@scale0.05 – 4在盒子内缩放模型
@x@y−2 – 2在盒子内调整位置
@timeScale0 – 4调整动画速度,0 表示冻结

未应用任何动作的模型并非静止:Cubism 的呼吸与眨眼独立于动作轨道运行

运行时选项

选项 映射会原样传递给运行时。Live2D 适配器读取以下键:

作用
scaleoffsetXoffsetY@scale / @x / @y 的初始值
diagnostics设为 true 时开启绘制报告:首帧之后,适配器统计实际绘制的像素并记录。它可区分未绘制任何内容绘制出纯白剪影,后者是贴图上传被拒的特征。默认关闭,因为每个角色都需一次整画布读取

模型未显示时

适配器会记录加载过程,并在挂载失败时将该记录输出到控制台。定位问题时应从中查看清单中具体哪一个文件出错,而非仅看最后一条报错

现象通常原因
「本机未安装该运行时」当前机器未安装。项目为新克隆,或从未安装过运行时
「无法绘制该模型」并附带原因即为所报告的原因:入口文件缺失、包无法读取,或运行时已不存在
游戏中角色显示为空盒子角色上的 backend 名与任何已安装的运行时都不匹配。检查 项目 → 运行时
模型绘制为纯白色块贴图上传被拒。开启 diagnostics 后查看控制台
无任何显示,也无报错导入的目录应为包含 .model3.json 的一层,而非其上级目录

本页目录