快速入门

OhMyLive2D 是一个应用于浏览器环境且开箱即用的Live2D组件, 它支持所有版本的Live2D模型, 使用方式足够简单并且高可自定义, 可以快速为您的个人网站添加Live2D看板娘, 使您的个人网站变得更具有特色.

OhMyLive2D 的初衷是为了解决官方 Cubism SDK 在使用时还需要额外通过 script 标签外部引入以及使用和学习成本较高的缺点。而现在它在被 pixi-live2d-display 驱动的同时又提供了多种导入方式以及更简单更方便自定义配置的 API。因为 oh-my-live2d 是纯 javascript，所以它可以完全独立运行在浏览器环境, 这意味着你可以在任意 web 框架或传统的原生 JS 开发的 web 项目中的使用它，并且无需再导入其他任何依赖和 css 样式资源, 真正做到了开箱即用.

TIP

本项目目前正处于积极维护状态, 欢迎志同道合的伙伴加入 😄

Live2D 是什么?

Live2D 是一个向插图灌注生命力并能够进行 2D 立体表现的技术.

更多内容请前往：Live2D 官方网站

Cubism 是什么?

Cubism 是 Live2D SDK 的名称，截至目前它一共存在四个版本：Cubism 2、Cubism 3、Cubism 4。Cubism 5

Cubism 2 是只能驱动 Live2D Model 版本为 2 的 SDK，它无法驱动 Live2D Model 3 和 Live2D Model 4。

Cubism 5 向后兼容了 Live2D Model 3 并支持 Live2D Model 4 ，但它无法驱动 Live2D Model 2。

TIP

本项目已集成 Cubism 2.1 与 Cubism 5.0.0 ，完整覆盖了从 model2 到 model5 的所有live2d模型版本。

快速开始

安装

npm

npm install oh-my-live2d

pnpm

pnpm add oh-my-live2d

yarn

yarn add oh-my-live2d

更新

如需更新 oh-my-live2d 你只需要在安装命令后缀加上@latest即可更新至当前最新发行版, 当然 vuepress 等插件也同理

npm

npm install oh-my-live2d@latest

pnpm

pnpm add oh-my-live2d@latest

yarn

yarn add oh-my-live2d@latest

使用

使用方式请查阅: 组件加载

其他支持

• 在 VitePress 中使用

• 在 VuePress2 中使用

• 通过VitePlugin方式使用

• 在 Hexo 中使用

模型资源

前往模型资源选择您喜欢的模型