Merge pull request #51 from Byongho96/master

update docs

CHANGELOG.md

@@ -0,0 +1,61 @@
+# 1.0.0 (2025-01-14)
+
+
+### Bug Fixes
+
+* add jump up, jump down feature, delete jump asset ([#20](https://github.com/Byongho96/three-game-controls/issues/20)) ([984a75a](https://github.com/Byongho96/three-game-controls/commit/984a75a2687665f5ef5715ee4eb08ee170052708))
+* change default rotateSpeed ([22cd0ee](https://github.com/Byongho96/three-game-controls/commit/22cd0eeeb7e96447d54dca46e6a4971b3d001f38))
+* check if jump key is pressed to prevent unintended jump animation ([98ad67d](https://github.com/Byongho96/three-game-controls/commit/98ad67df36e4e0f3ed781e685e1aae050b36a4c8))
+* correct incorrect file paths ([#35](https://github.com/Byongho96/three-game-controls/issues/35)) ([befa87b](https://github.com/Byongho96/three-game-controls/commit/befa87b8a036cdba944036e22bd7de43a35796d9))
+* fix handler bindings and remove unnecessary code ([a0739ae](https://github.com/Byongho96/three-game-controls/commit/a0739ae6d9756487d19a969df6cfa768997a909a))
+* fix option name, avoid redundant object creation ([134a396](https://github.com/Byongho96/three-game-controls/commit/134a3963b1ac28a056040afb782c71c7ad60934e))
+* fix updateSync, updateCamera function ([e98840e](https://github.com/Byongho96/three-game-controls/commit/e98840e078db3f0fc4eabd6036ff3b366dc21f3b))
+* fixed issue with axisSync never not working in ThirdPersonMouseDragControls ([5204e86](https://github.com/Byongho96/three-game-controls/commit/5204e866575fc65cfa822eb9560d27ffe2912c80))
+* fixed issue with axisSync never not working in ThirdPersonPointerLockControls ([32e0098](https://github.com/Byongho96/three-game-controls/commit/32e00983327aba1b6f35c96acb94076c91980e0f))
+* prevent monsters from running to target while dying ([f12a42c](https://github.com/Byongho96/three-game-controls/commit/f12a42c01618160c61b8135a4b0405ed4912d8e6))
+* remove redundant parameter descriptions from comments ([6f4a210](https://github.com/Byongho96/three-game-controls/commit/6f4a2109553fdff700397b98ebe48b96e28cc2ab))
+* remove unnecessary variable ([b70e57d](https://github.com/Byongho96/three-game-controls/commit/b70e57d4e7461ed36ddc0660d98abc7fa427bc2c))
+* resolve issue where monsters do not disappear from the scene upon death ([50bbaf8](https://github.com/Byongho96/three-game-controls/commit/50bbaf8654ec7007b6766a6a85e8a348179078b9))
+* resolve rendering issue when the gamepad inputsource cannot be found ([#19](https://github.com/Byongho96/three-game-controls/issues/19)) ([5cd1d09](https://github.com/Byongho96/three-game-controls/commit/5cd1d09d8b2fba4d559d680d2f7248b8e594c714))
+* shoot example page enable VR ([#16](https://github.com/Byongho96/three-game-controls/issues/16)) ([0a2c314](https://github.com/Byongho96/three-game-controls/commit/0a2c31468e5097e043053f1d1d60f3b7e98776eb))
+* unify key input types and rename function ([ac2a04d](https://github.com/Byongho96/three-game-controls/commit/ac2a04d46251147acf1940460f6c5528bbc8848f))
+* update conditions for playing idle animation ([25e4f5e](https://github.com/Byongho96/three-game-controls/commit/25e4f5edaca2750b9d1d2215d950a67161920cc6))
+* update rotation direction for third-person keyboard controls ([6886d3d](https://github.com/Byongho96/three-game-controls/commit/6886d3da1e4dd6ff05827aff73b928e249baf101))
+
+
+### Features
+
+* add acceleration feature to controls and animations ([#14](https://github.com/Byongho96/three-game-controls/issues/14)) ([33fcf2b](https://github.com/Byongho96/three-game-controls/commit/33fcf2b1618da3239230b95a46fdee080a5b91fb))
+* add camera position Lerp (third person mouse drag controls) ([6a15d02](https://github.com/Byongho96/three-game-controls/commit/6a15d020bbc83e8415138ba4c4e1ff8e439acdd3))
+* add class for managing character animations ([3da9dac](https://github.com/Byongho96/three-game-controls/commit/3da9dacaea8217fc603825dcf10deed0584576e4))
+* add collision detection between user and monster ([1957e71](https://github.com/Byongho96/three-game-controls/commit/1957e7105026bceaca5291d5f5705f983c1ecd05))
+* add collision detection between worldMap and moster ([8163cb9](https://github.com/Byongho96/three-game-controls/commit/8163cb998e51b58068ece6be0a952bc3895edbce))
+* add control features, fix issues, and improve code readability ([75d7903](https://github.com/Byongho96/three-game-controls/commit/75d79035e67425c3cf2a8949b4782606b6f17636))
+* add dispose method to healthbar ([87985d3](https://github.com/Byongho96/three-game-controls/commit/87985d3e81cb522790364c44407992eb9757c298))
+* add example page for third-person pointer lock controls ([a4424d5](https://github.com/Byongho96/three-game-controls/commit/a4424d54df586f177e624e482c5e3b0b7fe7a61f))
+* add jump up, jump down animation ([#17](https://github.com/Byongho96/three-game-controls/issues/17)) ([c798795](https://github.com/Byongho96/three-game-controls/commit/c7987950fad9a5f950ef9657bf9a900a7dc13e4b))
+* add keyboard input parameters for first-person controls ([2edbc17](https://github.com/Byongho96/three-game-controls/commit/2edbc17ec7b617ef82ae13b666b99f0f241570a9))
+* add min and max zoom constraints ([37b6125](https://github.com/Byongho96/three-game-controls/commit/37b61259d3d4c510b5a87c95ceb34feb6b4515db))
+* add monster attack action ([89d2d37](https://github.com/Byongho96/three-game-controls/commit/89d2d37cdf5fd90eeb2d37441edd327534069309))
+* add monster attackCollider ([f8a1226](https://github.com/Byongho96/three-game-controls/commit/f8a1226a7357899f88fe35a6650a7f147f418577))
+* add monster collider on shoot example page ([2477b1c](https://github.com/Byongho96/three-game-controls/commit/2477b1cb8678e0bbccb7091763bbc4f95155a2aa))
+* add monster health bar ([95a3895](https://github.com/Byongho96/three-game-controls/commit/95a38953ef5a0bc539e0df4b083f466daafccc03))
+* add monsterStore ([ce1c780](https://github.com/Byongho96/three-game-controls/commit/ce1c7800e24b1c3418063743d1e4356a4942aa30))
+* add rotation constraints for the controls ([e6fd220](https://github.com/Byongho96/three-game-controls/commit/e6fd2205e30268a7cb17717a117e2c9f0f36ae6b))
+* add separate clamping for camera angles on upward and downward mouse movements ([e086b71](https://github.com/Byongho96/three-game-controls/commit/e086b71596cc6244927c24c1e74081932725216f))
+* add VR camera control functionality ([#18](https://github.com/Byongho96/three-game-controls/issues/18)) ([0bdcae4](https://github.com/Byongho96/three-game-controls/commit/0bdcae4ac61f5f769e29bdbb0577b9d7a1764453))
+* create physics-based character controller with keyboard inputs ([dd917f7](https://github.com/Byongho96/three-game-controls/commit/dd917f787514167b6bccf34d4e15b62ea049ed7d))
+* create PhysicsCharacterControls class ([a73d609](https://github.com/Byongho96/three-game-controls/commit/a73d609ece1099dad28231a30a145e70f3c110ce))
+* create shooting game example pages ([#15](https://github.com/Byongho96/three-game-controls/issues/15)) ([a39b0a2](https://github.com/Byongho96/three-game-controls/commit/a39b0a20f757eb4926ada2494f8e472200ed5932))
+* first person mouse drag controls ([#7](https://github.com/Byongho96/three-game-controls/issues/7)) ([4394591](https://github.com/Byongho96/three-game-controls/commit/43945919a1757ff4e8f72bb61952afdb7ffbb85c))
+* first person pointerlock controls ([37e15de](https://github.com/Byongho96/three-game-controls/commit/37e15de7c7adf0086d7cc2a507413876d22d25ed))
+* implement gun change and shooting logic with damage handling ([#21](https://github.com/Byongho96/three-game-controls/issues/21)) ([e1654fd](https://github.com/Byongho96/three-game-controls/commit/e1654fddfe4733590efc1bfdb9467ee252d3199a))
+* implement physics controller using octree structure ([edcebae](https://github.com/Byongho96/three-game-controls/commit/edcebae51b86fd00cee82da1b8c4570b4c19b23a))
+* implement precise landing detection for jumpDown execution ([#31](https://github.com/Byongho96/three-game-controls/issues/31)) ([226241c](https://github.com/Byongho96/three-game-controls/commit/226241c8dea307865017f3fc379e2672f764ecef))
+* implement third-person pointer lock controls ([0e887db](https://github.com/Byongho96/three-game-controls/commit/0e887db80d6e6199107c268594cf645b8248b8f0))
+* implement x-axis rotation clamp ([be6f1ac](https://github.com/Byongho96/three-game-controls/commit/be6f1ac461c5ddd321769aeef0c9bef58f32521e))
+* improve PhysicsControls functionality ([1be9af5](https://github.com/Byongho96/three-game-controls/commit/1be9af5c151772b9c90b325cda7c2c00bab9aa45))
+* monster attack ([7262f48](https://github.com/Byongho96/three-game-controls/commit/7262f48cfdc76a09b3bd4d0a68496c1ecebf57f3))
+* moster hit action ([bd364ea](https://github.com/Byongho96/three-game-controls/commit/bd364eaa4f5c8daa5fb0fa41a0da9e607520f694))
+* remove unnecessary getContext, replace hardcoded width and height ([e0aaec0](https://github.com/Byongho96/three-game-controls/commit/e0aaec07604e374bdf1630d1b5605551d2991695))
+* temp ([a9471a4](https://github.com/Byongho96/three-game-controls/commit/a9471a46b9c4e5b17084c265e06067abf87d6d3d))

README.md

@@ -166,8 +166,8 @@ Promise.all( [
   gltfLoader.loadAsync( 'collision-world.glb' ),
   gltfLoader.loadAsync( 'x-bot.glb' ),
   gltfLoader.loadAsync( 'ani-idle.glb' ),
-  gltfLoader.loadAsync( 'run_forward.glb' ),
   gltfLoader.loadAsync( 'ani-forward.glb' ),
+  gltfLoader.loadAsync( 'ani-forward-fast.glb' ),
   gltfLoader.loadAsync( 'ani-jump-up.glb' ),
   gltfLoader.loadAsync( 'ani-land.glb' ),
   gltfLoader.loadAsync( 'ani-fall.glb' )

package.json

@@ -1,6 +1,6 @@
 {
   "name": "three-game-controls",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "game controls for three.js",
   "main": "dist/bundle.cjs.js",
   "module": "dist/bundle.esm.js",

public/docs/api/core/PhysicsControls.html

@@ -55,7 +55,7 @@ <h3>[property:Number landTimeThreshold]</h3>
 
 		<h3>[property:Number landTolerance]</h3>
 		<p>
-			The distance tolerance for landing detection, measured as the vertical distance from the ground surface. Default is `0.2`.
+			The distance tolerance for landing detection, measured as the vertical distance from the ground surface. Default is `0.6`.
 		</p>
 
 		<h3>[property:Number maxFallSpeed]</h3>

public/docs/api/first-person/FPKeyDragControls.html

@@ -33,8 +33,7 @@ <h2>Mixins</h2>
 		<h3>[page:KeyboardMixin KeyboardMixin]</h3>
 
 		<p>
-			Provide Keyboard API for controlling the object.<br/>
-			`keyToActions` is overwritten:
+			Provide Keyboard API for controlling the object.
 		</p>
 
 		<h3>[page:DragMixin DragMixin]</h3>

public/docs/api/first-person/FPKeyPointerLockControls.html

@@ -36,8 +36,7 @@ <h2>Mixins</h2>
 		<h3>[page:KeyboardMixin KeyboardMixin]</h3>
 
 		<p>
-			Provide Keyboard API for controlling the object.<br/>
-			`keyToActions` is overwritten:
+			Provide Keyboard API for controlling the object.
 		</p>
 
 		<h3>[page:PointerLockMixin PointerLockMixin]</h3>

public/docs/api/mixins/GyroMixin.html

@@ -0,0 +1,97 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<base href="../../" />
+		<script src="page.js"></script>
+		<link type="text/css" rel="stylesheet" href="page.css" />
+	</head>
+	<body>
+		<h1>[name]</h1>
+
+		<p class="desc">
+      A mixin that extends `FirstPersonControls` to add device orientation-based controls. This mixin uses device gyroscope data to control actions along the X, Y, and Z axes, enabling motion-based interactions.
+    </p>
+
+    <h2>Constructor</h2>
+
+		<h3>[name]( [param:FirstPersonControls base] )</h3>
+		<p>
+			[page:FirstPersonControls base] — A class that extends `FirstPersonControls`.
+		</p>
+
+    <h2>Properties</h2>
+
+    <h3>[property:Array gyroXActions]</h3>
+    <p>
+			An array of actions triggered by gyroscope movement along the X-axis. Default is `['MOVE_BACKWARD']`.
+    </p>
+
+		<h3>[property:Number gyroXOffset]</h3>
+		<p>
+			Reference value for the gyroscope's X-axis orientation. Default: `0`.
+		</p>
+
+		<h3>[property:Number gyroXMultiplier]</h3>
+		<p>
+			The multiplier for the x-axis orientation. Default: `0.1`.
+		</p>
+
+    <h3>[property:Array gyroYActions]</h3>
+    <p>
+      An array of actions triggered by gyroscope movement along the Y-axis. Default is `['MOVE_RIGHTWARD']`.
+    </p>
+
+		<h3>[property:Number gyroYOffset]</h3>
+		<p>
+			Reference value for the gyroscope's Y-axis orientation. Default: `0`.
+		</p>
+
+		<h3>[property:Number gyroYMultiplier]</h3>
+		<p>
+			The multiplier for the y-axis orientation. Default: `0.1`.
+		</p>
+
+    <h3>[property:Array gyroZActions]</h3>
+    <p>
+			An array of actions triggered by gyroscope movement along the Z-axis. Default is `[]`.
+    </p>
+
+    <h3>[property:Number gyroZOffset]</h3>
+    <p>
+      Reference value for the gyroscope's Z-axis orientation. Default: `0`.
+    </p>
+
+
+		<h3>[property:Number gyroZMultiplier]</h3>
+		<p>
+			The multiplier for the z-axis orientation. Default: `0.1`.
+		</p>
+
+    <h3>[property:Boolean needsResetOrientation]</h3>
+    <p>
+      Determines whether the reference values for orientation (`gyroXOffset`, `gyroYOffset`, `gyroZOffset`) should be reset on the next device orientation event. Default: `true`.
+    </p>
+
+		<h2>Methods</h2>
+
+		<h3>[method:void connect]()</h3>
+		<p>
+			Connects the drag functionality by adding event listeners.
+		</p>
+
+		<h3>[method:void disconnect]()</h3>
+		<p>
+			Disconnects the drag functionality by removing event listeners.
+		</p>
+
+		<h3>[method:void dispose]()</h3>
+		<p>
+			Disposes of the drag functionality by cleaning up event listeners and resources.
+		</p>
+
+		<h2>Source</h2>
+
+		<p>[link:https://github.com/Byongho96/three-game-controls/blob/master/src/mixins/GyroMixin.ts mixins/GyroMixin.ts]</p>
+	</body>
+</html>

public/docs/api/third-person/TPKeyDragControls.html

@@ -48,10 +48,9 @@ <h2>Mixins</h2>
 		<h3>[page:KeyboardMixin KeyboardMixin]</h3>
 
 		<p>
-			Provide Keyboard API for controlling the object.<br/>
-			`keyToActions` is overwritten:
+			Provide Keyboard API for controlling the object.
 		</p>
-
+		
 		<h3>[page:DragMixin DragMixin]</h3>
 
 		<p>

public/docs/api/third-person/TPKeyPointerLockControls.html

@@ -48,8 +48,7 @@ <h2>Mixins</h2>
 		<h3>[page:KeyboardMixin KeyboardMixin]</h3>
 
 		<p>
-			Provide Keyboard API for controlling the object.<br/>
-			`keyToActions` is overwritten:
+			Provide Keyboard API for controlling the object.
 		</p>
 
 		<h3>[page:PointerLockMixin PointerLockMixin]</h3>

public/docs/list.json

@@ -37,6 +37,7 @@
 
     "Mixins": {
       "DragMixin": "api/mixins/DragMixin",
+      "GyroMixin": "api/mixins/GyroMixin",
       "KeyboardMixin": "api/mixins/KeyboardMixin",
       "PointerLockMixin": "api/mixins/PointerLockMixin"
     }

public/docs/manual/Quick-Start.html

@@ -153,8 +153,8 @@ <h2>ThirdPersonControls</h2>
 			gltfLoader.loadAsync( 'collision-world.glb' ),
 			gltfLoader.loadAsync( 'x-bot.glb' ),
 			gltfLoader.loadAsync( 'ani-idle.glb' ),
-			gltfLoader.loadAsync( 'run_forward.glb' ),
 			gltfLoader.loadAsync( 'ani-forward.glb' ),
+			gltfLoader.loadAsync( 'ani-forward-fast.glb' ),
 			gltfLoader.loadAsync( 'ani-jump-up.glb' ),
 			gltfLoader.loadAsync( 'ani-land.glb' ),
 			gltfLoader.loadAsync( 'ani-fall.glb' )

public/examples/files.json

@@ -8,6 +8,7 @@
   "ThirdPerson": [
     "third-person_keyboard_controls",
     "third-person_mousedrag_controls",
-    "third-person_pointerlock_controls"
+    "third-person_pointerlock_controls",
+    "third-person_gyroscope_mixins"
   ]
 }

public/examples/first-person_keyboard_controls.html

@@ -18,7 +18,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../dist/bundle.esm.js"
 				}
 			}
 		</script>

public/examples/first-person_mousedrag_controls.html

@@ -18,7 +18,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../dist/bundle.esm.js"
 				}
 			}
 		</script>

public/examples/first-person_pointerlock_controls.html

@@ -18,7 +18,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../dist/bundle.esm.js"
 				}
 			}
 		</script>

public/examples/shoot/first-person_pointerlock_shooting.html

@@ -5,6 +5,7 @@
 		<meta charset="utf-8" />
 		<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0" />
 		<link type="text/css" rel="stylesheet" href="../main.css" />
+		<link type="text/css" rel="stylesheet" href="./styles.css" />
 	</head>
 	<body>
 		<div id="info">Kill the monsters by clicking on them</div>
@@ -16,7 +17,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../../dist/bundle.esm.js"
 				}
 			}
 		</script>

public/examples/shoot/first-person_pointerlock_shooting_vr.html

@@ -5,6 +5,7 @@
 		<meta charset="utf-8" />
 		<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0" />
 		<link type="text/css" rel="stylesheet" href="main.css" />
+		<link type="text/css" rel="stylesheet" href="./styles.css" />
 	</head>
 	<body>
 		<div id="info">Kill the monsters by clicking on them</div>
@@ -16,7 +17,7 @@
 				"imports": {
 					"three": "https://cdn.jsdelivr.net/npm/[email protected]/build/three.module.js",
 					"three/addons/": "https://cdn.jsdelivr.net/npm/[email protected]/examples/jsm/",
-					"three-game-controls": "https://cdn.jsdelivr.net/npm/three-game-controls/dist/bundle.esm.js"
+					"three-game-controls": "../../../dist/bundle.esm.js"
 				}
 			}
 		</script>

public/examples/shoot/styles.css

@@ -0,0 +1,29 @@
+#cross {
+  position: fixed;
+  top: 50%;
+  left: 50%;
+  transform: translate(-50%, -50%);
+  width: 50px;
+  height: 50px;
+  pointer-events: none;
+}
+#cross::before,
+#cross::after {
+  content: '';
+  position: absolute;
+  background-color: rgba(68, 68, 68, 0.61);
+}
+#cross::before {
+  top: 0;
+  left: 50%;
+  transform: translateX(-50%);
+  width: 4px;
+  height: 100%;
+}
+#cross::after {
+  top: 50%;
+  left: 0;
+  transform: translateY(-50%);
+  width: 100%;
+  height: 4px;
+}