Oh My Live2DOh My Live2D

Oh My Live2D

一个开箱即用的 Live2D Web 应用组件

快速开始 💡文档

立即体验

安装:

npm i oh-my-live2d

基本使用

默认情况下,无论你是使用 CDN 或 ES6 Module 的方式导入包,都无需从中导入任何模块或从全局成员变量中调用任何方法,即可得到一个完整的 Live2D 组件,这个过程属于自动装载,自动装载的 Live2D 组件将使用默认选项进行创建,并在模型加载完成后挂载到<body>标签中,

CDN 导入:

<script src="https://cdn.jsdelivr.net/npm/oh-my-live2d/dist/index.min.js"></script>

示例:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>OhMyLive2D</title>
  </head>
  <body>
    <script src="https://cdn.jsdelivr.net/npm/oh-my-live2d/dist/index.min.js"></script>
  </body>
</html>

ESM 导入:

import 'oh-my-live2d';

示例:

webpack5vite 管理的项目中使用此导入方式,以下为 webpack5 管理的 react 项目使用示例:

// src/index.tsx

import React from 'react';
import ReactDOM from 'react-dom/client';
import './index.css';
import App from './App';
import reportWebVitals from './reportWebVitals';

import 'oh-my-live2d';

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>
);

reportWebVitals();

快速开始:

参考:介绍

关于:

本项目不提供任何 Live2D Model 的下载地址。该 Live2D 模型来自于网络,OhMyLive2D 默认配置了一个模型地址,方便在初次使用时体验预览效果,仅供参考和学习。