Update Physics Movement to v0.2.0:

- updated project to Godot v4.2
- player rotation moved to _physics_process and fixed visual glitching
- extended thrusters to work in 4 directions and moved controls to left joystick
- added thrusters brake
- created custom OpenXR action map with Touch controller bindings
- added finger micromovement: fingers now wiggle a little when hand is moving
- updated project to work properly on Meta Quest 3: increased physics tick rate to 144Hz, disabled v-sync and switched WorldEnvironment from clear color to procedural sky in example scenes

Author: patrykkalinowski

README.MD

@@ -17,11 +17,14 @@ Physics-based XR movement. Player hands collide with environment and can grab or
   - Fingers curl around grabbed objects geometry
 - Players can move themselves by pushing away from objects
   - Heavier objects allow for stronger push
-- Players can move in space with thrusters (button activated)
+- Players can move in space with thrusters
+- Players can brake in space with thruster brake
 - Players can hit objects with their head and push themselves away
 - Ghost hand appears when controller hand gets far from physics one
+- Physics hand is teleported to controller position if it gets too far from it (ex. hand got stuck)
 - Body snap rotation
 - Body XYZ rotation around static object using hands (trigger activated)
+- Fingers wiggle a little when hand is moving
 
 [Read more](/addons/xr-kit/physics-movement/)
 
@@ -92,6 +95,7 @@ For plugin to be fully compatible with all OpenXR runtimes, it needs hand models
 
 | Headset | Runtime | Compatible |
 |---|---|:---:|
+| Meta Quest 3 | SteamVR | Yes |
 | HP Reverb G2 | SteamVR | Yes |
 | Pico 4 | Standalone | No hand tracking |
 | Meta Quest 2 | Standalone | Hand tracking only (no controllers)

addons/xr-kit/README.MD

@@ -17,11 +17,14 @@ Physics-based XR movement. Player hands collide with environment and can grab or
   - Fingers curl around grabbed objects geometry
 - Players can move themselves by pushing away from objects
   - Heavier objects allow for stronger push
-- Players can move in space with thrusters (button activated)
+- Players can move in space with thrusters
+- Players can brake in space with thruster brake
 - Players can hit objects with their head and push themselves away
 - Ghost hand appears when controller hand gets far from physics one
+- Physics hand is teleported to controller position if it gets too far from it (ex. hand got stuck)
 - Body snap rotation
 - Body XYZ rotation around static object using hands (trigger activated)
+- Fingers wiggle a little when hand is moving
 
 [Read more](/addons/xr-kit/physics-movement/)
 
@@ -74,7 +77,7 @@ Smooth VR preview for recording in native monitor resolution.
 
 ## Getting started
 
-Repository contains Godot 4.0.2 project with XR and main scene preconfigured. Releases are reduced to addon files only.
+Repository contains Godot 4.2 project with XR and main scene preconfigured. Releases are reduced to addon files only.
 
 Latest release is available in Godot's Asset Library under the name [XR Kit](https://godotengine.org/asset-library/asset/1870) or on [releases page](https://github.com/patrykkalinowski/godot-xr-kit/releases/latest).
 
@@ -92,6 +95,7 @@ For plugin to be fully compatible with all OpenXR runtimes, it needs hand models
 
 | Headset | Runtime | Compatible |
 |---|---|:---:|
+| Meta Quest 3 | SteamVR | Yes |
 | HP Reverb G2 | SteamVR | Yes |
 | Pico 4 | Standalone | No hand tracking |
 | Meta Quest 2 | Standalone | Hand tracking only (no controllers)

addons/xr-kit/examples/playground.tscn

@@ -1,11 +1,15 @@
-[gd_scene load_steps=12 format=3 uid="uid://b5lkb7q5glrr1"]
+[gd_scene load_steps=14 format=3 uid="uid://b5lkb7q5glrr1"]
 
 [ext_resource type="PackedScene" uid="uid://kl4nx8ivav56" path="res://addons/xr-kit/physics-movement/scenes/player.tscn" id="1_4muep"]
 
+[sub_resource type="ProceduralSkyMaterial" id="ProceduralSkyMaterial_bcjol"]
+
+[sub_resource type="Sky" id="Sky_atmsh"]
+sky_material = SubResource("ProceduralSkyMaterial_bcjol")
+
 [sub_resource type="Environment" id="Environment_64oha"]
-ambient_light_source = 2
-ambient_light_color = Color(1, 1, 1, 1)
-ambient_light_energy = 0.2
+background_mode = 2
+sky = SubResource("Sky_atmsh")
 
 [sub_resource type="BoxShape3D" id="BoxShape3D_5q7sa"]
 size = Vector3(0.3, 0.3, 0.3)
@@ -191,8 +195,10 @@ text = "Static
 [node name="Label3D" type="Label3D" parent="."]
 transform = Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0.658925, -1.49391)
 pixel_size = 0.001
-text = "Press B/Y and A/X keys on controller to enable thrusters and move in space
+alpha_antialiasing_mode = 1
+texture_filter = 5
+text = "Move left joystick on controller to enable thrusters and move in space. Click joystick to brake.
 
-Try grabbing objects with different weights and see how they influence your movement
+Try grabbing objects with different weights and see how they influence your movement.
 
-Grab static object and hold trigger to rotate around it in XYZ axis. Try with two hands, too"
+Grab static object and hold trigger to rotate around it in XYZ axis. Try with two hands, too."

addons/xr-kit/examples/smooth_input_filter.tscn

@@ -1,4 +1,4 @@
-[gd_scene load_steps=14 format=3 uid="uid://b700ov8sanfbn"]
+[gd_scene load_steps=16 format=3 uid="uid://b700ov8sanfbn"]
 
 [ext_resource type="Script" path="res://addons/xr-kit/physics-movement/scripts/player.gd" id="1_egmgq"]
 [ext_resource type="PackedScene" uid="uid://dqnmcsaa6hvy3" path="res://addons/xr-kit/smooth-input-filter/scenes/smooth_open_xr_hand.tscn" id="5_2qybv"]
@@ -261,7 +261,14 @@ _surfaces = [{
 }]
 blend_shape_mode = 0
 
+[sub_resource type="ProceduralSkyMaterial" id="ProceduralSkyMaterial_qpdn8"]
+
+[sub_resource type="Sky" id="Sky_554u1"]
+sky_material = SubResource("ProceduralSkyMaterial_qpdn8")
+
 [sub_resource type="Environment" id="Environment_xj8r2"]
+background_mode = 2
+sky = SubResource("Sky_554u1")
 
 [node name="Player" type="Node3D" node_paths=PackedStringArray("origin", "camera")]
 script = ExtResource("1_egmgq")
@@ -282,13 +289,7 @@ tracker = &"left_hand"
 tracker = &"right_hand"
 
 [node name="OpenXRHand Left" type="OpenXRHand" parent="XROrigin3D"]
-_import_path = NodePath("")
-unique_name_in_owner = false
-process_mode = 0
-process_priority = 0
-editor_description = ""
 hand_skeleton = NodePath("Skeleton3D")
-script = null
 
 [node name="Skeleton3D" type="Skeleton3D" parent="XROrigin3D/OpenXRHand Left"]
 bones/0/name = "Wrist_L"
@@ -674,14 +675,8 @@ mesh = SubResource("ArrayMesh_j33p5")
 skin = SubResource("Skin_lvfor")
 
 [node name="OpenXRHand Right" type="OpenXRHand" parent="XROrigin3D"]
-_import_path = NodePath("")
-unique_name_in_owner = false
-process_mode = 0
-process_priority = 0
-editor_description = ""
 hand = 1
 hand_skeleton = NodePath("Skeleton3D")
-script = null
 
 [node name="Skeleton3D" type="Skeleton3D" parent="XROrigin3D/OpenXRHand Right"]
 bones/0/name = "Wrist_R"

addons/xr-kit/physics-movement/README.MD

@@ -15,11 +15,14 @@ Scripts and scenes for physics-based XR movement. Player hands collide with envi
   - Fingers curl around grabbed objects geometry
 - Players can move themselves by pushing away from objects
   - Heavier objects allow for stronger push
-- Players can move in space with thrusters (button activated)
+- Players can move in space with thrusters
+- Players can brake in space with thruster brake
 - Players can hit objects with their head and push themselves away
 - Ghost hand appears when controller hand gets far from physics one
+- Physics hand is teleported to controller position if it gets too far from it (ex. hand got stuck)
 - Body snap rotation
 - Body XYZ rotation around static object using hands (trigger activated)
+- Fingers wiggle a little when hand is moving
 
 ## How does it work
 
@@ -34,6 +37,8 @@ Provided hand models use OpenXR convention of 26 joints for hand tracking: 4 joi
 ![OpenXR Hands](/screenshots/openxr_hands.png)
 *Source: https://registry.khronos.org/OpenXR/specs/1.0/html/xrspec.html#_conventions_of_hand_joints*
 
+Custom OpenXR Action Map is provided for control scheme used by Physics Movement, you can find it in `addons/xr-kit/physics-movement` folder.
+
 ## Getting started
 
 `/addons/xr-kit/physics_movement/scenes/player.tscn` contains everything needed for physics movement, including XR interface initialization.

addons/xr-kit/physics-movement/openxr_action_map.tres

@@ -0,0 +1,92 @@
+[gd_resource type="OpenXRActionMap" load_steps=19 format=3 uid="uid://5b4j7sj3746e"]
+
+[sub_resource type="OpenXRAction" id="OpenXRAction_ug10a"]
+resource_name = "trigger"
+localized_name = "Trigger"
+toplevel_paths = PackedStringArray("/user/hand/left", "/user/hand/right")
+
+[sub_resource type="OpenXRAction" id="OpenXRAction_ikrgt"]
+resource_name = "thruster"
+localized_name = "Thruster"
+action_type = 2
+toplevel_paths = PackedStringArray("/user/hand/left")
+
+[sub_resource type="OpenXRAction" id="OpenXRAction_mrsxk"]
+resource_name = "grip"
+localized_name = "Grip"
+toplevel_paths = PackedStringArray("/user/hand/left", "/user/hand/right")
+
+[sub_resource type="OpenXRAction" id="OpenXRAction_358r6"]
+resource_name = "thruster_brake"
+localized_name = "Thruster Brake"
+action_type = 0
+toplevel_paths = PackedStringArray("/user/hand/left")
+
+[sub_resource type="OpenXRAction" id="OpenXRAction_301i5"]
+resource_name = "rotate"
+localized_name = "Rotate"
+action_type = 2
+toplevel_paths = PackedStringArray("/user/hand/right")
+
+[sub_resource type="OpenXRAction" id="OpenXRAction_lfmcc"]
+resource_name = "grip_click"
+localized_name = "Grip Click"
+action_type = 0
+toplevel_paths = PackedStringArray("/user/hand/left", "/user/hand/right")
+
+[sub_resource type="OpenXRAction" id="OpenXRAction_3j8lo"]
+resource_name = "trigger_click"
+localized_name = "Trigger Click"
+action_type = 0
+toplevel_paths = PackedStringArray("/user/hand/left", "/user/hand/right")
+
+[sub_resource type="OpenXRAction" id="OpenXRAction_qggp4"]
+resource_name = "free_rotation"
+localized_name = "Rotate freely while holding an object"
+action_type = 0
+toplevel_paths = PackedStringArray("/user/hand/left", "/user/hand/right")
+
+[sub_resource type="OpenXRActionSet" id="OpenXRActionSet_mhyx4"]
+resource_name = "xrkit"
+localized_name = "XR Kit Action Set"
+actions = [SubResource("OpenXRAction_ug10a"), SubResource("OpenXRAction_ikrgt"), SubResource("OpenXRAction_mrsxk"), SubResource("OpenXRAction_358r6"), SubResource("OpenXRAction_301i5"), SubResource("OpenXRAction_lfmcc"), SubResource("OpenXRAction_3j8lo"), SubResource("OpenXRAction_qggp4")]
+
+[sub_resource type="OpenXRIPBinding" id="OpenXRIPBinding_rytyh"]
+action = SubResource("OpenXRAction_ikrgt")
+paths = PackedStringArray("/user/hand/left/input/thumbstick")
+
+[sub_resource type="OpenXRIPBinding" id="OpenXRIPBinding_0dw4u"]
+action = SubResource("OpenXRAction_358r6")
+paths = PackedStringArray("/user/hand/left/input/thumbstick/click")
+
+[sub_resource type="OpenXRIPBinding" id="OpenXRIPBinding_ubj08"]
+action = SubResource("OpenXRAction_301i5")
+paths = PackedStringArray("/user/hand/right/input/thumbstick")
+
+[sub_resource type="OpenXRIPBinding" id="OpenXRIPBinding_icpc6"]
+action = SubResource("OpenXRAction_ug10a")
+paths = PackedStringArray("/user/hand/left/input/trigger/value", "/user/hand/right/input/trigger/value")
+
+[sub_resource type="OpenXRIPBinding" id="OpenXRIPBinding_bmyjf"]
+action = SubResource("OpenXRAction_mrsxk")
+paths = PackedStringArray("/user/hand/left/input/squeeze/value", "/user/hand/right/input/squeeze/value")
+
+[sub_resource type="OpenXRIPBinding" id="OpenXRIPBinding_dsmkp"]
+action = SubResource("OpenXRAction_lfmcc")
+paths = PackedStringArray("/user/hand/left/input/squeeze/value", "/user/hand/right/input/squeeze/value")
+
+[sub_resource type="OpenXRIPBinding" id="OpenXRIPBinding_ghpoo"]
+action = SubResource("OpenXRAction_3j8lo")
+paths = PackedStringArray("/user/hand/left/input/trigger/value", "/user/hand/right/input/trigger/value")
+
+[sub_resource type="OpenXRIPBinding" id="OpenXRIPBinding_vorgf"]
+action = SubResource("OpenXRAction_qggp4")
+paths = PackedStringArray("/user/hand/left/input/trigger/value", "/user/hand/right/input/trigger/value")
+
+[sub_resource type="OpenXRInteractionProfile" id="OpenXRInteractionProfile_i6s3d"]
+interaction_profile_path = "/interaction_profiles/oculus/touch_controller"
+bindings = [SubResource("OpenXRIPBinding_rytyh"), SubResource("OpenXRIPBinding_0dw4u"), SubResource("OpenXRIPBinding_ubj08"), SubResource("OpenXRIPBinding_icpc6"), SubResource("OpenXRIPBinding_bmyjf"), SubResource("OpenXRIPBinding_dsmkp"), SubResource("OpenXRIPBinding_ghpoo"), SubResource("OpenXRIPBinding_vorgf")]
+
+[resource]
+action_sets = [SubResource("OpenXRActionSet_mhyx4")]
+interaction_profiles = [SubResource("OpenXRInteractionProfile_i6s3d")]

addons/xr-kit/physics-movement/scenes/player.tscn

@@ -495,13 +495,13 @@ collision_layer = 2048
 collision_mask = 3585
 mass = 10.0
 gravity_scale = 0.0
+can_sleep = false
+freeze = true
+freeze_mode = 1
 custom_integrator = true
 continuous_cd = true
 max_contacts_reported = 1
 contact_monitor = true
-can_sleep = false
-freeze = true
-freeze_mode = 1
 script = ExtResource("3_ecrt7")
 body = NodePath("../../..")
 camera = NodePath("..")
@@ -1136,12 +1136,47 @@ bones/25/scale = Vector3(1, 1, 1)
 mesh = SubResource("ArrayMesh_u3sx3")
 skin = SubResource("Skin_v5ql8")
 
+[node name="ThumbFingerIK" type="SkeletonIK3D" parent="PhysicsHandLeft/Skeleton3D"]
+process_priority = 1
+root_bone = &"Thumb_Proximal_L"
+tip_bone = &"Thumb_Tip_L"
+override_tip_basis = false
+min_distance = 0.001
+
+[node name="IndexFingerIK" type="SkeletonIK3D" parent="PhysicsHandLeft/Skeleton3D"]
+process_priority = 1
+root_bone = &"Index_Proximal_L"
+tip_bone = &"Index_Tip_L"
+override_tip_basis = false
+min_distance = 0.001
+
+[node name="MiddleFingerIK" type="SkeletonIK3D" parent="PhysicsHandLeft/Skeleton3D"]
+process_priority = 1
+root_bone = &"Middle_Proximal_L"
+tip_bone = &"Middle_Tip_L"
+override_tip_basis = false
+min_distance = 0.001
+
+[node name="RingFingerIK" type="SkeletonIK3D" parent="PhysicsHandLeft/Skeleton3D"]
+process_priority = 1
+root_bone = &"Ring_Proximal_L"
+tip_bone = &"Ring_Tip_L"
+override_tip_basis = false
+min_distance = 0.001
+
+[node name="LittleFingerIK" type="SkeletonIK3D" parent="PhysicsHandLeft/Skeleton3D"]
+process_priority = 1
+root_bone = &"Little_Proximal_L"
+tip_bone = &"Little_Tip_L"
+override_tip_basis = false
+min_distance = 0.001
+
 [node name="PhysicsHandRight" type="RigidBody3D" parent="." node_paths=PackedStringArray("origin", "camera", "controller", "physics_skeleton", "controller_skeleton", "body", "controller_hand_mesh", "wrist_raycast", "wrist_joint")]
 collision_layer = 1024
 collision_mask = 513
 gravity_scale = 0.0
-continuous_cd = true
 can_sleep = false
+continuous_cd = true
 script = ExtResource("10_7gjb2")
 origin = NodePath("../Body/XROrigin3D")
 camera = NodePath("../Body/XROrigin3D/XRCamera3D")
@@ -1355,12 +1390,50 @@ bones/25/scale = Vector3(1, 1, 1)
 mesh = SubResource("ArrayMesh_8jodk")
 skin = SubResource("Skin_n5id7")
 
-[connection signal="button_pressed" from="Body/XROrigin3D/XRController3D Left" to="PhysicsHandLeft" method="_on_xr_controller_3d_button_pressed"]
-[connection signal="button_released" from="Body/XROrigin3D/XRController3D Left" to="PhysicsHandLeft" method="_on_xr_controller_3d_button_released"]
-[connection signal="turned" from="Body/XROrigin3D/XRController3D Left" to="Body" method="_on_turned"]
-[connection signal="button_pressed" from="Body/XROrigin3D/XRController3D Right" to="PhysicsHandRight" method="_on_xr_controller_3d_button_pressed"]
-[connection signal="button_released" from="Body/XROrigin3D/XRController3D Right" to="PhysicsHandRight" method="_on_xr_controller_3d_button_released"]
-[connection signal="turned" from="Body/XROrigin3D/XRController3D Right" to="Body" method="_on_turned"]
+[node name="ThumbFingerIK" type="SkeletonIK3D" parent="PhysicsHandRight/Skeleton3D"]
+process_priority = 1
+root_bone = &"Thumb_Metacarpal_R"
+tip_bone = &"Thumb_Distal_R"
+min_distance = 0.001
+
+[node name="IndexFingerIK" type="SkeletonIK3D" parent="PhysicsHandRight/Skeleton3D"]
+process_priority = 1
+root_bone = &"Index_Metacarpal_R"
+tip_bone = &"Index_Distal_R"
+min_distance = 0.001
+
+[node name="MiddleFingerIK" type="SkeletonIK3D" parent="PhysicsHandRight/Skeleton3D"]
+process_priority = 1
+root_bone = &"Middle_Metacarpal_R"
+tip_bone = &"Middle_Distal_R"
+min_distance = 0.001
+
+[node name="RingFingerIK" type="SkeletonIK3D" parent="PhysicsHandRight/Skeleton3D"]
+process_priority = 1
+root_bone = &"Ring_Metacarpal_R"
+tip_bone = &"Ring_Distal_R"
+min_distance = 0.001
+
+[node name="LittleFingerIK" type="SkeletonIK3D" parent="PhysicsHandRight/Skeleton3D"]
+process_priority = 1
+root_bone = &"Little_Metacarpal_R"
+tip_bone = &"Little_Distal_R"
+min_distance = 0.001
+
+[connection signal="button_pressed" from="Body/XROrigin3D/XRController3D Left" to="Body/XROrigin3D/XRController3D Left" method="_on_button_pressed"]
+[connection signal="button_released" from="Body/XROrigin3D/XRController3D Left" to="Body/XROrigin3D/XRController3D Left" method="_on_button_released"]
+[connection signal="grab" from="Body/XROrigin3D/XRController3D Left" to="PhysicsHandLeft" method="_on_grab"]
+[connection signal="input_vector2_changed" from="Body/XROrigin3D/XRController3D Left" to="Body/XROrigin3D/XRController3D Left" method="_on_input_vector_2_changed"]
+[connection signal="thruster" from="Body/XROrigin3D/XRController3D Left" to="Body" method="_on_thruster"]
+[connection signal="thruster_brake" from="Body/XROrigin3D/XRController3D Left" to="Body" method="_on_thruster_brake"]
+[connection signal="turned_x" from="Body/XROrigin3D/XRController3D Left" to="Body" method="_on_turned_x"]
+[connection signal="button_pressed" from="Body/XROrigin3D/XRController3D Right" to="Body/XROrigin3D/XRController3D Right" method="_on_button_pressed"]
+[connection signal="button_released" from="Body/XROrigin3D/XRController3D Right" to="Body/XROrigin3D/XRController3D Right" method="_on_button_released"]
+[connection signal="grab" from="Body/XROrigin3D/XRController3D Right" to="PhysicsHandRight" method="_on_grab"]
+[connection signal="input_vector2_changed" from="Body/XROrigin3D/XRController3D Right" to="Body/XROrigin3D/XRController3D Right" method="_on_input_vector_2_changed"]
+[connection signal="thruster" from="Body/XROrigin3D/XRController3D Right" to="Body" method="_on_thruster"]
+[connection signal="thruster_brake" from="Body/XROrigin3D/XRController3D Right" to="Body" method="_on_thruster_brake"]
+[connection signal="turned_x" from="Body/XROrigin3D/XRController3D Right" to="Body" method="_on_turned_x"]
 [connection signal="new_pose" from="Body/XROrigin3D/OpenXRHand Left/HandPoseRecognition" to="PhysicsHandLeft" method="_on_hand_pose_recognition_new_pose"]
 [connection signal="new_pose" from="Body/XROrigin3D/OpenXRHand Right/HandPoseRecognition" to="PhysicsHandRight" method="_on_hand_pose_recognition_new_pose"]
 [connection signal="dropped_held_object" from="PhysicsHandLeft" to="Body" method="_on_hand_dropped_held_object"]