skinview3d-node 3.4.2-node.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2014-2018 Kent Rasmussen
+Copyright (c) 2017-2022 Haowei Wen, Sean Boult and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,210 @@
+skinview3d
+==========
+
+> Fork note / 分支说明
+>
+> English:
+> This fork is adapted from upstream `skinview3d` for server-side and offscreen rendering in Node.js. Compared with upstream, it replaces the browser-oriented rendering path with a backend-friendly implementation based on `skia-canvas` and headless WebGL, adds image/buffer export helpers for single-frame and animation rendering, and includes example pages plus a Vite plugin endpoint for testing backend rendering from the browser.
+>
+> 中文：
+> 这个 fork 基于上游 `skinview3d`，主要改造成适用于 Node.js 的后端/离屏渲染版本。相对上游，它将原本面向浏览器的渲染链路适配为基于 `skia-canvas` 和 headless WebGL 的后端实现，增加了单帧与动画的图片/缓冲区导出能力，并提供了可通过 Vite 接口在浏览器中测试后端渲染的示例页面。
+
+[![CI Status](https://img.shields.io/github/actions/workflow/status/bs-community/skinview3d/ci.yaml?branch=master&label=CI&logo=github&style=flat-square)](https://github.com/bs-community/skinview3d/actions?query=workflow:CI)
+[![NPM Package](https://img.shields.io/npm/v/skinview3d.svg?style=flat-square)](https://www.npmjs.com/package/skinview3d)
+[![MIT License](https://img.shields.io/badge/license-MIT-yellowgreen.svg?style=flat-square)](https://github.com/bs-community/skinview3d/blob/master/LICENSE)
+[![Gitter Chat](https://img.shields.io/gitter/room/TechnologyAdvice/Stardust.svg?style=flat-square)](https://gitter.im/skinview3d/Lobby)
+
+Three.js powered Minecraft skin viewer.
+
+# Features
+
+* 1.8 Skins
+* HD Skins
+* Capes
+* Ears
+* Elytras
+* Slim Arms
+  * Automatic model detection (Slim / Default)
+* FXAA (fast approximate anti-aliasing)
+
+# Usage
+
+This fork is intended for Node.js backend rendering rather than direct browser embedding.
+
+Install:
+
+```bash
+npm install skinview3d-node
+```
+
+Render a single PNG frame:
+
+```js
+import { writeFileSync } from 'node:fs';
+import { Vector3 } from 'three';
+import { SkinViewer, WalkingAnimation } from 'skinview3d-node';
+import gl from 'gl'
+
+const glContext = gl(width, height, { preserveDrawingBuffer: true })
+const width = 300
+const height = 300
+const mockCanvas = {
+	width,
+	height,
+	style: {},
+	addEventListener: () => {},
+	removeEventListener: () => {},
+	getContext: () => glContext
+}
+
+const skinViewer = new SkinViewer({
+	canvas: mockCanvas as any,
+	width,
+	height,
+	skin: './skin.png',
+	cape: './cape.png',
+	fov: 65,
+	zoom: 0.8,
+	pixelRatio: 1,
+	preserveDrawingBuffer: true,
+	animation: new WalkingAnimation()
+});
+
+await skinViewer.ready;
+
+skinViewer.camera.position.set(25, 22, 25);
+skinViewer.camera.lookAt(new Vector3(0, 5, 0));
+
+writeFileSync('out.png', viewer.renderAnimationFrame(progress,true)());
+skinViewer.dispose();
+```
+
+Render animation frames:
+
+```js
+import { writeFileSync } from 'node:fs';
+import { SkinViewer, WalkAnimation } from 'skinview3d-node';
+import gl from 'gl'
+
+const glContext = gl(width, height, { preserveDrawingBuffer: true })
+const width = 300
+const height = 300
+const mockCanvas = {
+	width,
+	height,
+	style: {},
+	addEventListener: () => {},
+	removeEventListener: () => {},
+	getContext: () => glContext
+}
+
+const skinViewer = new SkinViewer({
+	canvas: mockCanvas as any,
+	width,
+	height,
+	skin: './skin.png',
+	animation: new SwimAnimation(),
+	preserveDrawingBuffer: true
+});
+
+await skinViewer.ready;
+
+const frames = skinViewer.renderAnimationLoop(60);
+const arr: Uint8Array[] = [];
+frames.forEach((frame, i) => {
+	const buffer = frame();
+	arr.push(buffer);
+	// writeFileSync(`out/frame-${i}.png`, buffer)
+});
+const tmpgif = './output.gif' //path.join(os.tmpdir(), 'skinview3d_tmp.gif');
+await framesToGif({
+	width,
+	height,
+	frames: arr,
+	outputPath: tmpgif,
+	delay: WalkAnimation!.params.delay.value
+});
+
+skinViewer.dispose();
+```
+
+For local testing, this repository also provides an example Vite page at `examples/offscreen-render.html`.
+It calls a Vite plugin endpoint to render single frames or full animations on the backend and preview the result in the browser.
+
+## Lighting
+
+By default, there are two lights on the scene. One is an ambient light, and the other is a point light from the camera.
+
+To change the light intensity:
+
+```js
+skinViewer.cameraLight.intensity = 0.6;
+skinViewer.globalLight.intensity = 3;
+```
+
+Setting `globalLight.intensity` to `3.0` and `cameraLight.intensity` to `0.0`
+will completely disable shadows.
+
+## Ears
+
+skinview3d supports two types of ear texture:
+
+* `standalone`: 14x7 image that contains the ear ([example](https://github.com/bs-community/skinview3d/blob/master/examples/public/img/ears.png))
+* `skin`: Skin texture that contains the ear (e.g. [deadmau5's skin](https://minecraft.wiki/w/Easter_eggs#deadmau5's_ears))
+
+Usage:
+
+```js
+// You can specify ears in the constructor:
+new skinview3d.SkinViewer({
+	skin: "img/deadmau5.png",
+
+	// Use ears drawn on the current skin (img/deadmau5.png)
+	ears: "current-skin",
+
+	// Or use ears from other textures
+	ears: {
+		textureType: "standalone", // "standalone" or "skin"
+		source: "img/ears.png"
+	}
+});
+
+// Show ears when loading skins:
+skinViewer.loadSkin("img/deadmau5.png", { ears: true });
+
+// Use ears from other textures:
+skinViewer.loadEars("img/ears.png", { textureType: "standalone" });
+skinViewer.loadEars("img/deadmau5.png", { textureType: "skin" });
+```
+
+## Name Tag
+
+Usage:
+
+```js
+// Name tag with text "hello"
+skinViewer.nameTag = "hello";
+
+// Specify the text color
+skinViewer.nameTag = new skinview3d.NameTagObject("hello", { textStyle: "yellow" });
+
+// Unset the name tag
+skinViewer.nameTag = null;
+```
+
+In order to display name tags correctly, you need the `Minecraft` font from
+[South-Paw/typeface-minecraft](https://github.com/South-Paw/typeface-minecraft).
+This font is available at [`assets/minecraft.woff2`](assets/minecraft.woff2).
+
+To load this font, please add the `@font-face` rule to your CSS:
+
+```css
+@font-face {
+	font-family: 'Minecraft';
+	src: url('/path/to/minecraft.woff2') format('woff2');
+}
+```
+
+# Build
+
+`npm run build`

package/libs/animation.d.ts

@@ -0,0 +1,469 @@
+import { PlayerObject } from './model.js';
+type Params = Record<string, {
+    value: number | string | boolean;
+    desc: string;
+    choices?: string[];
+}> & {
+    multiple: {
+        value: number;
+        desc: string;
+    };
+    delay: {
+        value: number;
+        desc: string;
+    };
+};
+type ExtractValueType<T> = T extends {
+    value: infer V;
+} ? V : never;
+type ParamsValues<T extends Params> = {
+    [K in keyof T]: ExtractValueType<T[K]>;
+};
+export declare abstract class PlayerAnimation {
+    static params: {
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    /**
+     * 渲染某一帧的姿态
+     * @param player 播放器对象
+     * @param progress 动画进度，范围 [0, 1]。0代表起点，1代表终点（或循环回起点）
+     */
+    protected abstract animate(player: PlayerObject, progress: number): void;
+    render(player: PlayerObject, progress: number): void;
+}
+/**
+ * A class that helps you create an animation from a function.
+ *
+ * @example
+ * To create an animation that rotates the player:
+ * ```
+ * new FunctionAnimation((player, progress) => player.rotation.y = progress)
+ * ```
+ */
+export declare class FunctionAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    fn: (player: PlayerObject, progress: number) => void;
+    constructor(fn: (player: PlayerObject, progress: number) => void);
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class IdleAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class WalkingAnimation extends PlayerAnimation {
+    /**
+     * Whether to shake head when walking.
+     *
+     * @defaultValue `true`
+     */
+    static title: string;
+    static params: {
+        headBobbing: {
+            value: boolean;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        headBobbing: {
+            value: boolean;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class RunningAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        multiply: {
+            value: number;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        multiply: {
+            value: number;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class FlyingAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class WaveAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        whichArm: {
+            value: "left" | "right" | "both";
+            desc: string;
+            choices: string[];
+        };
+        sameDirection: {
+            value: boolean;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        whichArm: {
+            value: "left" | "right" | "both";
+            desc: string;
+            choices: string[];
+        };
+        sameDirection: {
+            value: boolean;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class CrouchAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        showProgress: {
+            value: boolean;
+            desc: string;
+        };
+        isStatic: {
+            value: boolean;
+            desc: string;
+        };
+        isRunningHitAnimation: {
+            value: boolean;
+            desc: string;
+        };
+        hitCycles: {
+            value: number;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        showProgress: {
+            value: boolean;
+            desc: string;
+        };
+        isStatic: {
+            value: boolean;
+            desc: string;
+        };
+        isRunningHitAnimation: {
+            value: boolean;
+            desc: string;
+        };
+        hitCycles: {
+            value: number;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class HitAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class SwimAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class SpinUpAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        maxHeight: {
+            value: number;
+            desc: string;
+        };
+        rotationTurns: {
+            value: number;
+            desc: string;
+        };
+        /**分头行动 */
+        headOff: {
+            value: boolean;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        maxHeight: {
+            value: number;
+            desc: string;
+        };
+        rotationTurns: {
+            value: number;
+            desc: string;
+        };
+        /**分头行动 */
+        headOff: {
+            value: boolean;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class RotateAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class NodAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        delay: {
+            value: number;
+            desc: string;
+        };
+        amp: {
+            value: number;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        delay: {
+            value: number;
+            desc: string;
+        };
+        amp: {
+            value: number;
+            desc: string;
+        };
+        multiple: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export declare class FlailAnimation extends PlayerAnimation {
+    static title: string;
+    static params: {
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    };
+    params: ParamsValues<{
+        multiple: {
+            value: number;
+            desc: string;
+        };
+        delay: {
+            value: number;
+            desc: string;
+        };
+    }>;
+    protected animate(player: PlayerObject, progress: number): void;
+}
+export {};