Skip to content
This repository was archived by the owner on Feb 13, 2024. It is now read-only.

Commit 1b43dc0

Browse files
committed
docs(method of execute): finish the doc of launch it (use var)
1 parent 7401ffe commit 1b43dc0

File tree

9 files changed

+69
-48
lines changed

9 files changed

+69
-48
lines changed

README.md

Lines changed: 63 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,7 @@
1616

1717
# live2d-widget.js
1818

19-
Add the Sseexxyyy live2d to your webpages!
20-
21-
[TOC]
19+
Add the Sseexxyyy live2d to your webpages! Seperated from [hexo-helper-live2d](https://github.com/EYHN/hexo-helper-live2d).
2220

2321
Demo: [Still working, but you can have a look~](https://xiazeyu.github.io/live2d-widget.js/dev.html)
2422

@@ -33,19 +31,24 @@ Online generator: [TBD.](javascript:void(0);)
3331

3432
Please visit [hexo-helper-live2d](https://github.com/EYHN/hexo-helper-live2d) for the hexo plugin.
3533

36-
### Webpack
34+
### Webpages
3735

38-
Install the module:
36+
#### File on your server
3937

40-
```
41-
npm install --save live2d-widget.js
42-
```
38+
Download the [latest release](https://github.com/xiazeyu/live2d-widget.js/releases),
4339

44-
Import the module:
40+
and then copy and extract the `lib` folder to your website.
41+
42+
Use [online generator](javascript:void(0);) **(recommended)** to generate codes.
43+
44+
<details><summary>However, if you want to do it manually, follow the instruction below:</summary><br>
45+
46+
import the js:
47+
48+
```html
49+
50+
<script src = "( your script path here )"></script>
4551

46-
```js
47-
// using as es modules
48-
import 'live2d-widget.js';
4952
```
5053

5154
Then call the function along with your config.
@@ -57,15 +60,18 @@ L2Dwidget.init({
5760
});
5861
```
5962

60-
### Online
63+
</details>
6164

62-
https://github.com/jsdelivr/jsdelivr/
65+
### Bookmark (any pages)
6366

6467
TBD.
6568

69+
https://www.cnblogs.com/pcyy/p/5655542.html
70+
71+
6672
## Settings
6773

68-
See src/SettingTip.txt
74+
See the document.
6975

7076
<details><summary>Current supported models:</summary><br>
7177

@@ -138,22 +144,30 @@ issues: [https://github.com/EYHN/hexo-helper-live2d/issues](https://github.com/E
138144

139145
- [Cubism SDK WebGL 2.1](http://sites.cybernoids.jp/cubism-sdk2_e/webgl2-1)
140146

147+
- [live2d-widget.js](https://github.com/xiazeyu/live2d-widget.js)
148+
149+
- [hexo-helper-live2d](https://github.com/EYHN/hexo-helper-live2d)
150+
141151
- [pixi-live2d](https://github.com/avgjs/pixi-live2d)
142152

143153
- [CubismJsComponents](https://github.com/Live2D/CubismJsComponents)
144154

145-
- [live2d-widget.js](https://github.com/xiazeyu/live2d-widget.js)
146-
147-
- [hexo-helper-live2d](https://github.com/EYHN/hexo-helper-live2d)
148155

149156

150157
## About me
151158

152159
[![Author][author]][author-url]
153160

154-
[![QQ][qq]][qq-url]
161+
[![Author QQ][author-qq]][author-qq-url]
162+
163+
[![Author Email][author-email]][author-email-url]
155164

156-
[![Email][email]][email-url]
165+
166+
[![Collaborator 0][collaborator0]][collaborator0-url]
167+
168+
[![Collaborator 0 QQ][collaborator0-qq]][collaborator0-qq-url]
169+
170+
[![Collaborator 0 Email][collaborator0-email]][collaborator0-email-url]
157171

158172

159173
## Imported
@@ -171,47 +185,56 @@ issues: [https://github.com/EYHN/hexo-helper-live2d/issues](https://github.com/E
171185

172186
Open sourced under the GPL v2.0 license.
173187

174-
[npm]: https://badge.fury.io/js/hexo-helper-live2d.svg?label=hexo-helper-live2d
175-
[npm-url]: https://www.npmjs.com/package/hexo-helper-live2d
188+
[npm]: https://badge.fury.io/js/live2d-widget.svg?label=live2d-widget
189+
[npm-url]: https://www.npmjs.com/package/live2d-widget
176190

177-
[deps]: https://img.shields.io/david/EYHN/hexo-helper-live2d.svg
191+
[deps]: https://img.shields.io/david/xiazeyu/live2d-widget.js.svg
178192
[deps-url]: javascript:void(0);
179193

180-
[devdeps]: https://img.shields.io/david/dev/EYHN/hexo-helper-live2d.svg
194+
[devdeps]: https://img.shields.io/david/dev/xiazeyu/live2d-widget.js.svg
181195
[devdeps-url]: javascript:void(0);
182196

183-
[license]: https://img.shields.io/github/license/EYHN/hexo-helper-live2d.svg
184-
[license-url]: https://github.com/EYHN/hexo-helper-live2d/blob/master/LICENSE
197+
[license]: https://img.shields.io/github/license/xiazeyu/live2d-widget.js.svg
198+
[license-url]: https://github.com/xiazeyu/live2d-widget.js/blob/master/LICENSE
185199

186200
[PRs Welcome]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
187201
[PRs Welcome-url]: http://makeapullrequest.com
188202

189-
[downloads]: https://img.shields.io/npm/dt/hexo-helper-live2d.svg
190-
[downloads-url]: https://www.npmjs.com/package/hexo-helper-live2d
203+
[downloads]: https://img.shields.io/npm/dt/live2d-widget.svg
204+
[downloads-url]: https://www.npmjs.com/package/live2d-widget
191205

192-
[downloads-month]: https://img.shields.io/npm/dm/hexo-helper-live2d.svg
193-
[downloads-month-url]: https://www.npmjs.com/package/hexo-helper-live2d
206+
[downloads-month]: https://img.shields.io/npm/dm/live2d-widget.svg
207+
[downloads-month-url]: https://www.npmjs.com/package/live2d-widget
194208

195209
[Commitizen friendly]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
196210
[Commitizen friendly-url]: http://commitizen.github.io/cz-cli/
197211

198-
[GitHub stars]: https://img.shields.io/github/stars/EYHN/hexo-helper-live2d.svg
199-
[GitHub stars-url]: https://github.com/EYHN/hexo-helper-live2d/stargazers
212+
[GitHub stars]: https://img.shields.io/github/stars/xiazeyu/live2d-widget.js.svg
213+
[GitHub stars-url]: https://github.com/xiazeyu/live2d-widget.js/stargazers
200214

201-
[GitHub forks]: https://img.shields.io/github/forks/EYHN/hexo-helper-live2d.svg
202-
[GitHub forks-url]: https://github.com/EYHN/hexo-helper-live2d/network
215+
[GitHub forks]: https://img.shields.io/github/forks/xiazeyu/live2d-widget.js.svg
216+
[GitHub forks-url]: https://github.com/xiazeyu/live2d-widget.js/network
203217

204-
[GitHub issues]: https://img.shields.io/github/issues/EYHN/hexo-helper-live2d.svg
205-
[GitHub issues-url]: https://github.com/EYHN/hexo-helper-live2d/issues
218+
[GitHub issues]: https://img.shields.io/github/issues/xiazeyu/live2d-widget.js.svg
219+
[GitHub issues-url]: https://github.com/xiazeyu/live2d-widget.js/issues
206220

207221
[author]: https://img.shields.io/badge/author-cneyhn-green.svg
208222
[author-url]: https://delusion.coding.me/
209223

210-
[qq]: https://img.shields.io/badge/QQ-1106996185-blue.svg
211-
[qq-url]: http://wpa.qq.com/msgrd?v=3&uin=&site=qq&menu=yes
224+
[author-qq]: https://img.shields.io/badge/QQ-1106996185-blue.svg
225+
[author-qq-url]: tencent://message/?uin=1106996185&Site=Senlon.Net&Menu=yes
226+
227+
[author-email]: https://img.shields.io/badge/Emali%[email protected]
228+
[author-email-url]: mailto:[email protected]
229+
230+
[collaborator0]: https://img.shields.io/badge/author-xiazeyu-green.svg
231+
[collaborator0-url]: https://xiazeyu.coding.me/
232+
233+
[collaborator0-qq]: https://img.shields.io/badge/QQ-2320732807-blue.svg
234+
[collaborator0-qq-url]: tencent://message/?uin=2320732807&Site=Senlon.Net&Menu=yes
212235

213-
[email]: https://img.shields.io/badge/Emali%20me-cneyhn@gmail.com-green.svg
214-
[email-url]: mailto:cneyhn@gmail.com
236+
[collaborator0-email]: https://img.shields.io/badge/Emali%20me-xiazeyu_2011@126.com-green.svg
237+
[collaborator0-email-url]: mailto:xiazeyu_2011@126.com
215238

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

index.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

lib/clL2D.0.min.js

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

lib/clL2D.min.js

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

lib/clL2D.min.js.map

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

lib/stats.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"name": "live2d-widget",
33
"version": "3.0.0",
44
"description": "Add the Sseexxyyy live2d to webpages.",
5-
"main": "index.js",
65
"scripts": {
76
"inst:dev": "npm install -g commitizen&&npm install",
87
"build:dev": "webpack --progress --colors",

src/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ L2Dwidget.init = (userConfig) => {
6464
return;
6565
}
6666

67-
import(/* webpackMode: "lazy" */ './cLive2DApp').then(f => {
67+
import(/* webpackMode: 'lazy' */ './cLive2DApp').then(f => {
6868
coreApp = f;
6969
coreApp.theRealInit();
7070
}).catch(err => {

webpack.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ module.exports = env => {return{
3636
new webpack.DefinePlugin({
3737
'process.env': {
3838
'NODE_ENV': JSON.stringify((isProd(env) ? 'production' : 'development')),
39-
}
39+
},
4040
}),
4141
new LodashModuleReplacementPlugin(),
4242
new UglifyJsPlugin({

0 commit comments

Comments
 (0)