Skip to content

Commit c0ada53

Browse files
Update README
Update LICENSE
1 parent cf333ed commit c0ada53

File tree

3 files changed

+56
-43
lines changed

3 files changed

+56
-43
lines changed

README.en.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
# Live2D Widget
22

33
![](https://forthebadge.com/images/badges/built-with-love.svg)
4-
![](https://forthebadge.com/images/badges/uses-html.svg)
5-
![](https://forthebadge.com/images/badges/made-with-javascript.svg)
4+
![](https://forthebadge.com/images/badges/made-with-typescript.svg)
5+
![](https://forthebadge.com/images/badges/uses-css.svg)
66
![](https://forthebadge.com/images/badges/contains-cat-gifs.svg)
7-
![](https://forthebadge.com/images/badges/powered-by-electricity.svg)
7+
![](https://forthebadge.com/images/badges/powered-by-responsibility.svg)
88
![](https://forthebadge.com/images/badges/makes-people-smile.svg)
99

1010
[中文](README.md)
1111

1212
## Features
1313

14-
Add Live2D widget to web page. Compatible with PJAX.
14+
- Add Live2D widget to web page
15+
- Lightweight, with no runtime dependencies other than Live2D Cubism Core
16+
- Core code is written in TypeScript, making it easy to integrate
1517

1618
<img src="demo/screenshots/screenshot-2.png" width="280"><img src="demo/screenshots/screenshot-3.png" width="280"><img src="demo/screenshots/screenshot-1.png" width="270">
1719

@@ -39,7 +41,7 @@ If you are interested in customizing the widget, please refer to the detailed in
3941

4042
## Configuration
4143

42-
You can refer to the source code of `dist/autoload.js` to see the available configuration options. `autoload.js` will automatically load three files: `waifu.css`, `live2d.min.js`, and `waifu-tips.js`. `waifu-tips.js` creates the `initWidget` function, which is the main function for loading the widget. The `initWidget` function accepts an object-type parameter as the configuration for the widget. The following are the available options:
44+
You can refer to the source code of `dist/autoload.js` to see the available configuration options. `autoload.js` will automatically load two files: `waifu.css` and `waifu-tips.js`. `waifu-tips.js` creates the `initWidget` function, which is the main function for loading the widget. The `initWidget` function accepts an object-type parameter as the configuration for the widget. The following are the available options:
4345

4446
| Option | Type | Default Value | Description |
4547
| ------ | ---- | ------------- | ----------- |
@@ -150,25 +152,26 @@ This will load the widget.
150152

151153
> Thanks to jsDelivr for providing public CDN service.
152154
153-
The code is modified based on this blog post:
154-
https://www.fghrsh.net/post/123.html
155+
Thanks fghrsh for providing API service.
155156

156157
Thanks to [Hitokoto](https://hitokoto.cn) for providing the sentence API.
157158

158159
When you click on the paper airplane button of the virtual assistant, a hidden surprise will appear. This feature is from [WebsiteAsteroids](http://www.websiteasteroids.com).
159160

160161
## More
161162

163+
The code is modified based on this blog post:
164+
https://www.fghrsh.net/post/123.html
165+
162166
For more information, you can refer to the following links:
163167
https://nocilol.me/archives/lab/add-dynamic-poster-girl-with-live2d-to-your-blog-02
164-
https://github.com/xiazeyu/live2d-widget.js
165-
https://github.com/summerscar/live2dDemo
168+
https://github.com/guansss/pixi-live2d-display
166169

167-
Regarding the backend API models:
168-
https://github.com/xiazeyu/live2d-widget-models
169-
https://github.com/xiaoski/live2d_models_collection
170+
For more models:
171+
https://github.com/zenghongtu/live2d-model-assets
170172

171173
In addition to that, there are desktop versions available:
174+
https://github.com/TSKI433/hime-display
172175
https://github.com/amorist/platelet
173176
https://github.com/akiroz/Live2D-Widget
174177
https://github.com/zenghongtu/PPet
@@ -177,26 +180,27 @@ https://github.com/LikeNeko/L2dPetForMac
177180
And also Wallpaper Engine:
178181
https://github.com/guansss/nep-live2d
179182

183+
Official Live2D websites:
184+
https://www.live2d.com/en/
185+
180186
## License
181187

182-
Released under the GNU General Public License v3
188+
This repository does not contain any models. The copyrights of all Live2D models, images, and motion data used for demonstration purposes belong to their respective original authors. They are provided for research and learning purposes only and should not be used for commercial purposes.
189+
190+
The code in this repository (excluding parts covered by the Cubism Live2D Proprietary Software License and the Live2D Open Software License) is released under the GNU General Public License v3
183191
http://www.gnu.org/licenses/gpl-3.0.html
184192

185-
This repository does not contain any models. The copyrights of all Live2D models, images, and motion data used for demonstration purposes belong to their respective original authors. They are provided for research and learning purposes only and should not be used for commercial purposes.
193+
Please comply with the relevant licenses when using any Live2D-related code:
186194

187-
Official Live2D websites:
188-
https://www.live2d.com/en/
189-
https://live2d.github.io
195+
License for Live2D Cubism SDK 2.1:
196+
[Live2D SDK License Agreement (Public)](https://docs.google.com/document/d/10tz1WrycskzGGBOhrAfGiTSsgmyFy8D9yHx9r_PsN8I/)
190197

198+
License for Live2D Cubism SDK 5:
191199
Live2D Cubism Core is provided under the Live2D Proprietary Software License.
192200
https://www.live2d.com/eula/live2d-proprietary-software-license-agreement_en.html
193201
Live2D Cubism Components are provided under the Live2D Open Software License.
194202
http://www.live2d.com/eula/live2d-open-software-license-agreement_en.html
195203

196-
> The terms and conditions do prohibit modification, but obfuscating in `live2d.min.js` would not be considered illegal modification.
197-
198-
https://community.live2d.com/discussion/140/webgl-developer-licence-and-javascript-question
199-
200204
## Update Log
201205

202206
Starting from January 1, 2020, this project no longer depends on jQuery.

README.md

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
# Live2D Widget
22

33
![](https://forthebadge.com/images/badges/built-with-love.svg)
4-
![](https://forthebadge.com/images/badges/uses-html.svg)
5-
![](https://forthebadge.com/images/badges/made-with-javascript.svg)
4+
![](https://forthebadge.com/images/badges/made-with-typescript.svg)
5+
![](https://forthebadge.com/images/badges/uses-css.svg)
66
![](https://forthebadge.com/images/badges/contains-cat-gifs.svg)
7-
![](https://forthebadge.com/images/badges/powered-by-electricity.svg)
7+
![](https://forthebadge.com/images/badges/powered-by-responsibility.svg)
88
![](https://forthebadge.com/images/badges/makes-people-smile.svg)
99

1010
[English](README.en.md)
1111

1212
## 特性
1313

14-
在网页中添加 Live2D 看板娘。兼容 PJAX,支持无刷新加载。
14+
- 在网页中添加 Live2D 看板娘
15+
- 轻量级,除 Live2D Cubism Core 外无其他运行时依赖
16+
- 核心代码由 TypeScript 编写,易于集成
1517

1618
<img src="demo/screenshots/screenshot-2.png" width="280"><img src="demo/screenshots/screenshot-3.png" width="280"><img src="demo/screenshots/screenshot-1.png" width="270">
1719

@@ -39,7 +41,7 @@
3941

4042
## 配置
4143

42-
你可以对照 `dist/autoload.js` 的源码查看可选的配置项目。`autoload.js` 会自动加载三个文件`waifu.css``live2d.min.js``waifu-tips.js``waifu-tips.js` 会创建 `initWidget` 函数,这就是加载看板娘的主函数。`initWidget` 函数接收一个 Object 类型的参数,作为看板娘的配置。以下是配置选项:
44+
你可以对照 `dist/autoload.js` 的源码查看可选的配置项目。`autoload.js` 会自动加载两个文件`waifu.css``waifu-tips.js``waifu-tips.js` 会创建 `initWidget` 函数,这就是加载看板娘的主函数。`initWidget` 函数接收一个 Object 类型的参数,作为看板娘的配置。以下是配置选项:
4345

4446
| 选项 | 类型 | 默认值 | 说明 |
4547
| - | - | - | - |
@@ -152,25 +154,26 @@ https://example.com/path/to/live2d-widget/dist/
152154
> 感谢 jsDelivr 提供的 CDN 服务。
153155
> Thanks jsDelivr for providing public CDN service.
154156
155-
代码自这篇博文魔改而来:
156-
https://www.fghrsh.net/post/123.html
157+
感谢 fghrsh 提供的 API 服务。
157158

158159
感谢 [一言](https://hitokoto.cn) 提供的语句接口。
159160

160161
点击看板娘的纸飞机按钮时,会出现一个彩蛋,这来自于 [WebsiteAsteroids](http://www.websiteasteroids.com)
161162

162163
## 更多
163164

165+
代码自这篇博文魔改而来:
166+
https://www.fghrsh.net/post/123.html
167+
164168
更多内容可以参考:
165169
https://nocilol.me/archives/lab/add-dynamic-poster-girl-with-live2d-to-your-blog-02
166-
https://github.com/xiazeyu/live2d-widget.js
167-
https://github.com/summerscar/live2dDemo
170+
https://github.com/guansss/pixi-live2d-display
168171

169-
关于后端 API 模型:
170-
https://github.com/xiazeyu/live2d-widget-models
171-
https://github.com/xiaoski/live2d_models_collection
172+
更多模型仓库:
173+
https://github.com/zenghongtu/live2d-model-assets
172174

173175
除此之外,还有桌面版本:
176+
https://github.com/TSKI433/hime-display
174177
https://github.com/amorist/platelet
175178
https://github.com/akiroz/Live2D-Widget
176179
https://github.com/zenghongtu/PPet
@@ -179,26 +182,27 @@ https://github.com/LikeNeko/L2dPetForMac
179182
以及 Wallpaper Engine:
180183
https://github.com/guansss/nep-live2d
181184

185+
Live2D 官方网站:
186+
https://www.live2d.com/en/
187+
182188
## 许可证
183189

184-
Released under the GNU General Public License v3
190+
本仓库并不包含任何模型,用作展示的所有 Live2D 模型、图片、动作数据等版权均属于其原作者,仅供研究学习,不得用于商业用途。
191+
192+
本仓库的代码(不包括受 Cubism Live2D Proprietary Software License 和 Live2D Open Software License 约束的部分)基于 GNU General Public License v3 协议开源
185193
http://www.gnu.org/licenses/gpl-3.0.html
186194

187-
本仓库并不包含任何模型,用作展示的所有 Live2D 模型、图片、动作数据等版权均属于其原作者,仅供研究学习,不得用于商业用途。
195+
Live2D 相关代码的使用请遵守对应的许可:
188196

189-
Live2D 官方网站:
190-
https://www.live2d.com/en/
191-
https://live2d.github.io
197+
Live2D Cubism SDK 2.1 的许可证:
198+
[Live2D SDK License Agreement (Public)](https://docs.google.com/document/d/10tz1WrycskzGGBOhrAfGiTSsgmyFy8D9yHx9r_PsN8I/)
192199

200+
Live2D Cubism SDK 5 的许可证:
193201
Live2D Cubism Core は Live2D Proprietary Software License で提供しています。
194202
https://www.live2d.com/eula/live2d-proprietary-software-license-agreement_en.html
195203
Live2D Cubism Components は Live2D Open Software License で提供しています。
196204
http://www.live2d.com/eula/live2d-open-software-license-agreement_en.html
197205

198-
> The terms and conditions do prohibit modification, but obfuscating in `live2d.min.js` would not be considered illegal modification.
199-
200-
https://community.live2d.com/discussion/140/webgl-developer-licence-and-javascript-question
201-
202206
## 更新日志
203207

204208
2020年1月1日起,本项目不再依赖于 jQuery。

dist/live2d.min.js

Lines changed: 6 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)