Add more build instructions to README
This commit is contained in:
parent
6dd897a822
commit
869595c87a
26
README.md
26
README.md
|
@ -3,8 +3,10 @@
|
|||
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)
|
||||
- [:white\_check\_mark: Features](#white-check-mark-features)
|
||||
- [:hammer\_and\_wrench: Build](#hammer-and-wrench-build)
|
||||
- [🍎 Mac extra instructions](#mac-extra-instructions)
|
||||
- [:wine\_glass: Windows extra instructions](#wine-glass-windows-extra-instructions)
|
||||
- [:fast\_forward: Quick start](#fast-forward-quick-start)
|
||||
|
||||
![GIF of Ultraleap hand tracking in Godot](res/ul-godot.gif)
|
||||
|
@ -36,12 +38,32 @@ The other important scene is an obvious rip-off of Ultraleap's Blocks demo used
|
|||
|
||||
## :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.
|
||||
To build you'll need to have Python and SCons installed. On Linux and Mac it can be installed using your favourite package manager (homebrew for Mac). On Windows you probably want to install it with [pip](https://pypi.org/project/SCons/). You'll also need a compiler, GCC on Linux, XCode Command Line Tools on Mac, and MSBuild on Windows.
|
||||
|
||||
Use git to clone this repository and the submodules:
|
||||
|
||||
```bash
|
||||
git clone https://forge.lunai.re/rodolphe/godot-ultraleap-plugin
|
||||
cd godot-ultraleap-plugin
|
||||
git submodule update --init
|
||||
```
|
||||
|
||||
From there, just launch scons:
|
||||
|
||||
```bash
|
||||
scons
|
||||
```
|
||||
|
||||
If you're building for Mac or Windows, make sure to follow the extra instructions to get the plugin to work in your project.
|
||||
|
||||
### 🍎 Mac extra instructions
|
||||
|
||||
After building the extension, copy `/Applications/Ultraleap Hand Tracking Service.app/Contents/LeapSDK/lib/libLeapC.5.dylib` in the `demo/addons/godot_ultraleap_plugin/bin` folder.
|
||||
|
||||
### :wine_glass: Windows extra instructions
|
||||
|
||||
After building the extension, copy `C:/Program Files/Ultraleap/LeapSDK/lib/x64/LeapC.dll` in the `demo/addons/godot_ultraleap_plugin/bin` folder.
|
||||
|
||||
## :fast_forward: Quick start
|
||||
|
||||
**These are very simple instructions and barely covers all the possibilities but it shows my willingness to try and document things to help people who want to adopt this plugin**
|
||||
|
|
Loading…
Reference in a new issue