live2d-widget/README.md

72 lines
3.2 KiB
Markdown
Raw Normal View History

2018-07-11 15:38:35 +08:00
# live2d-widget
2018-12-18 00:01:42 +08:00
## 功能 Feature
在网页中添加Live2D看板娘
Add Live2D widget to web page
2018-07-11 15:38:35 +08:00
## Demo
2018-11-02 23:04:54 +08:00
在[米米的博客](https://zhangshuqiao.org)的左下角可查看效果
2018-07-11 15:38:35 +08:00
2018-12-18 00:01:42 +08:00
## 依赖 Dependencies
需要jQuery和font-awesome支持请确保它们已在页面中加载例如在`<head>`中加入:
jQuery and font-awesome is required for this plugin. You can add this to `<head>`:
2018-12-11 19:57:55 +08:00
```xml
2018-12-18 00:01:42 +08:00
<script src="https://cdn.jsdelivr.net/npm/jquery/dist/jquery.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/font-awesome/css/font-awesome.min.css">
2018-11-02 23:04:54 +08:00
```
2018-12-11 19:57:55 +08:00
否则无法正常显示。
2018-07-11 15:38:35 +08:00
2018-12-18 00:01:42 +08:00
## 使用 Usage
2018-12-11 19:57:55 +08:00
如果你可以通过ssh访问你的主机请把整个项目克隆到服务器上。执行
```bash
cd /path/to/your/webroot
git clone https://github.com/stevenjoezhang/live2d-widget.git
```
如果你的主机是虚拟主机,请选择`Download ZIP`然后通过ftp上传到主机上再解压到网站的目录下。
如果你通过Hexo等工具部署静态博客请选择`Download ZIP`,然后解压到本地的博客目录下。重新部署博客时,相关文件就会自动上传。
这样整个项目就可以通过你的ip或者域名从公网访问了。你可以试试能否正常的通过浏览器打开`autoload.js`和`live2d.min.js`等文件。
如果没有问题,接下来需要修改一些配置。(你也可以先在本地完成这一步骤,再上传到服务器上)
修改autoload.js中的参数`live2d_path`为`live2d-widget`这一文件夹在公网上的路径。比如说,如果你可以通过
```
https://www.example.com/path/to/live2d-widget/live2d.min.js
```
访问到`live2d.min.js`,那么就把`live2d_path`的值修改为
```
https://www.example.com/path/to/live2d-widget/
2018-07-11 15:38:35 +08:00
```
2018-12-11 19:57:55 +08:00
路径末尾的`/`一定要加上。具体可以参考该文件内的注释。
完成后,在你要添加看板娘的界面加入
```xml
<script src="https://www.example.com/path/to/live2d-widget/autoload.js"></script>
2018-07-11 15:38:35 +08:00
```
2018-11-02 23:04:54 +08:00
就可以加载了。
2018-07-11 15:38:35 +08:00
2018-12-18 00:01:42 +08:00
`waifu-tips.json`中包含了触发条件selector选择器和触发时显示的文字text。源文件是对Hexo的NexT主题有效的为了适用于你自己的网页也需要自行修改或增加新内容。
**警告:作者不对`waifu-tips.json`和`waifu-tips.js`中的内容负责,请自行确保它们是合适的。**
2018-12-11 19:57:55 +08:00
如果有任何疑问欢迎提交ISSUE。
2018-07-11 15:38:35 +08:00
2018-12-18 00:01:42 +08:00
### Using CDN
你也可以直接这样使用:
```xml
<script src="https://cdn.jsdelivr.net/gh/stevenjoezhang/live2d-widget/autoload.js"></script>
```
## 鸣谢 Credits
2018-07-11 15:38:35 +08:00
代码自这篇博文魔改而来:
https://www.fghrsh.net/post/123.html
其中增加了一些功能,优化了提示展现机制
更多内容可以参考:
https://imjad.cn/archives/lab/add-dynamic-poster-girl-with-live2d-to-your-blog-02
https://zhangshuqiao.org/2018-07/在网页中添加Live2D看板娘
2018-11-14 01:28:01 +08:00
可以自行在后端api中增加模型需要自行修改
https://github.com/xiazeyu/live2d-widget-models
https://github.com/xiaoski/live2d_models_collection
2018-11-03 18:52:03 +08:00
2018-12-18 00:01:42 +08:00
## 更新 Update
2018-11-14 01:28:01 +08:00
2018年10月31日由fghrsh提供的原API停用请更新至新地址。参考文章
2018-11-03 18:52:03 +08:00
https://www.fghrsh.net/post/170.html