@doki-land/live2d 0.0.8 → 0.0.9

package/package.json

@@ -1,12 +1,12 @@
 {
     "name": "@doki-land/live2d",
-    "version": "0.0.8",
+    "version": "0.0.9",
     "keywords": [
         "live2d",
         "pixi",
         "typescript"
     ],
-    "description": "Live2D TypeScript runtime based on pixi-live2d-display",
+    "description": "Live2D TypeScript runtime based on pixi",
     "author": "Aster <192608617@qq.com>",
     "license": "LGPL-3.0-or-later",
     "type": "module",
@@ -16,13 +16,17 @@
             "require": "./dist/l2d.umd.js",
             "import": "./src/index.ts"
         },
-        "./fs": {
-            "types": "./src/fs/index.ts",
-            "import": "./src/fs/index.ts"
-        },
         "./types": {
             "types": "./src/types/index.ts",
             "import": "./src/types/index.ts"
+        },
+        "./helper": {
+            "types": "./src/helper/index.ts",
+            "import": "./src/helper/index.ts"
+        },
+        "./fs": {
+            "types": "./src/fs/index.ts",
+            "import": "./src/fs/index.ts"
         }
     },
     "files": [

package/readme.md

@@ -1,19 +1,60 @@
-## Doki land live2d renderer
+# Live2D Core Adapter (Unofficial)
 
+## Usage
 
+This is the core library for rendering Live2D models in web applications.
 
-## Using in html by module
+It provides essential functionalities to load and display Live2D models with interactive capabilities.
+
+
+
+### In HTML via Module
 
 ```html
+<script src="https://cdn.jsdelivr.net/npm/@doki-land/live2d@latest/dist/l2d.umd.js">
 <script type="module">
-  const cdn = 'https://cdn.jsdelivr.net/npm/@doki-land/live2d@latest/dist/l2d.esm.js';
-  const { createLive2dModel, initializeLive2D } = await import(cdn);
-  initializeLive2D();
-  await createLive2dModel({
+l2d.initializeLive2D();
+l2d.createLive2D({
     element_id: 'live2d-canvas',
     models: [
-      {}
+        {}
     ]
-  });
+})
 </script>
-```
+```
+
+
+### In Node via npm
+
+- installation
+
+```bash
+npm install @doki-land/live2d-core
+```
+
+- usage
+
+```javascript
+
+
+
+
+
+```
+
+### In Other Frameworks
+
+- [VitePress]()
+- [VuePress]()
+- [Hexo]()
+
+## Features
+
+- Render Live2D Cubism™ v1, v2 (`*.model.json`). 
+- Render Live2D Cubism™ v3, v4, v5 (`*.model3.json`).
+
+
+
+### API Documentation
+- `initializeLive2D()`: Initializes the Live2D environment
+- `createLive2dModel(options)`: Creates and renders a Live2D model with specified options

package/src/helper/index.ts

@@ -0,0 +1,25 @@
+import {findAllModels, mergeModels} from "@/fs/index.js";
+import {ResolveCdn, ResolveElementId, ResolveModels} from "@/types/index.js";
+
+export function generateModelList(options: ResolveModels) {
+    const models = mergeModels(options.domain || 'https://localhost:8080', findAllModels(options.models_folder || 'public/live2d'), options.models || []);
+    if (models.length == 0) {
+        throw new Error('At least one live2d model is required');
+    }
+    delete options.domain;
+    delete options.models;
+    delete options.models_folder;
+    return models;
+}
+
+export function generateElementId(options: ResolveElementId) {
+    const element_id = options.element_id || 'live2d-canvas';
+    delete options.element_id;
+    return element_id
+}
+
+export function generateCdn(options: ResolveCdn) {
+    const cdn = options.cdn || 'https://cdn.jsdelivr.net/npm/@doki-land/live2d@latest/dist/l2d.umd.js';
+    delete options.cdn;
+    return cdn
+}

package/src/types/Resolve.ts

@@ -0,0 +1,16 @@
+import {ModelOptions} from "@/types/ModelOptions.js";
+
+
+export type ResolveModels = {
+    domain?: string,
+    models?: ModelOptions[]
+    models_folder?: string
+}
+
+export type ResolveElementId = {
+    element_id?: string
+}
+
+export type ResolveCdn = {
+    cdn?: string
+}

package/src/types/index.ts

@@ -1,2 +1,3 @@
 export  * from './Live2dOptions.js';
-export  * from './ModelOptions.js';
+export  * from './ModelOptions.js';
+export  * from './Resolve.js';