Skip to content

Commit d61dbf1

Browse files
authored
Cleanup formatting and add reference to custom hand pose video. (#5)
1 parent 49a2f38 commit d61dbf1

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
![GitHub](https://img.shields.io/github/license/Malcolmnixon/GodotXRHandPoseDetector?style=plastic)
77

88
This repository contains a hand pose detector for Godot that detects poses on XRHandTracker sources.
9-
109
![Demo Screen Shot](/docs/demo_screen_shot.png)
1110

1211
## Versions
@@ -29,6 +28,7 @@ The following steps show how to add the Godot XR Hand Pose Detector to a project
2928
### XR Hand Tracking Project
3029

3130
Ensure the existing project is configured with XR hand tracking. The demo project and main scene shows how to do this for OpenXR.
31+
3232
![OpenXR Hand Tracking Scene](/docs/basic_hand_tracking_scene.png)
3333

3434
### Install Addon
@@ -38,17 +38,23 @@ The addon files need to be copied to the `/addons/hand_pose_detector` folder of
3838
### Add Hand Pose Detectors
3939

4040
Add Hand Pose Detector nodes into the scene - one for each hand.
41+
4142
![Add Hand Pose Detectors](/docs/add_hand_pose_detectors.png)
4243

4344
Configure the hand pose detectors with the pose-set to detect, and the hand tracker to monitor.
45+
4446
![Hand Pose Detector Settings](/docs/hand_pose_detector_settings.png)
4547

46-
Connect the hand pose detector signals as desired
48+
Connect the hand pose detector signals as desired.
49+
4750
![Hand Pose Detector Signals](/docs/hand_pose_detector_signals.png)
4851

4952
## Custom Hand Poses
5053

54+
This section describes the process of creatnig custom hand poses. Additionally the [Creating Custom Hand Poses](https://youtu.be/xB1TJXy77fI) video walks through the process.
55+
5156
New hand poses can be made by creating new Hand Pose Resource instances.
57+
5258
![Hand Pose Resource](/docs/hand_pose_resource.png)
5359

5460
Hand Pose Resources consist of:
@@ -90,6 +96,7 @@ The Range function provides non-zero values in a finite range.
9096
## Designing and Tuning
9197

9298
The inspect scene provided in the demo project can be used to inspect the flexion, curl, abduction, and tip-distance of a hand, and can also inspect a selected hand pose to diagnose the fitness of the rules.
99+
93100
![Inspect Scene](/docs/inspect_scene.png)
94101

95102
## Licensing

0 commit comments

Comments
 (0)