You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository does not include any models. You need to configure a separate model repository and set it via the `cdnPath` option.
59
+
This repository does not include any models. You need to configure a separate model repository and set it via the `cdnPath` option.
58
60
Older versions of the `initWidget` function supported the `apiPath` parameter, which required users to set up their own backend. You can refer to [live2d_api](https://github.com/fghrsh/live2d_api) for details. The backend interface would integrate model resources and dynamically generate JSON description files. Since version 1.0, these features have been implemented on the frontend, so a dedicated `apiPath` is no longer required. All model resources can be provided statically. As long as `model_list.json` and the corresponding `textures.cache` for each model exist, features such as outfit changing are supported.
59
61
60
62
## Development
@@ -68,18 +70,27 @@ If the options provided in the "Configuration" section above are not enough to m
68
70
-`waifu-tips.js` is automatically generated by `build/waifu-tips.js` and it is not recommended to modify it directly.
69
71
-`waifu.css` is the style sheet for the widget.
70
72
-`waifu-tips.json` defines the triggering conditions (`selector`, CSS selector) and the displayed text when triggered (`text`).
71
-
By default, the CSS selector rules in `waifu-tips.json` are effective for the Hexo [NexT theme](http://github.com/next-theme/hexo-theme-next), but you may need to modify or add new content to make it suitable for your own website.
73
+
By default, the CSS selector rules in `waifu-tips.json` are effective for the Hexo [NexT theme](https://github.com/next-theme/hexo-theme-next), but you may need to modify or add new content to make it suitable for your own website.
72
74
**Warning: The content in `waifu-tips.json` may not be suitable for all age groups or appropriate to access during work. Please ensure their suitability when using them.**
73
75
74
76
To deploy the development testing environment of this project locally, you need to install Node.js and npm, then execute the following commands:
If you need to use Cubism 3 or newer models, please download and extract the Cubism SDK for Web separately into the `src` directory, for example, `src/CubismSdkForWeb-5-r.4`. Due to Live2D license agreements (including the Live2D Proprietary Software License Agreement and Live2D Open Software License Agreement), this project cannot include the source code of Cubism SDK for Web.
84
+
If you only need to use Cubism 2 models, you can skip this step. The code in this repository complies with the Redistributable Code terms of the Live2D license agreements.
85
+
Once completed, use the following command to compile and bundle the project.
86
+
87
+
88
+
```bash
79
89
npm run build
80
90
```
81
91
82
-
The TypeScript code in the `src` directory is compiled into the `build` directory, and the code in the `build` directory is further bundled into the `dist` directory.
92
+
The TypeScript code in the `src` directory is compiled into the `build` directory, and the code in the `build` directory is further bundled into the `dist` directory.
93
+
To support both Cubism 2 and Cubism 3 (and newer) models while minimizing code size, Cubism Core and related code are loaded dynamically based on the detected model version.
83
94
84
95
## Deploy
85
96
@@ -187,7 +198,7 @@ https://www.live2d.com/en/
187
198
188
199
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
200
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
201
+
The code in this repository (excluding parts covered by the Live2D Proprietary Software License and the Live2D Open Software License) is released under the GNU General Public License v3
191
202
http://www.gnu.org/licenses/gpl-3.0.html
192
203
193
204
Please comply with the relevant licenses when using any Live2D-related code:
@@ -199,7 +210,7 @@ License for Live2D Cubism SDK 5:
199
210
Live2D Cubism Core is provided under the Live2D Proprietary Software License.
0 commit comments