11<h1 align =" center " >Live2d Plugin for Halo</h1 >
22<p align =" center " >
3- <a href =" https://github.com/halo-dev/halo " ><img alt =" Halo version " src =" https://img.shields.io/badge/halo-2.4 .0%2B-brightgreen?style=for-the-badge " /></a >
3+ <a href =" https://github.com/halo-dev/halo " ><img alt =" Halo version " src =" https://img.shields.io/badge/halo-2.22 .0%2B-brightgreen?style=for-the-badge " /></a >
44 <a href =" https://github.com/LIlGG/halo-theme-sakura " ><img alt =" Build Status " src =" https://img.shields.io/badge/build-positive-brightgreen?style=for-the-badge " ></a >
5- <a href =" https://github.com/prettier/prettier " ><img alt =" Code Style: Prettier " src =" https://img.shields.io/badge/release-1.1.2 -blue?style=for-the-badge " ></a >
5+ <a href =" https://github.com/prettier/prettier " ><img alt =" Code Style: Prettier " src =" https://img.shields.io/badge/release-2.0.0 -blue?style=for-the-badge " ></a >
66 <a href =" ./LICENSE " ><img alt =" LICENSE MIT " src =" https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge " ></a >
77</p >
88
2222
2323## 开发说明
2424
25- 本仓库的现代化前端位于 ` packages/live2d ` ,插件构建时会自动打包前端产物并同步到 Halo 插件静态资源目录,无需再手动复制 ` dist ` 文件。
25+ 本仓库的现代化前端位于 ` packages/live2d ` ,插件构建时会自动打包前端产物并同步到 Halo 插件静态资源目录。
26+
27+ 前端单独开发时,可以直接在仓库根目录执行:
28+
29+ ``` bash
30+ pnpm --dir packages/live2d dev
31+ ```
2632
2733本地联调时,可以在 Halo 后台开启 ` 插件设置 -> 高级设置 -> 前端调试模式 ` ,并让其指向本地 Vite 服务地址(默认 ` http://localhost:5173 ` )。这样 Halo 页面会直接加载开发中的前端模块,方便调试现代化后的 Live2d 运行时。
2834
2935## 功能介绍
3036- [x] 一只萌萌的看板娘,为网站增添一份活力
31- - [x] 基于 ` untitled-pixi-live2d-engine ` 渲染, 支持 Cubism 2 / 3 / 4 / 5 模型
37+ - [x] 支持 Cubism 2 / 3 / 4 / 5 模型
3238- [x] 基于 OpenAi 的对话交互功能【会思考的萌娘】
3339- [x] 一键换装、换肤
3440- [x] 支持一言功能
3541- [x] 小飞机游戏(把坏人全都打跑!)
3642- [x] 自定义看板娘接口
3743- [x] 支持外部自定义 TIPS 文件,更适合你的网站
44+ - [x] 支持自定义工具栏
3845
3946## 自定义配置
4047> 此部分内容建议初步尝试过 Live2d 的用户观看。
4552之后修改 ` 插件配置 -> 基本设置 -> Live2d 模型地址 ` 即可。
4653
4754### 自定义 TIPS 文件
48- [ TIPS文件 ] ( /src/main/resources/static /live2d-tips.json ) 文件是一个 JSON 文件,其内容为 Live2d 消息框对用户各种事件的反馈。
55+ 默认 [ TIPS 文件 ] ( /packages/live2d/src/libs /live2d-tips.json ) 是一个 JSON 文件,其内容为 Live2d 消息框对用户各种事件的反馈。
4956例如当用户鼠标点击网页中的某个链接时,Live2d 的消息框就会呈现出各种各样的文本。而这个绑定事件就是通过 TIPS 文件来处理的。
5057
5158因此可以说,** TIPS 文件与所用主题强绑定甚至需要用户高度自定义。**
@@ -88,7 +95,7 @@ TIPS 文件格式
8895由于 Live2d 的 TIPS 通常需要使用 css 选择器来进行鼠标定位,因此将 TIPS 文件交由主题来适配是最好的方式。
8996
90971 . 主题开发者可以参考 [ 主题 TIPS 文件] ( /assert/live2d/tips.json ) 文件来编写适配自己主题的 TIPS 文件。
91- 2 . 将 json 文件命名为 ` tips.json ` 并放置在主题静态目录 ` /assert /live2d/` 目录下
98+ 2 . 将 json 文件命名为 ` tips.json ` 并放置在主题静态目录 ` assets /live2d/` 目录下
9299
93100live2d 渲染页面时将自动读取当前启用主题下的文件。
94101
@@ -105,19 +112,19 @@ live2d 渲染页面时将自动读取当前启用主题下的文件。
105112#### 3. 全量自定义 TIPS 文件
106113当用户想完全自定义 TIPS 文件或者上述两种方式不满足用户的需求,例如想更改 ` seasons, time, message ` 属性时,可以采用此种方式。
107114
108- 1 . 用户可以参照 [ 默认 TIPS 文件] ( /src/main/resources/static /live2d-tips.json ) 或者按照 [ 自定义TIPS文件] ( #自定义-tips-文件 ) 中的 TIPS 文件格式来编写 TIPS 文件。
115+ 1 . 用户可以参照 [ 默认 TIPS 文件] ( /packages/live2d/src/libs /live2d-tips.json ) 或者按照 [ 自定义TIPS文件] ( #自定义-tips-文件 ) 中的 TIPS 文件格式来编写 TIPS 文件。
1091162 . 使用 Halo 后台 ` 插件设置 -> 事件及提示语绑定 -> 自定义提示语文件 ` ,更改对应的文件即可。
110117
111118> 小提示: 可以将文件上传到 Halo 附件内,再进行选择!
112119
113120![ img.png] ( assert/img.png )
114121
115- ** 需要特别注意的是,一旦用户指定了此 TIPS 文件,那么默认的 TIPS 文件将不再生效(除非当前文件加载失败,此时会回退使用默认的 TIPS 文件) ,因此建议自定义时将属性设置完整**
122+ ** 需要特别注意的是,一旦用户指定了此 TIPS 文件,运行时会优先将其作为完整 TIPS 文件加载;只有在文件缺失、格式不合法或加载失败时,才会回退到内置默认 TIPS,因此建议自定义时将属性设置完整**
116123
117124### 自定义工具
118125如果内置工具不满足需求,可以通过 Halo 后台 ` 插件设置 -> 自定义工具 ` 声明额外工具按钮。
119126
120- 当前自定义工具使用声明式动作,不支持注入任意 JavaScript 。首批支持的动作包括:
127+ 当前自定义工具使用声明式动作。首批支持的动作包括:
121128
122129- 发送提示语
123130- 显示、隐藏或切换看板娘
@@ -128,23 +135,14 @@ live2d 渲染页面时将自动读取当前启用主题下的文件。
128135- 触发命名空间自定义事件
129136- 加载指定模型
130137
131- 这种方式更适合在保证安全边界的前提下扩展 Live2d 能力。
132-
133138## 鸣谢
134- - 本插件代码借鉴了 [ live2d-widget] ( https://github.com/stevenjoezhang/live2d-widget ) 的理念及代码并完全重写 JS
139+ - 本插件代码借鉴了 [ live2d-widget] ( https://github.com/stevenjoezhang/live2d-widget ) 的理念并完全重写
135140- 使用了 [ hitokoto] ( https://hitokoto.cn/ ) 的一言接口
136141- 默认使用了 [ ZSQIM] ( https://zsq.im/ ) 的 live2d 接口
142+ - 使用了 [ untitled-pixi-live2d-engine] ( https://github.com/untitled-ai/untitled-pixi-live2d-engine ) 的 Live2d 渲染引擎,用于支持 Cubism 2 / 3 / 4 / 5 模型
137143- 纸飞机小游戏源自于 [ WebsiteAsteroids] ( http://www.websiteasteroids.com/ )
138144- Live2d 官方地址 [ https://live2d.github.io ] ( https://live2d.github.io )
139145
140- ## 赞助
141- > 如果您喜欢我的插件,可以考虑资助一下~ 您的支持将是我继续进行开源的动力。
142-
143- | <img src =" https://cdn.lixingyong.com/img/other/%E5%BE%AE%E4%BF%A1%E5%9B%BE%E7%89%87_20210114094011.jpg " width =" 160px; " /><br /><b >微信</b ><br /> | <img src =" https://v-lxy-cdn.oss-cn-beijing.aliyuncs.com/img/other/%E6%94%AF%E4%BB%98%E5%AE%9D.png " width =" 160px; " /><br /><b >支付宝</b ><br /> |
144- | :---: | :---: |
145-
146- 欢迎其他各种形式的捐助!
147-
148146## 许可证
149147** plugin-live2d** © [ LIlGG] ( https://github.com/LIlGG ) ,基于 [ MIT] ( ./LICENSE ) 许可证发行。<br >
150148
0 commit comments