wl-live2d
Version:
Live2D for web, 这是一个运行在浏览器环境的 Live2D 看板组件
94 lines (68 loc) • 2.63 kB
Markdown
# wlLive2d
wlLive2d 是一个应用于浏览器环境且开箱即用的 Live2D 看板组件, 支持从 cubism42 与 cubism44 版本的 Live2D 模型，开箱即用且可定制化。
如果你想为你的个人网站增加一个看板娘，那么请看看这个！🥳
[查阅文档](https://live2d.doc.nianian.cn/) 以了解更多详细的使用教程 🎉
## ✨ 特点：
- 支持 `CDN` 或 `ES6 Module` 导入
- 默认集成 `Cubism 2 SDK` 和 `Cubism 4 SDK`
- 按需引入或全量导入 `Cubism SDK` 依赖
- 支持配置多个模型，使用控件对其切换。
- 支持自定义扩展控件，支持无刷新加载
## 🌈 使用
### CDN 引入
通过 CDN 方式导入的示例如下。
在 `<body>` 标签中加入以下内容:
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>wlLive2d</title>
</head>
<body>
<script src="https://fastly.jsdelivr.net/npm/wl-live2d/dist/es/index.js" type="module"></script>
<script type="module">
wlLive2d({
models: [
{
path: 'https://fastly.jsdelivr.net/gh/guansss/pixi-live2d-display/test/assets/shizuku/shizuku.model.json',
}
]
});
</script>
</body>
</html>
```
如果网站启用了 PJAX，由于看板娘不必每页刷新，需要注意将该脚本放到 PJAX 刷新区域之外
### 使用包管理工具安装
```shell
npm install wl-live2d
or
yarn add wl-live2d
```
### ESM 使用示例
```js
import { wlLive2d } from 'wl-live2d';
wlLive2d({
models: [
{
path: 'https://fastly.jsdelivr.net/gh/guansss/pixi-live2d-display/test/assets/shizuku/shizuku.model.json',
}
]
});
```
如果您想更换自己的模型或对其进行自定义，请[查阅文档](https://live2d.doc.nianian.cn/guide/)的相关内容
## 💕 鸣谢
本项目主要依赖于 [pixi-live2d-display](https://github.com/guansss/pixi-live2d-display), 感谢其为 `Live2D` 社区做出的贡献
感谢 [一言](https://hitokoto.cn) 提供的语句接口
## 版权声明:
本项目仅提供模型加载技术支持, 不提供任何 Live2D Model 的下载地址。文档中提供的所有模型地址均来源于网路，仅供参考和学习。
## 其它
Live2D 官方网站:
[https://www.live2d.com/en/](https://www.live2d.com/en/)
[https://live2d.github.io](https://live2d.github.io)
emoji:
[emoji 中文网](https://www.emojiall.com/zh-hans)