@doki-land/live2d-loader 0.0.14 → 0.0.16

package/README.md

@@ -1,3 +1,108 @@
 # @doki-land/live2d-loader
 
-live2d.ts package 0.0.14.
+Source resolution and asset loading for the `live2d.ts` runtime.
+
+This is an implementation package. Most applications should load models through `@doki-land/live2d`.
+
+## ✨ Features
+
+- Local and remote model settings URLs.
+- `npm:` model references resolved through a configurable CDN base.
+- Model settings normalization for supported formats.
+- Relative model, texture, and resource URL resolution.
+- Byte and JSON fetching.
+- Structured loading progress.
+- Injectable asset resolvers for custom hosts.
+
+## 📦 Installation
+
+```bash
+pnpm add @doki-land/live2d-loader
+```
+
+## 🚀 Source Resolution
+
+```ts
+import { resolveModelSourceUrl } from "@doki-land/live2d-loader";
+
+const url = resolveModelSourceUrl(
+  "npm:live2d-widget-model-hijiki@1.0.5/assets/hijiki.model.json",
+);
+
+console.log(url);
+```
+
+Pin package versions in production so a remote registry or CDN cannot silently change the selected model assets.
+
+## 🌐 Remote Assets
+
+Remote models usually include several requests:
+
+```text
+model settings
+  -> MOC binary
+  -> textures
+  -> optional motions, expressions, physics, pose, and audio
+```
+
+Every referenced resource must be reachable under the browser's CORS and content-security policies. A settings file
+being accessible does not guarantee that its textures or binary assets are accessible.
+
+## 🔌 Custom Hosts
+
+Game engines and constrained hosts can provide a custom `AssetResolver` instead of teaching the loader about every file
+system or package container.
+
+Appropriate custom resolvers include:
+
+- game-engine asset databases;
+- hashed build manifests;
+- mini-game package APIs;
+- service-worker caches;
+- authenticated asset gateways;
+- offline bundles.
+
+Host adapters should translate their resource system into the shared resolver contract. They should not duplicate model
+settings normalization or MOC parsing.
+
+## 📈 Progress Reporting
+
+Loading progress is divided into meaningful stages such as settings, binary data, decode, and textures. Consumers should
+display the stage and normalized progress rather than guessing progress from the number of completed `fetch` calls.
+
+Byte totals may be unavailable when a server omits `Content-Length` or streams encoded content. Interfaces must tolerate
+an unknown total.
+
+## 🔒 Security
+
+Remote model settings are untrusted input. Hosts should consider:
+
+- allowed schemes and origins;
+- maximum response sizes;
+- request timeouts and cancellation;
+- redirects;
+- MIME validation;
+- decompression and texture size limits;
+- credential forwarding;
+- content-security policy.
+
+Do not attach privileged credentials to arbitrary model URLs.
+
+## 🧪 Development
+
+```bash
+pnpm --filter @doki-land/live2d-loader typecheck
+pnpm --filter @doki-land/live2d-loader test
+```
+
+Resolution changes should include cases for scoped packages, explicit versions, nested paths, malformed specifiers,
+relative URLs, and query/hash preservation where supported.
+
+## 🤝 Contributing
+
+Keep loading separate from model evaluation and rendering. New source schemes should have a clear deployment use case
+and deterministic resolution rules.
+
+## 📄 License
+
+See the repository license.

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "@doki-land/live2d-loader",
-  "version": "0.0.14",
-  "description": "Live2D asset resolve and model load pipeline",
+  "version": "0.0.16",
+  "description": "Fetch and normalize Live2D model.json/model3.json, resolve npm: URLs, AssetResolver for moc/textures.",
   "type": "module",
   "license": "MIT",
-  "author": "Doki Land",
+  "homepage": "https://github.com/doki-land/live2d.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/doki-land/live2d.ts.git",
+    "directory": "projects/live2d-loader"
+  },
   "keywords": [
     "live2d",
     "loader",
@@ -17,7 +22,8 @@
   },
   "files": [
     "dist",
-    "src"
+    "src",
+    "README.md"
   ],
   "publishConfig": {
     "access": "public",
@@ -36,11 +42,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@doki-land/live2d-core": "0.0.14"
+    "@doki-land/live2d-core": "0.0.16"
   },
-  "sideEffects": false,
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/doki-land/live2d.ts.git"
-  }
+  "sideEffects": false
 }