Skip to content

Commit a2d6942

Browse files
update README
1 parent 6ea9860 commit a2d6942

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.MD

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,19 @@ Physics-based XR movement. Player hands collide with environment and can grab or
1111
### Features
1212

1313
- Physics hand follows controller and can be blocked by world objects
14-
- Players can grab and move objects
14+
- Player can grab and move objects
1515
- Heavy objects are harder to move
1616
- Grabbing heavy objects with two hands makes them easier to move
1717
- Fingers curl around grabbed objects geometry
18-
- Players can move themselves by pushing away from objects
18+
- Player can move themselves by pushing away from objects
1919
- Heavier objects allow for stronger push
20-
- Players can move in space with thrusters
21-
- Players can brake in space with thruster brake
22-
- Players can hit objects with their head and push themselves away
20+
- Player can move in space with thrusters
21+
- Player can brake in space with thruster brake
22+
- Player can hit objects with their head and push themselves away
2323
- Ghost hand appears when controller hand gets far from physics one
24-
- Physics hand is teleported to controller position if it gets too far from it (ex. hand got stuck)
25-
- Body snap rotation
26-
- Body smooth XYZ rotation around static object using hands (trigger activated)
24+
- Physics hand is reset to controller position if it gets too far from it (ex. hand got stuck)
25+
- Joystick snap rotation
26+
- Smooth 6 degrees of freedom rotation around grabbed static object (trigger activated)
2727
- Fingers wiggle a little when hand is moving
2828

2929
[Read more](/addons/xr-kit/physics-movement/)
@@ -34,7 +34,7 @@ Real-time recognition of hand poses based on predefined templates.
3434

3535
![Godot XR Kit - Hand Gesture Recognition](/screenshots/hand_gesture_recognition.gif)
3636

37-
### Poses tracked by default:
37+
## Poses tracked by default:
3838

3939
- open
4040
- rest
@@ -91,6 +91,12 @@ To get most recent version of the whole project, [download from master branch](h
9191

9292
`/addons/xr-kit/examples/smooth_input_filter.tscn` implements Smooth Input Filter.
9393

94+
If you are on Quest, make sure your hardware is configured properly:
95+
96+
- Enable "Developer Runtime Features" in Oculus PCVR app (Settings -> Beta)
97+
- Enable Developer Mode in Meta Quest app on your phone
98+
99+
94100
## Compatibility
95101

96102
XR Kit has been tested with SteamVR and Oculus (PC and standalone) using Meta Quest 3.

0 commit comments

Comments
 (0)