pixi-live2d-display

!GitHub package.json version
!Cubism version
!GitHub Workflow Status

为 PixiJS v7 提供的 Live2D 插件

此项目旨在成为 web 平台上的通用 Live2D 框架。由于 Live2D 的官方框架非常复杂且不可靠，这个项目已将其重写以提供统一且简单的 API，使你可以从较高的层次来控制 Live2D 模型而无需了解其内部的工作原理

#### 特性

- 支持所有版本的 Live2D 模型
- 支持 PIXI.RenderTexture 和 PIXI.Filter
- Pixi 风格的变换 API：position, scale, rotation, skew, anchor
- 自动交互：鼠标跟踪, 点击命中检测
- 比官方框架更好的动作预约逻辑
- 从上传的文件或 zip 文件中加载 (实验性功能)
- 完善的类型定义 - 我们都喜欢类型！
- 实时口型同步
- 同时播放多个动作

#### 要求

- PixiJS：7.x
- Cubism core: 2.1 or 4
- 浏览器：WebGL， ES6

#### 示例

- 基础示例
- 交互示例
- 渲染纹理与滤镜示例
- Live2D Viewer Online

#### 文档

- 文档（暂无中文翻译）
- API 文档

Cubism

Cubism 是 Live2D SDK 的名称，目前有 3 个版本：Cubism 2.1、Cubism 3、Cubism 4，其中 Cubism 4 可以与 Cubism 3 的模型兼容

该插件使用 Cubism 2.1 和 Cubism 4，从而支持所有版本的 Live2D 模型

#### Cubism Core

在使用该插件之前，你需要加载 Cubism 运行时，也就是 Cubism Core

Cubism 4 需要加载 live2dcubismcore.min.js，可以从 Cubism 4 SDK
里解压出来，或者直接引用这个链接
（_链接偶尔会挂掉，不要在生产版本中使用！_）

Cubism 2.1 需要加载 live2d.min.js，从 2019/9/4 起
，官方已经不再提供该版本 SDK 的下载，但是可以从 这里
找到，以及你大概想要的 CDN 链接

#### 单独的打包文件

该插件为每个 Cubism 版本提供了单独的打包文件，从而在你只想使用其中一个版本的时候减少需要加载文件的大小。

具体来说，为两种版本分别提供了 cubism2.js 和 cubism4.js，以及一个同时包含了两种版本的 index.js

注意，如果你想同时支持 Cubism 2.1 和 Cubism 4 的话，请使用 index.js，_而不要同时使用_ cubism2.js 和 cubism4.js

为了更明确一点，这里列出使用这些文件的方法：

- 使用 cubism2.js+live2d.min.js 以支持 Cubism 2.1 模型
- 使用 cubism4.js+live2dcubismcore.min.js 以支持 Cubism 3 和 Cubism 4 模型
- 使用 index.js+live2d.min.js+live2dcubismcore.min.js 以支持所有版本的模型

安装

#### 通过 npm

``sh
npm install pixi-live2d-display-mulmotion
`

`js
import { Live2DModel } from 'pixi-live2d-display-mulmotion';

// 如果只需要 Cubism 2.1
import { Live2DModel } from 'pixi-live2d-display-mulmotion/cubism2';

// 如果只需要 Cubism 4
import { Live2DModel } from 'pixi-live2d-display-mulmotion/cubism4';
`

#### 通过 CDN (口型同步修改版 / 多动作播放未支持)

`html













`

通过这种方式加载的话，所有成员都会被导出到 PIXI.live2d 命名空间下，比如 PIXI.live2d.Live2DModel

基础使用

参阅此处: pixi-live2d-display-lipsync

多动作同步播放

`ts
model.parallelMotion([
{group: motion_group1, index: motion_index1, priority: MotionPriority.NORMAL},
{group: motion_group2, index: motion_index2, priority: MotionPriority.NORMAL},
]);
`

若需要同步播放表情、声音等请使用model.motion/model.speak播放其中一个动作，其余动作用model.parallelMotion播放。列表中按照index每一项都有独立的优先级控制，和model.motion`逻辑一致。

请参阅此处了解更多文档： 文档