live2d-widget

改自大佬的 Live2D Widget

此项目原始版本借助了官方live2d api 目前项目已经完全独立,后期会把所有方法重构

特性

在网页中添加 Live2D 看板娘。兼容 PJAX,支持无刷新加载。

(注:以上人物模型仅供展示之用,本仓库只有少数十几个模型。)

你也可以查看示例网页:

使用

如果你是小白,或者只需要最基础的功能,那么只用将这一行代码加入 html 页面的 headbody 中,即可加载看板娘:

<script src="https://intmin.github.io/live2d-widget/autoload.js"></script>

添加代码的位置取决于你的网站的构建方式。例如,如果你使用的是 Hexo,那么需要在主题的模版文件中添加以上代码。对于用各种模版引擎生成的页面,修改方法类似。
如果网站启用了 PJAX,由于看板娘不必每页刷新,需要注意将该脚本放到 PJAX 刷新区域之外。

但是!我们强烈推荐自己进行配置,让看板娘更加适合你的网站!
如果你有兴趣自己折腾的话,请看下面的详细说明。

配置

你可以对照 autoload.js 的源码查看可选的配置项目。autoload.js 会自动加载三个文件:waifu.csslive2d.min.jswaifu-tips.jswaifu-tips.js 会创建 initWidget 函数,这就是加载看板娘的主函数。initWidget 函数接收一个 Object 类型的参数,作为看板娘的配置。以下是配置选项:

选项 类型 默认值 说明
waifuPath string https://intmin.github.io/live2d-widget/waifu-tips.json 看板娘资源路径,可自行修改
apiPath string https://live2d.fghrsh.net/api/ API 路径,本仓库不使用后端接口
cdnPath string https://intmin.github.io/live2d-widget/ CDN 路径,可选参数
tools string[] autoload.js 加载的小工具按钮,可选参数

其中,apiPathcdnPath 两个参数设置其中一项即可。 apiPath 是后端 API 的 URL,可以自行搭建,并增加模型(需要修改的内容比较多,此处不再赘述,并且本仓库完全废弃后端api接口),需要使用api可以参考 live2d_api。 而 cdnPath 则是通过 jsDelivr 这样的 CDN 服务加载资源,更加稳定。

自定义

如果以上「配置」部分提供的选项还不足以满足你的需求,那么你可以自己进行修改。本仓库的目录结构如下:

waifu-tips.json 中默认的 CSS 选择器规则是对 Hexo 的 NexT 主题 有效的,为了适用于你自己的网页,可能需要自行修改,或增加新内容。
警告:waifu-tips.json 中的内容可能不适合所有年龄段,或不宜在工作期间访问。在使用时,请自行确保它们是合适的。

要在本地部署本项目的开发测试环境,你需要安装 Node.js 和 npm,然后执行以下命令:

git clone https://github.com/INTMIN/live2d-widget.git
npm install
npm run build

如果有任何疑问,欢迎提 Issue。如果有任何修改建议,欢迎提 Pull Request。

部署

在本地完成了修改后,你可以将修改后的项目部署在服务器上,或者通过 CDN 加载,以便在网页中使用。

使用 CDN

要自定义有关内容,可以把这个仓库 Fork 一份,然后把修改后的内容通过 git push 到你的仓库中。这时,使用方法对应地变为 注意这个是大佬的cdn 只有从大佬那边fork的才会有cdn

<script src="https://fastly.jsdelivr.net/gh/你的名字/live2d-widget@latest/autoload.js"></script>

将此处的 username 替换为你的 GitHub 用户名。为了使 CDN 的内容正常刷新,需要创建新的 git tag 并推送至 GitHub 仓库中,否则此处的 @latest 仍然指向更新前的文件。此外 CDN 本身存在缓存,因此改动可能需要一定的时间生效。相关文档:

Self-host

你也可以直接把这些文件放到服务器上,而不是通过 CDN 加载。

这样,整个项目就可以通过你的域名访问了。不妨试试能否正常地通过浏览器打开 autoload.jslive2d.min.js 等文件,并确认这些文件的内容是完整和正确的。
一切正常的话,接下来修改 autoload.js 中的常量 live2d_pathlive2d-widget 这一目录的 URL 即可。比如说,如果你能够通过

https://example.com/path/to/live2d-widget/live2d.min.js

访问到 live2d.min.js,那么就把 live2d_path 的值修改为

https://example.com/path/to/live2d-widget/

路径末尾的 / 一定要加上。
完成后,在你要添加看板娘的界面加入

<script src="https://example.com/path/to/live2d-widget/autoload.js"></script>

就可以加载了。

许可证

Apache License 2.0 License

更新日志

2025 此仓库已经独立开发,不使用后端接口

2025-1-15 该项目已上线微软插件 一键直达