@pmndrs/viverse 0.1.2

package/LICENSE

@@ -0,0 +1,34 @@
+Copyright 2024 Bela Bohlender
+
+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.
+
+Link to License of robot.vrm from "FinBeenWhere?"
+https://creativecommons.org/licenses/by/4.0/
+
+License of @pixiv/three-vrm
+Copyright (c) 2019-2025 pixiv Inc.
+
+MIT License
+
+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,41 @@
+<h1 align="center">@pmndrs/viverse</h1>
+<h3 align="center">Build 3D web games with threejs and viverse.</h3>
+<br/>
+
+<p align="center">
+  <a href="https://npmjs.com/package/@react-three/viverse" target="_blank">
+    <img src="https://img.shields.io/npm/v/@react-three/viverse?style=flat&colorA=000000&colorB=000000" alt="NPM" />
+  </a>
+  <a href="https://npmjs.com/package/@react-three/viverse" target="_blank">
+    <img src="https://img.shields.io/npm/dt/@react-three/viverse.svg?style=flat&colorA=000000&colorB=000000" alt="NPM" />
+  </a>
+  <a href="https://twitter.com/pmndrs" target="_blank">
+    <img src="https://img.shields.io/twitter/follow/pmndrs?label=%40pmndrs&style=flat&colorA=000000&colorB=000000&logo=twitter&logoColor=000000" alt="Twitter" />
+  </a>
+  <a href="https://discord.gg/ZZjjNvJ" target="_blank">
+    <img src="https://img.shields.io/discord/740090768164651008?style=flat&colorA=000000&colorB=000000&label=discord&logo=discord&logoColor=000000" alt="Discord" />
+  </a>
+</p>
+
+```bash
+npm install three @react-three/fiber @react-three/viverse
+```
+
+### What does it look like?
+
+| A prototype map with the `SimpleCharacter` class and its default model. | ![render of the code below](../../docs/getting-started/basic-example.gif) |
+| --------------------------------------------------------------------------- | --------------------------------------------------------------------- |
+
+```jsx
+const world = new BvhPhysicsWorld()
+world.addFixedBody(ground.scene)
+const character = new SimpleCharacter(camera, world, canvas, { model: { url: profile.activeAvatar?.vrmUrl } })
+scene.add(character)
+```
+
+## How to get started
+
+> Some familiarity with
+> threej is recommended.
+
+Get started with building games using @pmndrs/viverse [vanilla three.js](https://pmndrs.github.io/viverse/without-react).

package/dist/animation/gltf.d.ts

@@ -0,0 +1,3 @@
+import { AnimationClip } from 'three';
+import { loadCharacterModel } from '../model/index.js';
+export declare function loadVrmModelGltfAnimations(model: Exclude<Awaited<ReturnType<typeof loadCharacterModel>>, undefined>, url: string, removeXZMovement: boolean): Promise<Array<AnimationClip>>;

package/dist/animation/gltf.js

@@ -0,0 +1,8 @@
+import { GLTFLoader } from 'three/examples/jsm/Addons.js';
+import { fixModelAnimationClip } from './index.js';
+const loader = new GLTFLoader();
+export async function loadVrmModelGltfAnimations(model, url, removeXZMovement) {
+    const { animations, scene: clipScene } = await loader.loadAsync(url);
+    animations.forEach((clip) => fixModelAnimationClip(model, clip, clipScene, removeXZMovement));
+    return animations;
+}

package/dist/animation/index.d.ts

@@ -0,0 +1,30 @@
+import { VRMHumanBoneName } from '@pixiv/three-vrm';
+import { AnimationClip, Object3D } from 'three';
+import { loadCharacterModel } from '../model/index.js';
+export declare function fixModelAnimationClip(model: Exclude<Awaited<ReturnType<typeof loadCharacterModel>>, undefined>, clip: AnimationClip, clipScene: Object3D, removeXZMovement: boolean, boneMap?: Record<string, VRMHumanBoneName>): void;
+export * from './gltf.js';
+export * from './mixamo.js';
+export * from './vrma.js';
+export * from './utils.js';
+export type ModelAnimationOptions = {
+    type: 'mixamo' | 'gltf' | 'vrma';
+    url: string;
+    removeXZMovement?: boolean;
+    trimTime?: {
+        start?: number;
+        end?: number;
+    };
+    scaleTime?: number;
+};
+export declare function loadCharacterModelAnimation(model: Exclude<Awaited<ReturnType<typeof loadCharacterModel>>, undefined>, options: ModelAnimationOptions): Promise<AnimationClip>;
+declare const simpleCharacterAnimationUrls: {
+    walk: () => Promise<typeof import("../assets/walk.js")>;
+    run: () => Promise<typeof import("../assets/run.js")>;
+    idle: () => Promise<typeof import("../assets/idle.js")>;
+    jumpUp: () => Promise<typeof import("../assets/jump-up.js")>;
+    jumpLoop: () => Promise<typeof import("../assets/jump-loop.js")>;
+    jumpDown: () => Promise<typeof import("../assets/jump-down.js")>;
+    jumpForward: () => Promise<typeof import("../assets/jump-forward.js")>;
+};
+export declare const simpleCharacterAnimationNames: Array<keyof typeof simpleCharacterAnimationUrls>;
+export declare function getSimpleCharacterModelAnimationOptions(animationName: keyof typeof simpleCharacterAnimationUrls): Promise<ModelAnimationOptions>;

package/dist/animation/index.js

@@ -0,0 +1,150 @@
+import { VRM } from '@pixiv/three-vrm';
+import { Euler, Quaternion, QuaternionKeyframeTrack, Vector3, VectorKeyframeTrack, } from 'three';
+import { loadVrmModelGltfAnimations as loadModelGltfAnimations } from './gltf.js';
+import { loadVrmModelMixamoAnimations as loadModelMixamoAnimations } from './mixamo.js';
+import { scaleAnimationClipTime, trimAnimationClip } from './utils.js';
+import { loadVrmModelVrmaAnimations } from './vrma.js';
+import { cached } from '../utils.js';
+const parentWorldVector = new Vector3();
+const restRotationInverse = new Quaternion();
+const parentRestWorldRotation = new Quaternion();
+const parentRestWorldRotationInverse = new Quaternion();
+const quaternion = new Quaternion();
+const vector = new Vector3();
+const nonVrmRotationOffset = new Quaternion().setFromEuler(new Euler(0, Math.PI, 0));
+export function fixModelAnimationClip(model, clip, clipScene, removeXZMovement, boneMap) {
+    const hipsBoneName = boneMap == null ? 'hips' : Object.entries(boneMap).find(([, vrmBoneName]) => vrmBoneName === 'hips')?.[0];
+    if (hipsBoneName == null) {
+        throw new Error('Failed to determine hips bone name for VRM animation. Please check the bone map or animation file.');
+    }
+    const clipSceneHips = clipScene.getObjectByName(hipsBoneName);
+    const vrmHipsPosition = model instanceof VRM ? model.humanoid.normalizedRestPose.hips?.position : clipSceneHips?.position;
+    if (clipSceneHips == null || vrmHipsPosition == null) {
+        throw new Error('Failed to load VRM animation: missing animation hips object or VRM hips position.');
+    }
+    // Adjust with reference to hips height.
+    const motionHipsHeight = clipSceneHips.position.y;
+    const [_, vrmHipsHeight] = vrmHipsPosition;
+    const hipsPositionScale = vrmHipsHeight / motionHipsHeight;
+    for (const track of clip.tracks) {
+        // Convert each tracks for VRM use, and push to `tracks`
+        const [boneName, propertyName] = track.name.split('.');
+        const vrmBoneName = boneMap?.[boneName] ?? boneName;
+        const vrmNodeName = model instanceof VRM ? model.humanoid.getNormalizedBoneNode(vrmBoneName)?.name : vrmBoneName;
+        const bone = clipScene.getObjectByName(boneName);
+        if (vrmNodeName == null || bone == null || bone.parent == null) {
+            continue;
+        }
+        bone.getWorldQuaternion(restRotationInverse).invert();
+        bone.parent.getWorldQuaternion(parentRestWorldRotation);
+        parentRestWorldRotationInverse.copy(parentRestWorldRotation).invert();
+        bone.parent.getWorldPosition(parentWorldVector);
+        if (track instanceof QuaternionKeyframeTrack) {
+            // Store rotations of rest-pose.
+            for (let i = 0; i < track.values.length; i += 4) {
+                quaternion.fromArray(track.values, i);
+                if (model instanceof VRM) {
+                    quaternion.premultiply(parentRestWorldRotation).multiply(restRotationInverse);
+                    if (model.meta.metaVersion === '0') {
+                        quaternion.x *= -1;
+                        quaternion.z *= -1;
+                    }
+                }
+                if (vrmBoneName === 'root') {
+                    quaternion.multiply(nonVrmRotationOffset);
+                }
+                if (removeXZMovement) {
+                    //TODO
+                }
+                quaternion.toArray(track.values, i);
+            }
+            track.name = `${vrmNodeName}.${propertyName}`;
+        }
+        else if (track instanceof VectorKeyframeTrack) {
+            track.name = `${vrmNodeName}.${propertyName}`;
+            if (propertyName === 'scale') {
+                continue;
+            }
+            for (let i = 0; i < track.values.length; i += 3) {
+                vector.fromArray(track.values, i);
+                vector.multiplyScalar(hipsPositionScale);
+                if (model instanceof VRM) {
+                    if (model.meta.metaVersion === '0') {
+                        vector.negate();
+                        vector.y *= -1;
+                    }
+                }
+                if (vrmBoneName === 'hips' && removeXZMovement) {
+                    vector.x = 0;
+                    vector.z = 0;
+                }
+                vector.toArray(track.values, i);
+            }
+        }
+    }
+}
+export * from './gltf.js';
+export * from './mixamo.js';
+export * from './vrma.js';
+export * from './utils.js';
+async function uncachedLoadModelAnimation(model, type, url, removeXZMovement, trimStartTime, trimEndTime, scaleTime) {
+    let clips;
+    switch (type) {
+        case 'gltf':
+            clips = await loadModelGltfAnimations(model, url, removeXZMovement);
+            break;
+        case 'mixamo':
+            clips = await loadModelMixamoAnimations(model, url, removeXZMovement);
+            break;
+        case 'vrma':
+            if (!(model instanceof VRM)) {
+                throw new Error(`Model must be an instance of VRM to load VRMA animations`);
+            }
+            clips = await loadVrmModelVrmaAnimations(model, url, removeXZMovement);
+            break;
+    }
+    if (clips.length != 1) {
+        throw new Error(`Expected exactly one animation clip, but got ${clips.length} for url ${url}`);
+    }
+    const [clip] = clips;
+    if (trimStartTime != null || trimEndTime != null) {
+        trimAnimationClip(clip, trimStartTime, trimEndTime);
+    }
+    if (scaleTime != null) {
+        scaleAnimationClipTime(clip, scaleTime);
+    }
+    return clip;
+}
+export function loadCharacterModelAnimation(model, options) {
+    return cached(uncachedLoadModelAnimation, [
+        model,
+        options.type,
+        options.url,
+        options.removeXZMovement ?? false,
+        options.trimTime?.start,
+        options.trimTime?.end,
+        options.scaleTime,
+    ]);
+}
+const extraOptions = {
+    walk: { scaleTime: 0.5 },
+    run: { scaleTime: 0.8 },
+    jumpForward: { scaleTime: 0.9 },
+};
+const simpleCharacterAnimationUrls = {
+    walk: () => import('../assets/walk.js'),
+    run: () => import('../assets/run.js'),
+    idle: () => import('../assets/idle.js'),
+    jumpUp: () => import('../assets/jump-up.js'),
+    jumpLoop: () => import('../assets/jump-loop.js'),
+    jumpDown: () => import('../assets/jump-down.js'),
+    jumpForward: () => import('../assets/jump-forward.js'),
+};
+export const simpleCharacterAnimationNames = Object.keys(simpleCharacterAnimationUrls);
+export async function getSimpleCharacterModelAnimationOptions(animationName) {
+    return {
+        type: 'gltf',
+        ...extraOptions[animationName],
+        url: (await simpleCharacterAnimationUrls[animationName]()).url,
+    };
+}

package/dist/animation/mixamo-bone-map.json

@@ -0,0 +1,54 @@
+{
+    "mixamorigHips": "hips",
+    "mixamorigSpine": "spine",
+    "mixamorigSpine1": "chest",
+    "mixamorigSpine2": "upperChest",
+    "mixamorigNeck": "neck",
+    "mixamorigHead": "head",
+    "mixamorigLeftShoulder": "leftShoulder",
+    "mixamorigLeftArm": "leftUpperArm",
+    "mixamorigLeftForeArm": "leftLowerArm",
+    "mixamorigLeftHand": "leftHand",
+    "mixamorigLeftHandThumb1": "leftThumbMetacarpal",
+    "mixamorigLeftHandThumb2": "leftThumbProximal",
+    "mixamorigLeftHandThumb3": "leftThumbDistal",
+    "mixamorigLeftHandIndex1": "leftIndexProximal",
+    "mixamorigLeftHandIndex2": "leftIndexIntermediate",
+    "mixamorigLeftHandIndex3": "leftIndexDistal",
+    "mixamorigLeftHandMiddle1": "leftMiddleProximal",
+    "mixamorigLeftHandMiddle2": "leftMiddleIntermediate",
+    "mixamorigLeftHandMiddle3": "leftMiddleDistal",
+    "mixamorigLeftHandRing1": "leftRingProximal",
+    "mixamorigLeftHandRing2": "leftRingIntermediate",
+    "mixamorigLeftHandRing3": "leftRingDistal",
+    "mixamorigLeftHandPinky1": "leftLittleProximal",
+    "mixamorigLeftHandPinky2": "leftLittleIntermediate",
+    "mixamorigLeftHandPinky3": "leftLittleDistal",
+    "mixamorigRightShoulder": "rightShoulder",
+    "mixamorigRightArm": "rightUpperArm",
+    "mixamorigRightForeArm": "rightLowerArm",
+    "mixamorigRightHand": "rightHand",
+    "mixamorigRightHandPinky1": "rightLittleProximal",
+    "mixamorigRightHandPinky2": "rightLittleIntermediate",
+    "mixamorigRightHandPinky3": "rightLittleDistal",
+    "mixamorigRightHandRing1": "rightRingProximal",
+    "mixamorigRightHandRing2": "rightRingIntermediate",
+    "mixamorigRightHandRing3": "rightRingDistal",
+    "mixamorigRightHandMiddle1": "rightMiddleProximal",
+    "mixamorigRightHandMiddle2": "rightMiddleIntermediate",
+    "mixamorigRightHandMiddle3": "rightMiddleDistal",
+    "mixamorigRightHandIndex1": "rightIndexProximal",
+    "mixamorigRightHandIndex2": "rightIndexIntermediate",
+    "mixamorigRightHandIndex3": "rightIndexDistal",
+    "mixamorigRightHandThumb1": "rightThumbMetacarpal",
+    "mixamorigRightHandThumb2": "rightThumbProximal",
+    "mixamorigRightHandThumb3": "rightThumbDistal",
+    "mixamorigLeftUpLeg": "leftUpperLeg",
+    "mixamorigLeftLeg": "leftLowerLeg",
+    "mixamorigLeftFoot": "leftFoot",
+    "mixamorigLeftToeBase": "leftToes",
+    "mixamorigRightUpLeg": "rightUpperLeg",
+    "mixamorigRightLeg": "rightLowerLeg",
+    "mixamorigRightFoot": "rightFoot",
+    "mixamorigRightToeBase": "rightToes"
+}

package/dist/animation/mixamo.d.ts

@@ -0,0 +1,3 @@
+import { AnimationClip } from 'three';
+import { loadCharacterModel } from '../model/index.js';
+export declare function loadVrmModelMixamoAnimations(model: Exclude<Awaited<ReturnType<typeof loadCharacterModel>>, undefined>, url: string, removeXZMovement: boolean): Promise<Array<AnimationClip>>;

package/dist/animation/mixamo.js

@@ -0,0 +1,9 @@
+import { FBXLoader } from 'three/examples/jsm/Addons.js';
+import { fixModelAnimationClip } from './index.js';
+import mixamoBoneMap from './mixamo-bone-map.json';
+const loader = new FBXLoader();
+export async function loadVrmModelMixamoAnimations(model, url, removeXZMovement) {
+    const clipScene = await loader.loadAsync(url);
+    clipScene.animations.forEach((clip) => fixModelAnimationClip(model, clip, clipScene, removeXZMovement, mixamoBoneMap));
+    return clipScene.animations;
+}

package/dist/animation/utils.d.ts

@@ -0,0 +1,3 @@
+import { AnimationClip } from 'three';
+export declare function trimAnimationClip(originalClip: AnimationClip, startTime?: number, endTime?: number): void;
+export declare function scaleAnimationClipTime(originalClip: AnimationClip, scale: number): void;

package/dist/animation/utils.js

@@ -0,0 +1,28 @@
+const changeSymbol = Symbol('was-changed');
+function wasAlreadyChanged(value, id) {
+    if (value[changeSymbol] === id) {
+        return true;
+    }
+    value[changeSymbol] = id;
+}
+export function trimAnimationClip(originalClip, startTime = 0, endTime = originalClip.duration) {
+    const changeId = Math.random();
+    originalClip.duration = endTime - startTime;
+    originalClip.tracks.forEach((track) => {
+        if (wasAlreadyChanged(track.times, changeId)) {
+            return;
+        }
+        track.shift(-startTime);
+        track.trim(0, originalClip.duration);
+    });
+}
+export function scaleAnimationClipTime(originalClip, scale) {
+    const changeId = Math.random();
+    originalClip.duration *= scale;
+    originalClip.tracks.forEach((track) => {
+        if (wasAlreadyChanged(track.times, changeId)) {
+            return;
+        }
+        track.scale(scale);
+    });
+}

package/dist/animation/vrma.d.ts

@@ -0,0 +1,3 @@
+import { VRM } from '@pixiv/three-vrm';
+import { AnimationClip } from 'three';
+export declare function loadVrmModelVrmaAnimations(vrm: VRM, url: string, removeXZMovement: boolean): Promise<Array<AnimationClip>>;

package/dist/animation/vrma.js

@@ -0,0 +1,8 @@
+import { createVRMAnimationClip } from '@pixiv/three-vrm-animation';
+import { vrmaLoader } from '../index.js';
+export async function loadVrmModelVrmaAnimations(vrm, url, removeXZMovement) {
+    const animations = await vrmaLoader.loadAsync(url);
+    const vrmAnimations = animations.userData.vrmAnimations;
+    const clips = vrmAnimations.map((vrmAnimation) => createVRMAnimationClip(vrmAnimation, vrm));
+    return clips;
+}