three-player-controller 0.2.51 → 0.2.52

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 three-player-controller author
+
+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

@@ -2,6 +2,8 @@
 
 # three-player-controller
 
+[![NPM Package][npm]][npm-url]
+
 轻量的第三人称 / 第一人称玩家控制器，开箱即用，基于 three.js 和 three-mesh-bvh 实现人物胶囊体碰撞、BVH 碰撞检测、人物动画、第一/三人称切换与相机避障。
 
 # 安装
@@ -12,8 +14,11 @@ npm install three-player-controller
 
 # 示例
 
-[glb 场景](https://hh-hang.github.io/three-player-controller/index.html)
-[3dtiles 场景](https://hh-hang.github.io/three-player-controller/3dtilesScene.html)
+- [glb 场景](https://hh-hang.github.io/three-player-controller/index.html)
+
+- [3dtiles 场景](https://hh-hang.github.io/three-player-controller/3dtilesScene.html)
+
+- [3dtiles 自定义](https://hh-hang.github.io/three-player-controller/3dtilesCustomize.html)
 
 ### 普通控制
 
@@ -37,18 +42,18 @@ const player = playerController();
 
 // 初始化玩家控制器
 player.init({
-  scene, // three.js 场景
-  camera, // three.js 相机
-  controls, // three.js 控制器
-  playerModel: {
-    url: "./glb/person.glb", // 模型路径
-    scale: 0.001, // 模型缩放
-    idleAnim: "Idle_2", // 默认 Idle 动画名字
-    walkAnim: "Walking_11", // 默认 Walk 动画名字
-    runAnim: "Running_9", // 默认 Run 动画名字
-    jumpAnim: "Jump_3", // 默认 Jump 动画名字
-  },
-  initPos: pos, // 初始位置
+    scene, // three.js 场景
+    camera, // three.js 相机
+    controls, // three.js 控制器
+    playerModel: {
+        url: "./glb/person.glb", // 模型路径
+        scale: 0.001, // 模型缩放
+        idleAnim: "Idle_2", // 默认 Idle 动画名字
+        walkAnim: "Walking_11", // 默认 Walk 动画名字
+        runAnim: "Running_9", // 默认 Run 动画名字
+        jumpAnim: "Jump_3", // 默认 Jump 动画名字
+    },
+    initPos: pos, // 初始位置
 });
 
 // 渲染循环调用
@@ -63,11 +68,11 @@ player.update();
 
 ```ts
 export function playerController(): {
-  init: (opts: PlayerControllerOptions, callback?: () => void) => void;
-  changeView: () => void;
-  reset: (pos?: THREE.Vector3) => void;
-  update: (dt?: number) => void;
-  destroy: () => void;
+    init: (opts: PlayerControllerOptions, callback?: () => void) => void;
+    changeView: () => void;
+    reset: (pos?: THREE.Vector3) => void;
+    update: (dt?: number) => void;
+    destroy: () => void;
 };
 ```
 
@@ -100,7 +105,7 @@ export function offAllEvent(): void; // 关闭所有输入事件
 - `onAllEvent()`：确保控制器存在并打开输入监听。
 - `offAllEvent()`：关闭输入监听（用于显示 UI 或暂停时禁止玩家输入）。
 
-  默认处理包括：WASD 移动、奔跑、跳跃、鼠标视角等。
+    默认处理包括：WASD 移动、奔跑、跳跃、鼠标视角等。
 
 ---
 
@@ -110,30 +115,30 @@ export function offAllEvent(): void; // 关闭所有输入事件
 
 ```ts
 type PlayerControllerOptions = {
-  scene: THREE.Scene;
-  camera: THREE.PerspectiveCamera;
-  controls: OrbitControls;
-  playerModel: {
-    url: string;
-    idleAnim: string;
-    walkAnim: string;
-    runAnim: string;
-    jumpAnim: string;
-    leftWalkAnim?: string;
-    rightWalkAnim?: string;
-    backwardAnim?: string;
-    flyAnim?: string;
-    flyIdleAnim?: string;
-    scale: number;
-    gravity?: number;
-    jumpHeight?: number;
-    speed?: number;
-  };
-  initPos?: THREE.Vector3;
-  mouseSensity?: number;
-  minCamDistance?: number;
-  maxCamDistance?: number;
-  colliderMeshUrl?: string;
+    scene: THREE.Scene;
+    camera: THREE.PerspectiveCamera;
+    controls: OrbitControls;
+    playerModel: {
+        url: string;
+        idleAnim: string;
+        walkAnim: string;
+        runAnim: string;
+        jumpAnim: string;
+        leftWalkAnim?: string;
+        rightWalkAnim?: string;
+        backwardAnim?: string;
+        flyAnim?: string;
+        flyIdleAnim?: string;
+        scale: number;
+        gravity?: number;
+        jumpHeight?: number;
+        speed?: number;
+    };
+    initPos?: THREE.Vector3;
+    mouseSensity?: number;
+    minCamDistance?: number;
+    maxCamDistance?: number;
+    colliderMeshUrl?: string;
 };
 ```
 
@@ -164,3 +169,6 @@ type PlayerControllerOptions = {
 [three-mesh-bvh](https://github.com/gkjohnson/three-mesh-bvh)
 
 [three](https://github.com/mrdoob/three.js)
+
+[npm]: https://img.shields.io/npm/v/three-player-controller
+[npm-url]: https://www.npmjs.com/package/three-player-controller

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "three-player-controller",
-  "version": "0.2.51",
+  "version": "0.2.52",
   "description": "Third-person / first-person player controller for three.js (three-mesh-bvh based)",
   "author": "",
   "license": "MIT",
@@ -39,5 +39,10 @@
   "dependencies": {
     "3d-tiles-renderer": "^0.4.19",
     "nipplejs": "^0.10.2"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hh-hang/three-player-controller"
+  },
+  "homepage": "https://github.com/hh-hang/three-player-controller"
 }