rspress-plugin-live2d 0.3.0 → 1.0.0

package/README.md

@@ -1,5 +1,7 @@
 # rspress-plugin-live2d ![NPM Version](https://img.shields.io/npm/v/rspress-plugin-live2d)
 
+[简体中文](./README.zh-CN.md)
+
 Rspress plugin for live2d, powered by [on-my-live2d](https://oml2d.com/).
 
 ![example](image.png)

package/README.zh-CN.md

@@ -0,0 +1,41 @@
+# rspress-plugin-live2d ![NPM Version](https://img.shields.io/npm/v/rspress-plugin-live2d)
+
+Rspress 的看板娘插件, 基于 [on-my-live2d](https://oml2d.com/).
+
+![example](image.png)
+
+## 使用
+
+```bash
+npm install rspress-plugin-live2d
+pnpm install rspress-plugin-live2d
+```
+
+```ts
+import * as path from 'path';
+import { defineConfig } from 'rspress/config';
+import live2d from 'rspress-plugin-live2d';
+
+export default defineConfig({
+  root: path.join(__dirname, 'docs'),
+  title: 'Rspress x Live2d Example',
+  plugins: [
+    live2d({
+      models: [
+        {
+          path: 'https://model.oml2d.com/HK416-1-normal/model.json',
+          position: [0, 60],
+          scale: 0.08,
+          stageStyle: {
+            height: 450,
+          },
+        },
+      ],
+    }),
+  ],
+});
+```
+
+## 配置
+
+参考 [On My Live2D](https://oml2d.com/guide/models.html) 来查找更多模型和配置。

package/components/Live2DWidget.tsx

@@ -1,12 +1,13 @@
 import React, { useEffect } from 'react';
 
-import { loadOml2d } from 'oh-my-live2d';
-
 import type { Live2DWidgetProps } from '../src/typings';
 
 const Live2DWidget: React.FC<Live2DWidgetProps> = (options) => {
   useEffect(() => {
-    loadOml2d(options);
+    import('oh-my-live2d').then(({ loadOml2d }) => {
+      console.log(1111111);
+      loadOml2d(options);
+    });
   }, []);
 
   return null;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import type { RspressPlugin } from '@rspress/shared';
+import type { RspressPlugin } from '@rspress/core';
 import type { Live2DWidgetProps } from './typings';
 export interface RspressPluginLive2dOptions extends Live2DWidgetProps {
 }

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "rspress-plugin-live2d",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "description": "Rspress plugin with live 2d.",
+  "type": "module",
   "files": [
     "dist",
     "components"
@@ -27,9 +28,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@rspress/shared": "^1.17.1",
     "oh-my-live2d": "^0.15.2",
-    "rspress-plugin-devkit": "^0.3.0"
+    "rspress-plugin-devkit": "^1.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.12.5",
@@ -37,7 +37,7 @@
     "typescript": "^5.4.4"
   },
   "peerDependencies": {
-    "rspress": "*"
+    "@rspress/core": "^2.0.0-rc.4 || ^2.0.0"
   },
   "scripts": {
     "build": "tsc --declarationMap false",

package/components/Live2DWidget.d.ts

@@ -1,4 +0,0 @@
-import React from 'react';
-import type { Live2DWidgetProps } from '../src/typings';
-declare const Live2DWidget: React.FC<Live2DWidgetProps>;
-export default Live2DWidget;

package/components/Live2DWidget.jsx

@@ -1,9 +0,0 @@
-import { useEffect } from 'react';
-import { loadOml2d } from 'oh-my-live2d';
-const Live2DWidget = (options) => {
-    useEffect(() => {
-        loadOml2d(options);
-    }, []);
-    return null;
-};
-export default Live2DWidget;