# live2D
**Repository Path**: Codeeor/live2D
## Basic Information
- **Project Name**: live2D
- **Description**: 来定制一个自己专属的live2D看板娘吧(๑•̀ㅂ•́)و
- **Primary Language**: HTML
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 12
- **Forks**: 1
- **Created**: 2019-07-10
- **Last Updated**: 2024-12-16
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# fguby-live2D
一个配置并不复杂，功能一直在完善的插件，如果各位喜欢，请给我一颗star吧，感激不尽
### φ(≧ω≦*)♪
> 基于官方2.1.0版本的Api开发。
#### 支持功能如下：
- ✅ - 多模型装载
- ✅ - 自定义事件行为
- ✅ - 姐妹花
- ✅ - 快速换衣（顺序or随机)
- ✅ - 滚轮放大缩小
- ✅ - 自定义模型初始化尺寸
- ✅ - 音频播放的自主设定
> 更多示例正在开发，第一次加载可能会有些慢，见谅~
> 还想要更多吗？请点击
[二次元传送门](https://www.live2d.com/ja/ "live2D")
简单的几个页面示例
一 [二次元姐妹花](http://www.midoriya.co:8088/static/sisters.html "live2D")
一 [干物妹小埋：お兄ちゃん](http://www.midoriya.co:8088/static/xiaomai.html "live2D")
一 [多模型装载，点击按钮可切换](http://www.midoriya.co:8088/static/live2D.html "live2D")
一 [药水制作师：快速换装小萝莉](http://www.midoriya.co:8088/static/pio.html "live2D")
一 [路人女主养成方法：加藤惠](http://www.midoriya.co:8088/static/katou.html "live2D")
一 [从零开始的异世界生活：蕾姆](http://www.midoriya.co:8088/static/rem.html "live2D")
一 [NEW GAME! 凉风青叶](http://www.midoriya.co:8088/static/liang.html "live2D")
一 [情色漫画老师：和泉纱雾](http://www.midoriya.co:8088/static/sagiri.html "live2D")
> 有的页面加载较快，是因为png图片已经压缩过。
### mac应用里的示例图
#### 一 [Elf小精灵传送门](https://github.com/fguby/Elf "Elf")
---
### 快速开始
🅰️ 直接使用git命令下载。
```
git clone https://github.com/fguby/live2D.git
```
🅱️直接下载压缩包，然后解压。
### 页面引用
1️⃣引入配置文件,例如
```html
```
2️⃣引入核心依赖文件。
```html
```
3️⃣html页面放置对应的canvas，例如这样：
```html
```
如果要使用音频播放，页面还需要放置一个audio
```html
```
4️⃣调用初始化的函数,例如：
```html
```
> ~~模型出不来？~~
> YES.😑
设置成debug模式，打开浏览器的console ，或者，请看看自己具体项目里的路径，然后进行修改？
---
#### (๑•̀ㅂ•́)و✧
#### 配置文件LAppDefine.js详解
属性 | 值/含义
---|---
DEBUG_LOG | true/false。是否在console里打印日志。
CANVAS_ID | 页面canvas元素的id值。
IS_SCROLL_SCALE | 是否开启滚轮缩放
VIEW_MAX_SCALE | 画面最大缩放级别
VIEW_MIN_SCALE | 画面最小缩放级别
IS_BIND_BUTTON | 是否绑定切换模型按钮
BUTTON_ID | 绑定按钮的id值，确认绑定时此值才有效。
IS_BAN_BUTTON | 是否开启模型加载过程间的按钮禁用功能。
BAN_BUTTON_CLASS | 按钮禁止状态时的class值，可自定义样式
NORMAL_BUTTON_CLASS | 按钮恢复正常时的class值
TEXURE_CHANGE_MODE | 衣服切换模式，random-随机，sequence-顺序
TEXURE_BUTTON_ID | 换衣绑定的元素id属性，目前仅支持点击触发
一个完整的LAppDefine.js里最重要的属性：
```
MODELS:
[
["model/haru/haru.model.json"],
["model/xiaomai/xiaomai.model.json"],
["model/wanko/wanko.model.json"],
["model/shizuku/shizuku.model.json"],
["model/haru/haru_01.model.json","model/haru/haru_02.model.json"],
["model/Epsilon2.1/Epsilon2.1.model.json"],
["model/Pio/model.json"]
],
```
> MODELS负责模型json文件的统一配置，如果想要配置自己的多个模型，只需要在这里进行添加即可。（单模型只需添加一个就好)
❗这里的路径请使用相对路径配置，具体根据对应的实际情况自行配置。
---
> #### 如何同时加载两个模型？
```javascript
//写法如下
MODELS:
[
[模型1的路径，模型2的路径]
]
```
###### MODELS里的每一个数组成员即使配置超出两个的模型，也只会取前两个，另外双模型的加载现在暂不支持换衣功能。
> 除此之外，或许还需要略微修改model.json文件，参考如何修改模型在canvas元素里显示的位置。
[传送门(＠_＠;)](#this)
> #### 如何配置以及开启换衣功能？
```javascript
//具体配置如下
//1.
IS_START_TEXURE_CHANGE : true,
//2.
TEXURE_CHANGE_MODE : "sequence",
//3.
TEXURE_BUTTON_ID : "button_id",
```
###### 如上，1开启换衣功能的选项，2设置换衣的模式，sequence-顺序，random-随机，3则是设置页面上换衣按钮的id值。
> ##### **在进行这些设置之前，你还需要确保的是：**
> > 页面按钮元素的放置。
>
> > 模型json文件的处理。
>
> > 确保模型已经顺利加载出现。
###### 关于模型json文件的配置，这里以药水制作师的model.json文件举例。
```
"textures":[
"textures/pajamas-costume.png",
"textures/Animal Costume Racoon.png",
"textures/Akiba Idol Costume.png",
"textures/Goddess Costume Pink.png"
],
```
将需要更换的png图片全都配置在这里，数组的顺序默认就是顺序更换时的顺序。
> 另外需要注意，有些模型虽然配置了多个textures元素，但是是用数张图片配置一个模型，这类的模型目前不支持换衣功能。
---
> #### 如何自定义表情、动作？
一 [干物妹小埋：お兄ちゃん](http://www.midoriya.co:8088/static/xiaomai.html "live2D")
> 想要在对应事件里驱动模型产生对应动作以及表情可以点击上方链接参考，我在页面上放置了三个按钮，分别对应着小埋哭、拿可乐、拿薯片的动作和表情。
写法很简单，只需要调用LAppModel的startAppointMotion函数即可。
例如：
```javascript
var model = new LAppModel();
model.startAppointMotion("start",3,10);
```
参数详解 ⬇️
#### (1)“start”，这个参数为动作组。
查看model.json文件时，motions字段里会有类似以下的写法出现:
```
"idle":[
{"file":"mtn/I_SURPRISE_W.mtn"},
{"file":"mtn/I_SURPRISE_W.mtn"},
......
]
```
> 这个“idle”所代表的就是一系列动作的数组,使用live2D官方的live 2D Viewer可以很方便的查看每个mtn文件所代表的动作是什么。
一 [live2D viewer传送门](http://www.midoriya.co:8088/static/xiaomai.html "live2D")
另外，我所默认的空闲状态的模型表情以及动作的切换都是在idle动作组里随机触发。
如果你想在这个基础上修改，也很简单。
> 1⃣ 修改LAppDefine里的MOTION_GROUP_IDLE的值，将它设置为你想要触发的动作组。
>
> 2⃣修改具体model.json文件里的motions字段属性，将你喜欢的动作分成一组，然后设置为1⃣**里的名称**。
#### (2) 第二个参数3 ，动作的优先级程度。
LAppDefin里设定了四个动作的优先级常量，如下:
```
// 动作优先级常量
PRIORITY_NONE : 0,
PRIORITY_IDLE : 1,
PRIORITY_NORMAL : 2,
PRIORITY_FORCE : 3,
```
3代表优先级最高的动作。
如果你想在页面上某类事件发生后设定一个必定立即触发的动作，可以使用PRIORITY_FORCE来触发动作。
#### （3）第三个参数10，代表动作组里的第(10 + 1)个动作，数组从0开始。
如果你想触发动作组里的某个指定动作，可以传递该参数。如果忽略该参数，则默认从动作组里随机选取动作。
例如：
```javascript
"start":
[
{"file":"mtn/I_ANGRY.mtn"},
{"file":"mtn/I_ANGRY_S.mtn"},
{"file":"mtn/I_ANGRY_W.mtn"},
{"file":"mtn/I_FUN.mtn"},
{"file":"mtn/I_FUN_S.mtn"},
{"file":"mtn/I_FUN_W.mtn"}
]
```
如果我想立即触发start动作组里的I_ANGRY_S.mtn这个动作。
```javascript
model.startAppointMotion("start",3,1);
```
---
> 基于以上的自由开发：
>
> - 定制各种事件，触发模型的动作以及表情。
>
(以小埋的动作举例)
>
> - 在深夜时间触发黑眼圈这个动作，自定义提醒的提示信息。
> - 在周六日可以提高可乐、薯片动作的优先级，设定为经常触发。
> - 空闲时间太久可以手动触发哭泣表情，在这基础上可以开发与评论、聊天等系统连接的事件。
> - 等等等。
---
### 常见问题
> #### 如何配置模型初始化时的大小？
修改LAppDefine.js文件里的SCALE属性即可。(可关闭滚轮事件。)
> #### 如何修改模型在canvas元素里显示的位置？
手动修改model.json layout属性里的center_x属性即可。
如果要设置双模型，可以将一个模型的center_x设为0.5，另外一个设置为-0.5，这样可以避免重叠。
> #### 如何给模型自配置一些声音？
可以把自己想要播放的声音文件放置到对应model的文件夹里，在model.json文件里的motion属性中，将想要播放声音的动作配置上对应的声音文件路径即可，例如：
```
{ "file":"motions/tapBody_00.mtn" , "sound":"sounds/tapBody_00.mp3"},
```
> #### 关于音频播放的问题。
修复了之前在微信以及手机浏览器上声音播放不出来的问题，git 一份最新版本的代码应该就没问题了，另外LAppDefine.js配置文件里我新增了两个字段，是和音频配套使用的。(注意，请参考页面引用里提到的步骤，页面手动放置一个audio元素。)
```javascript
IS_PLAY_AUDIO : true, //新增属性，是否播放音频 默认为true
AUDIO_ID : "my_audio" //新增属性，audio标签id值
```
#### 未完待续。。。
---
### 关于模型文件
我内置了几套模型，包括官方给的几个免费版模型，干物妹小埋，药水制作师小萝莉(配备119套衣服)，目前正在配置路人女主养成方法圣女惠的模型，剩下的还有一些，我整理后会在近期上传，敬请期待。
一 [猫与向日葵](https://imjad.cn/archives/lab/add-dynamic-poster-girl-with-live2d-to-your-blog-01 "猫与向日葵")
一 [一个不错的模型分享网站，梦象](https://mx-model.ga/page/1/ "梦象")
### 后续准备开发的内容
#### 1.人物弹出消息，或者试试智能聊天？💚
一 [来吧，传送门](https://github.com/fguby/live2D/blob/master/README-MESSAGE.md "message")
#### 2.优化模型加载速度。
~~嗯，看了一下，主要是图片加载速度太慢，回头我抽时间优化一下。~~
图片压缩可以有效解决这个问题。（需要你手动完成。）
#### 3.实现可拖拽。
这个功能目前还没有特别大的开发欲望。
#### 4.开发一个简单页面，方便查看模型具体每个mtn动作文件的样式。
这个还在考虑中，实现起来虽然不难，主要是懒癌症犯了。。。
#### 5.优化手机浏览器查看的效果。(主要是手机浏览器上似乎没有声音？)
这个问题已解决，重新git一份代码，按照音频步骤配置一下即可，具体请往上翻。
#### 6.提供一个默认的css样式文件。(方便那些比较懒的同学们。)
......
> ##### 👅如果有什么建议，可以留言给我。我会在闲暇时间里争取快速开发完剩下的功能，让这个初具雏形的插件变得完善起来。
> 欢迎fork以及pull request
>
> 跪求✨⭐🌟💫💥💥
>
> (°ー°〃)