Skip to content
This repository was archived by the owner on Jan 27, 2021. It is now read-only.

Commit b9b5f50

Browse files
committed
docs: update README
1 parent f77edf8 commit b9b5f50

File tree

1 file changed

+34
-36
lines changed

1 file changed

+34
-36
lines changed

README.md

Lines changed: 34 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@
2323

2424
Add the Sseexxyyy live2d to your hexo!
2525

26-
New web Demo and code generator: [https://eyhn.in/hexo-helper-live2d/](https://eyhn.in/hexo-helper-live2d/)
26+
Demo: [https://eyhn.in/hexo-helper-live2d/](https://xiazeyu.github.io/live2d-widget.js-doc/dev.html)
2727

28-
Author's Demo: [https://huaji8.top/post/live2d-plugin-2.0/](https://huaji8.top/post/live2d-plugin-2.0/)
28+
Author's Blog: [https://huaji8.top/post/live2d-plugin-2.0/](https://huaji8.top/post/live2d-plugin-2.0/)
2929

3030

3131
## Installation
@@ -38,38 +38,15 @@ Install module:
3838
npm install --save hexo-helper-live2d
3939
```
4040

41-
<details><summary>Come across npm problem ?</summary><br>
42-
43-
> Try to use `npm cache verify` or `npm cache clean` to fix it.
44-
45-
</details>
46-
4741
<details><summary>Used legacy version before ?</summary><br>
4842

4943
Please delete `{{ live2d() }}` or `<%- live2d() %>` before `</body>` in `layout/layout.ejs` or `layout/_layout.swig`.
5044

5145
</details>
5246

53-
### Webpack
54-
55-
<details><summary>Only when you want to do some further developement or advanced useage.</summary><br>
56-
57-
Install module:
58-
59-
```
60-
npm install --save hexo-helper-live2d
61-
```
62-
63-
Import module:
64-
65-
```
66-
import loadlive2d from 'hexo-helper-live2d';
67-
68-
// TBD.
69-
```
70-
71-
</details>
47+
### Others, including webpack
7248

49+
See [live2d-widget.js](https://github.com/xiazeyu/live2d-widget.js)
7350

7451
## Config
7552

@@ -92,10 +69,10 @@ live2d:
9269
enable: true
9370
jsPath: local # 'local'||'jsdelivr'||'unpkg'||{Your own path, String}
9471
model:
95-
use: live2d-widget-model-miku
72+
use: live2d-widget-model-miku # {npm-module name}||{folder name in live2d_models/}||{Your own path, String}
9673
```
9774
98-
> To use settings in Chinese, please have a look at [Chinese document](./README.zh-CN.md).
75+
> To see Chinese explainations, please have a look at [Chinese document](./README.zh-CN.md).
9976
10077
<details><summary>Current supported models:</summary><br>
10178
@@ -125,6 +102,7 @@ live2d:
125102

126103
## Custom model
127104

105+
### a. live2d_models folder
128106
1. Create a `live2d_models` folder at your blog's root directory.
129107

130108
2. Create a folder by the name of your model.
@@ -145,7 +123,9 @@ Up to now, there should be `mymiku.model.json` in the directory of `/live2d_mode
145123

146124
</details>
147125

148-
<br>~The problem was once releated to [(#22)](https://github.com/EYHN/hexo-helper-live2d/issues/22).~
126+
### b. npm modules
127+
128+
Release your package named like `live2d-widget-model-xxx`, and type it into `model.use` in `_config.yml`
149129

150130
<br>
151131

@@ -266,6 +246,8 @@ issues: [https://github.com/EYHN/hexo-helper-live2d/issues](https://github.com/E
266246

267247
## Releated projects
268248

249+
- [live2d-widget.js](https://github.com/xiazeyu/live2d-widget.js)
250+
269251
- [Cubism SDK WebGL 2.1](http://sites.cybernoids.jp/cubism-sdk2_e/webgl2-1)
270252

271253
- [pixi-live2d](https://github.com/avgjs/pixi-live2d)
@@ -277,9 +259,16 @@ issues: [https://github.com/EYHN/hexo-helper-live2d/issues](https://github.com/E
277259

278260
[![Author][author]][author-url]
279261

280-
[![QQ][qq]][qq-url]
262+
[![Author QQ][author-qq]][author-qq-url]
263+
264+
[![Author Email][author-email]][author-email-url]
281265

282-
[![Email][email]][email-url]
266+
267+
[![Collaborator 0][collaborator0]][collaborator0-url]
268+
269+
[![Collaborator 0 QQ][collaborator0-qq]][collaborator0-qq-url]
270+
271+
[![Collaborator 0 Email][collaborator0-email]][collaborator0-email-url]
283272

284273

285274
## Imported
@@ -326,11 +315,20 @@ Open sourced under the GPL v2.0 license.
326315
[author]: https://img.shields.io/badge/author-cneyhn-green.svg
327316
[author-url]: https://delusion.coding.me/
328317

329-
[qq]: https://img.shields.io/badge/QQ-1106996185-blue.svg
330-
[qq-url]: http://wpa.qq.com/msgrd?v=3&uin=&site=qq&menu=yes
318+
[author-qq]: https://img.shields.io/badge/QQ-1106996185-blue.svg
319+
[author-qq-url]: tencent://message/?uin=1106996185&Site=Senlon.Net&Menu=yes
320+
321+
[author-email]: https://img.shields.io/badge/Emali%20me-cneyhn@gmail.com-green.svg
322+
[author-email-url]: mailto:cneyhn@gmail.com
323+
324+
[collaborator0]: https://img.shields.io/badge/collaborator-xiazeyu-green.svg
325+
[collaborator0-url]: https://xiazeyu.coding.me/
326+
327+
[collaborator0-qq]: https://img.shields.io/badge/QQ-2320732807-blue.svg
328+
[collaborator0-qq-url]: tencent://message/?uin=2320732807&Site=Senlon.Net&Menu=yes
331329

332-
[email]: https://img.shields.io/badge/Emali%20me-cneyhn@gmail.com-green.svg
333-
[email-url]: mailto:cneyhn@gmail.com
330+
[collaborator0-email]: https://img.shields.io/badge/Emali%20me-xiazeyu_2011@126.com-green.svg
331+
[collaborator0-email-url]: mailto:xiazeyu_2011@126.com
334332

335333
[current-device]: https://img.shields.io/npm/v/current-device.svg?label=current-device
336334
[current-device-url]: https://github.com/matthewhudson/current-device

0 commit comments

Comments
 (0)