update

2024-11-22 15:19:44 +00:00 · 2019-01-02 20:36:35 +08:00 · 2019-01-02 20:36:35 +08:00 · a26c6110fa
commit a26c6110fa
parent c043b28aef
4 changed files with 29 additions and 19 deletions
--- a/README.md
+++ b/README.md
@ -1,31 +1,48 @@
 # live2d-widget

 ## 功能 Feature
-在网页中添加Live2D看板娘  
-Add Live2D widget to web page
+在网页中添加Live2D看板娘。  
+Add Live2D widget to web page.

 ## Demo
-在[米米的博客](https://zhangshuqiao.org)的左下角可查看效果
+在[米米的博客](https://zhangshuqiao.org)的左下角可查看效果。
+
+![](screenshot.png)

 ## 依赖 Dependencies
-需要jQuery和font-awesome支持，请确保它们已在页面中加载，例如在`<head>`中加入：  
+本插件需要jQuery和font-awesome支持，请确保它们已在页面中加载，例如在`<head>`中加入：  
 jQuery and font-awesome is required for this plugin. You can add this to `<head>`:
 ```xml
 <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">
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/font-awesome/css/font-awesome.min.css"/>
 ```
 否则无法正常显示。

 ## 使用 Usage
+
+### Using CDN
+你可以直接这样使用：
+```xml
+<script src="https://cdn.jsdelivr.net/gh/stevenjoezhang/live2d-widget/autoload.js"></script>
+```
+将这一行代码加入`<head>`或`<body>`，就可以看到效果了。  
+（换句话说，如果你是小白，或者只需要最基础的功能，就把这一行代码，连同前面的两行代码，一起放到html的`<head>`中即可；如果页面是用各种模版、php、asp生成的，也要类似的修改，可能略为麻烦）
+
+**但是！我们强烈推荐自己进行配置，否则很多功能是不完整的，并且可能产生问题！**  
+如果你有兴趣自己折腾的话，请看下面的详细说明。
+
+### Self-host
+你也可以根据以下方法进行配置。  
 如果你可以通过ssh访问你的主机，请把整个项目克隆到服务器上。执行：
 ```bash
 cd /path/to/your/webroot
+# Clone this repository
 git clone https://github.com/stevenjoezhang/live2d-widget.git
 ```
 如果你的主机是虚拟主机，请选择`Download ZIP`，然后通过ftp上传到主机上，再解压到网站的目录下。  
-如果你通过Hexo等工具部署静态博客，请选择`Download ZIP`，然后解压到本地的博客目录下。重新部署博客时，相关文件就会自动上传。
+如果你通过Hexo等工具部署静态博客，请选择`Download ZIP`，然后解压到本地的博客目录下，例如`source`下与`_posts`同级的目录。重新部署博客时，相关文件就会自动上传。（还需要在Hexo主题相关的swig或ejs模版中正确配置路径，才可以加载）

-这样，整个项目就可以通过你的ip或者域名从公网访问了。你可以试试能否正常的通过浏览器打开`autoload.js`和`live2d.min.js`等文件。  
+这样，整个项目就可以通过你的服务器IP或者域名从公网访问了。你可以试试能否正常的通过浏览器或`curl`打开`autoload.js`和`live2d.min.js`等文件。  
 如果没有问题，接下来需要修改一些配置。（你也可以先在本地完成这一步骤，再上传到服务器上）  
 修改autoload.js中的参数`live2d_path`为`live2d-widget`这一文件夹在公网上的路径。比如说，如果你可以通过
 ```
@ -43,26 +60,19 @@ https://www.example.com/path/to/live2d-widget/
 就可以加载了。

 `waifu-tips.json`中包含了触发条件（selector，选择器）和触发时显示的文字（text）。源文件是对Hexo的NexT主题有效的，为了适用于你自己的网页，也需要自行修改，或增加新内容。  
-**警告：作者不对`waifu-tips.json`和`waifu-tips.js`中的内容负责，请自行确保它们是合适的。**
-
+**警告：作者不对`waifu-tips.json`和`waifu-tips.js`中的内容负责，请自行确保它们是合适的。**  
 如果有任何疑问，欢迎提交ISSUE。

-### Using CDN
-你也可以直接这样使用：
-```xml
-<script src="https://cdn.jsdelivr.net/gh/stevenjoezhang/live2d-widget/autoload.js"></script>
-```
-
 ## 鸣谢 Credits
 代码自这篇博文魔改而来：  
 https://www.fghrsh.net/post/123.html  
-其中增加了一些功能，优化了提示展现机制
+相比初始的版本，这个Repo增加了一些功能，并优化了提示展现机制

 更多内容可以参考：  
 https://imjad.cn/archives/lab/add-dynamic-poster-girl-with-live2d-to-your-blog-02  
 https://zhangshuqiao.org/2018-07/在网页中添加Live2D看板娘

-可以自行在后端api中增加模型（需要自行修改）：  
+还可以自行搭建后端api，并增加模型（需要修改的内容比较多，此处不再赘述）：  
 https://github.com/xiazeyu/live2d-widget-models  
 https://github.com/xiaoski/live2d_models_collection

--- a/autoload.js
+++ b/autoload.js
@ -13,7 +13,7 @@ $.ajax({

 $.ajax({
 	url: live2d_path + "waifu-tips.js",
-	dataType:"script",
+	dataType: "script",
 	cache: true,
 	async: false
 });
--- a/demo.html
+++ b/demo.html
@ -2,7 +2,7 @@
 <html>
 <head>
 <meta charset="UTF-8"/>
-<title>Live2D 看板娘 v1.2 / Demo</title>
+<title>Live2D 看板娘 / Demo</title>
 <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"/>
 </head>
--- a/screenshot.png
+++ b/screenshot.png