rodolphe/godot-ultraleap-plugin
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Add features list to README

Browse source
This commit is contained in:
rodolpheh 2023-10-24 22:59:04 +01:00
parent 29740c9af4
commit 35d721d1ed
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -3,6 +3,7 @@
A GDExtension plugin to use Ultraleap hand tracking in your project. See GIF below for very old status (it does more now!).
- [:sunflower: About](#sunflower-about)
- [:white\_check\_mark: Features](#white-check-mark-features)
- [:hammer\_and\_wrench: Build](#hammer-and-wrench-build)
- [:fast\_forward: Quick start](#fast-forward-quick-start)
@ -17,6 +18,22 @@ This GDExtension aim at exposing and abstracting the LeapC API to make Ultraleap
The priorities of this project is to target the most useful features of Ultraleap's hand tracking while exploring how hand tracking can be used in Godot. Because of this, there are demos and scripts that are not part of the extension but are part of the project. Some of the scripts implements new features or features related to the game engine rather than the hand tracking itself: displaying joints, rigging a skeleton etc... If possible, and when the project has matured enough, some of those extra features could be ported to the extension to make them more readily available and more performant.
### :white_check_mark: Features
The extension has the following features:
* Hand tracking events
* Multi-device support
* Camera images and distortion matrix
* Hand tracking interpolation
* Selecting tracking mode
* Pausing/resuming tracking
* Access to some obscure and unused parameters
One of the demos it comes with is an attempt at making a full-blown visualizer like Ultraleap's Control Panel but with more features and not using Unity. This is the `main.tscn` scene.
The other important scene is an obvious rip-off of Ultraleap's Blocks demo used to test rigging a skeleton on the hand data, and interacting with objects/gestures. This one is called `scenes/RiggedHands.tscn`
## :hammer_and_wrench: Build
Use SConstruct to build. More instructions to come. For now building as only been tested on Linux (and Windows but with some modifications). I aim to make this plugin buildable on Linux, MacOS, and Windows.