Skip to content

Commit

Permalink
Nuitrack v0.34.0 (links fixed)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ivan-3DiVi committed Oct 16, 2020
1 parent 0bbeb47 commit ae213f2
Show file tree
Hide file tree
Showing 17 changed files with 29 additions and 27 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* installation of `libpng12-0` and `libssl1.0.0` on `Ubuntu 20.04 LTS` is no longer required
* fixed the low FPS issue for **Kinect V2** on `Windows x86_64`
* fixed the `Realsense2Module.DeviceHardwareReset` option in `nuitrack.config`
* edited the [Creating an Interactive Multi-Touch Gallery](doc/Unity_Gallery.md) tutorial
* edited the [Creating an Interactive Multi-Touch Gallery](/doc/Unity_Gallery.md) tutorial
* fixed the application crush on `Android` when starting without a plugged sensor

## Known Issues
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ You can learn more about **Nuitrack™** on [nuitrack.com](https://nuitrack.com)
$ git lfs pull --include "Platforms/*"
```

- or [this link](./Platforms).
- or [this link](/Platforms).

3. Download `NuitrackSDK.unitypackage`:
- using Git LFS:
Expand All @@ -48,9 +48,9 @@ You can learn more about **Nuitrack™** on [nuitrack.com](https://nuitrack.com)
$ git lfs pull --include "Unity3D/*"
```

- or [this link](./Unity3D).
- or [this link](/Unity3D).

4. Install **Nuitrack** to your system following the [Installation Instructions](doc/Install.md).
4. Install **Nuitrack** to your system following the [Installation Instructions](/doc/Install.md).

5. Activate **Nuitrack** with our [Trial, Perpetual, or Online license](https://nuitrack.com/#pricing).

Expand All @@ -63,5 +63,5 @@ Now you can use **Nuitrack** and run the samples from the `Examples` folder.
| **Runtime Components** | **Nuitrack Runtime** installers for all supported platforms. ||
| **C#/.NET Wrapper** | **Nuitrack** supports **C#/.NET API** that allows you to integrate **Nuitrack** with your C# applications. ||
| **Code Samples** | These basic examples demonstrate how to use **Nuitrack SDK**. You can find **C++**/**C#** cross-platform samples with instructions inside. |
| **Unity Package** | This package allows you to [easily integrate](doc/readme.md#unity-tutorials) **Nuitrack SDK** into your Unity project. |
| **Unreal Engine Plugin** | This plugin allows to [develop](doc/Unreal_Engine_Tutorial.md) C++ applications with **UE 4.20** (Android only). |
| **Unity Package** | This package allows you to [easily integrate](/doc/readme.md#unity-tutorials) **Nuitrack SDK** into your Unity project. |
| **Unreal Engine Plugin** | This plugin allows to [develop](/doc/Unreal_Engine_Tutorial.md) C++ applications with **UE 4.20** (Android only). |
8 changes: 4 additions & 4 deletions doc/Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Supported Windows versions: Windows 7, Windows 8, Windows 10.

To install Nuitrack on Windows, follow the steps below:

1. Download and run [nuitrack-windows-x86.exe](./Platforms/nuitrack-windows-x86.exe) (for Windows 32-bit) or [nuitrack-windows-x64.exe](./Platforms/nuitrack-windows-x64.exe) (for Windows 64-bit). Follow the instructions of the Nuitrack setup assistant.
1. Download and run [nuitrack-windows-x86.exe](/Platforms/nuitrack-windows-x86.exe) (for Windows 32-bit) or [nuitrack-windows-x64.exe](/Platforms/nuitrack-windows-x64.exe) (for Windows 64-bit). Follow the instructions of the Nuitrack setup assistant.
2. **Re-login** to let the system changes take effect.
3. [Required] Make sure that you have installed Microsoft Visual C++ Redistributable for Visual Studio on your computer. If not, install this package depending on your VS version and architecture:
* [Visual C++ Redistributable 2015 (x86)](https://download.microsoft.com/download/9/3/F/93FCF1E7-E6A4-478B-96E7-D4B285925B00/vc_redist.x86.exe)
Expand Down Expand Up @@ -50,8 +50,8 @@ Supported Ubuntu version is 14.04 and above. Supported architectures are AMD64 a
To install Nuitrack on Ubuntu, follow the steps below:

1. Download one of the following Debian packages, depending on the target architecture:
* [nuitrack-ubuntu-amd64.deb](./Platforms/nuitrack-ubuntu-amd64.deb) for AMD64
* [nuitrack-linux-armhf.deb](./Platforms/nuitrack-linux-armhf.deb) for ARM 32-bit
* [nuitrack-ubuntu-amd64.deb](/Platforms/nuitrack-ubuntu-amd64.deb) for AMD64
* [nuitrack-linux-armhf.deb](/Platforms/nuitrack-linux-armhf.deb) for ARM 32-bit
2. Install the downloaded package using the following command:
```
sudo dpkg -i <downloaded-package-name>.deb
Expand Down Expand Up @@ -79,7 +79,7 @@ sudo chmod -R 777 /dev/bus/usb/
## Android

1. Allow your device to install applications from unknown sources. To do this, go to **Settings → Security and tick "Unknown sources"**.
2. Download [Nuitrack.apk](./Platforms/Nuitrack.apk) or [Nuitrack_arm64.apk](./Platforms/Nuitrack_arm64.apk) (for Android 64-bit) and install it. To install the APK package, locate it in a file manager, open and tap "INSTALL".
2. Download [Nuitrack.apk](/Platforms/Nuitrack.apk) or [Nuitrack_arm64.apk](/Platforms/Nuitrack_arm64.apk) (for Android 64-bit) and install it. To install the APK package, locate it in a file manager, open and tap "INSTALL".
3. Launch the Nuitrack application.

<p align="center">
Expand Down
2 changes: 2 additions & 0 deletions doc/Moving_Sensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
Support for moving sensors was added in **`Nuitrack v0.33.0`**.

Supported platforms:
* Windows x86_64
* Ubuntu amd64
* iOS

Hardware requirements:
* RGBD sensor (RGB is required for processing)
Expand Down
4 changes: 2 additions & 2 deletions doc/TVico_User_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Please see the installation instructions for both cases below.

## Standalone case

1. Download [Nuitrack.apk](./Platforms/Nuitrack.apk).
1. Download [Nuitrack.apk](/Platforms/Nuitrack.apk).
2. Install *Nuitrack.apk* on TVico following the [installation instructions for Android](Install.md#android).
3. Launch the Nuitrack application.
4. Click **Compatibility test** and wait until the test is complete.
Expand All @@ -35,7 +35,7 @@ _**Note**: Check out our [free Android motion controlled games for TVico](https:
### Installation of TVico.apk on TVico

1. Allow your device to install applications from unknown sources. To do this, go to **Settings → Security** and tick **Unknown sources**.
2. Download [TVico.apk](./Platforms/TVico.apk) (beta) and install it. To install the APK package, locate it in the file manager, open and tap **INSTALL**.
2. Download [TVico.apk](/Platforms/TVico.apk) (beta) and install it. To install the APK package, locate it in the file manager, open and tap **INSTALL**.
3. Launch the Nuitrack application.

<p align="center">
Expand Down
2 changes: 1 addition & 1 deletion doc/Tutorial_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ In this tutorial, you'll learn how to integrate Nuitrack with your application.
}
```

See the full source code of `nuitrack_csharp_sample` in [Examples/nuitrack_csharp_sample/Program.cs](Examples/nuitrack_csharp_sample/Program.cs).
See the full source code of `nuitrack_csharp_sample` in [Examples/nuitrack_csharp_sample/Program.cs](/Examples/nuitrack_csharp_sample/Program.cs).

5. Follow the steps in `README.txt` to build `nuitrack_csharp_sample`.

Expand Down
2 changes: 1 addition & 1 deletion doc/Unity_Animated_Emoji.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
In this tutorial you'll learn to create animated emoji using the face info from Nuitrack and blendshapes. You'll be able to track several skeletons (from 1 to 6) and see the fox animated emoji instead of the user's face. Fox face mimics user's facial expressions. When a user turns his/her head, the fox head is also rotated. You can notice that fox fur is slightly moving when the fox turns its face - an incredible thing to watch. The fox face is zoomed in and out, i.e. the closer the user is, the bigger the fox head is, and vice versa.

To create this project, you'll need just a couple of things:
* [Nuitrack Runtime](./Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* [Nuitrack Runtime](/Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* Unity (2017.4 or higher)
* Any compatible sensor (see the complete list at [Nuitrack website](https://nuitrack.com/#sensors))

Expand Down
2 changes: 1 addition & 1 deletion doc/Unity_Animation_Recording.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Choose the suitable animation type and let's get started!

## Setting Up the Scene

1. Create a new project. Import [**Nuitrack Skeleton Tracking** Unity Package](./Unity3D) to your project. Drag-and-drop the **Ethan** model from the downloaded package (or any other humanoid model) to the scene. The model should be in a T-Pose so that its joints are matched correctly. To do that, select your model's hands (for example, **EthanLeftArm** and **EthanRightArm** for our model) and set Rotation parameters as in the screenshot below:
1. Create a new project. Import [**Nuitrack Skeleton Tracking** Unity Package](/Unity3D) to your project. Drag-and-drop the **Ethan** model from the downloaded package (or any other humanoid model) to the scene. The model should be in a T-Pose so that its joints are matched correctly. To do that, select your model's hands (for example, **EthanLeftArm** and **EthanRightArm** for our model) and set Rotation parameters as in the screenshot below:

<p align="center">
<img width="500" src="img/Umc_1.png"><br>
Expand Down
2 changes: 1 addition & 1 deletion doc/Unity_Avatar_Animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ We’ll start with indirect mapping, as it’s a more simple way to animate your

To create this project, you'll need just a couple of things:

* [Nuitrack Runtime](./Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* [Nuitrack Runtime](/Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* Any supported sensor (see the complete list at [Nuitrack website](https://nuitrack.com/#sensors))
* Unity 2017.4 and higher

Expand Down
2 changes: 1 addition & 1 deletion doc/Unity_Basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ _**Note**: In this tutorial we create an Android project, however, you can creat

_**Note**:_
**What sensors can I use with my app?**
*You can use any of the supported sensors for your application (see the list of supported sensors at the [Nuitrack official website](https://nuitrack.com/#sensors)). For example, you can use [**TVico**](https://tvico.io/), which is an interactive Android computer with pre-installed Nuitrack. You can find the [TVico User Guide](doc/TVico_User_Guide.md) in our documentation.*
*You can use any of the supported sensors for your application (see the list of supported sensors at the [Nuitrack official website](https://nuitrack.com/#sensors)). For example, you can use [**TVico**](https://tvico.io/), which is an interactive Android computer with pre-installed Nuitrack. You can find the [TVico User Guide](/doc/TVico_User_Guide.md) in our documentation.*

7. As a result, you will have a configured development environment with all the necessary components for the build.

Expand Down
2 changes: 1 addition & 1 deletion doc/Unity_Gallery.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ In this tutorial, you'll learn how to create a virtual gallery that can be contr

To create this project, you'll need just a couple of things:

* [Nuitrack Runtime](./Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* [Nuitrack Runtime](/Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* Any supported sensor (see the complete list at [Nuitrack website](https://nuitrack.com/#sensors))
* Unity 2017.4 or higher

Expand Down
4 changes: 2 additions & 2 deletions doc/Unity_Point_Cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ In this tutorial, you'll learn how to create a point cloud in the Unity editor.

To create this project, you'll need just a couple of things:

* [Nuitrack Runtime](./Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* [Nuitrack Runtime](/Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* Any supported sensor (see the complete list at [Nuitrack website](https://nuitrack.com/#sensors))
* Unity 2017.4 or higher

Expand All @@ -19,7 +19,7 @@ You can find the finished project in **Nuitrack SDK**: **Unity 3D → NuitrackSD
1. Create a new Scene in Unity: **File → New Scene**
2. In the scene, create 2 squares: **GameObject → 3D Object → Quad** (x2). We will use them as planes to display the color and depth received from the sensor. For convenience, let's name them **QuadDepth** (for depth) and **QuadColor** (for color).
3. Then, create 2 materials for depth and color respectively: create the **Materials** folder in the **Assets** folder, then, in the **Project** tab: **RC → Create → Material**. For convenience, let's name the materials **ColorMaterial** and **DepthMaterial**.
4. Download [Nuitrack SDK](./Platforms). Import the **Nuitrack** and **Plugins** folders from the **Nuitrack.unitypackage** to the project. Drag-and-drop the **NuitrackScripts** prefab from the **Nuitrack/Prefabs** folder to the scene. In Unity, select the **Inspector** tab → **Nuitrack Manager** and tick two modules: **Color Module On** and **Depth Module On**. As you can see, these Nuitrack modules provide access to the sensor depth and color data. Other Nuitrack modules are not required for this project.
4. Download [Nuitrack SDK](/Platforms). Import the **Nuitrack** and **Plugins** folders from the **Nuitrack.unitypackage** to the project. Drag-and-drop the **NuitrackScripts** prefab from the **Nuitrack/Prefabs** folder to the scene. In Unity, select the **Inspector** tab → **Nuitrack Manager** and tick two modules: **Color Module On** and **Depth Module On**. As you can see, these Nuitrack modules provide access to the sensor depth and color data. Other Nuitrack modules are not required for this project.

<p align="center">
<img width="500" src="img/Upoints_1.png"><br>
Expand Down
2 changes: 1 addition & 1 deletion doc/Unity_RGB_Skeletons.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In this tutorial, you'll learn how to display a color image from your sensor in
You can find the finished project in **Nuitrack SDK: Unity 3D → NuitrackSDK.unitypackage → Tutorials → RGB and Skeletons**

To create this project, you'll need just a couple of things:
* [Nuitrack Runtime](./Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* [Nuitrack Runtime](/Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* Any supported sensor (see the complete list at [Nuitrack website](https://nuitrack.com/#sensors))
* Unity 2017.4 or higher

Expand Down
2 changes: 1 addition & 1 deletion doc/Unity_Segment.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ In this tutorial, you'll learn how to visualize a user segment using **Nuitrack

To create this project, you'll need just a couple of things:

* [Nuitrack Runtime](./Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* [Nuitrack Runtime](/Platforms) and [Nuitrack SDK](https://github.com/3DiVi/nuitrack-sdk)
* Any supported sensor (see the complete list at [Nuitrack website](https://nuitrack.com/#sensors))
* Unity 2017.4 or higher

Expand Down
4 changes: 2 additions & 2 deletions doc/Unity_Zombies_Oculus.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Hardware:
* Depth sensor (see the list of supported cameras at [our website](https://nuitrack.com/#sensors))

Software:
* [Nuitrack Runtime](./Platforms) (we used 0.23.1)
* [Nuitrack Runtime](/Platforms) (we used 0.23.1)
* Windows (we used Windows 10)
* [Oculus Integration](https://assetstore.unity.com/packages/tools/integration/oculus-integration-82022) package from Unity Asset Store;
* [Nuitrack Skeleton Tracking package](./Unity3D)
* [Nuitrack Skeleton Tracking package](/Unity3D)
* Unity (2017.4 or higher)

You can find the finished project in Nuitrack SDK: **Unity 3D → NuitrackSDK.unitypackage → Tutorials → Zombie Nightmare (RIFT)**.
Expand Down
4 changes: 2 additions & 2 deletions doc/VR_app.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ First of all, the hardware, which is:
* a rather powerful **Android smartphone** with at least 5" screen for comfortable perception;
* a suitable **VR headset**. To make it perfect, you can use the Gear VR set.

_**Note:** If you use TVico, you have to connect your Android smartphone to TVico via Wi-Fi. See the detailed information in our [TVico User Guide](TVico_User_Guide.md#wireless-case). You can also use other Android device (with one of supported USB sensors for Android platform (see the full list at [Nuitrack website](https://nuitrack.com/#sensors)) provided that you installed [TVico.apk](Platforms/TVico.apk) on this device and connected your Android smartphone to this device via Wi-Fi._
_**Note:** If you use TVico, you have to connect your Android smartphone to TVico via Wi-Fi. See the detailed information in our [TVico User Guide](TVico_User_Guide.md#wireless-case). You can also use other Android device (with one of supported USB sensors for Android platform (see the full list at [Nuitrack website](https://nuitrack.com/#sensors)) provided that you installed [TVico.apk](/Platforms/TVico.apk) on this device and connected your Android smartphone to this device via Wi-Fi._

Secondly, the software, which is:

* **Unity** (2017.4 or higher)
* **development environment** (out-of-the-box MonoDevelop would be enough)
* [**VicoVR**](https://play.google.com/store/apps/details?id=com.vicovr.manager) app installed on your smartphone (VicoVR app is a client app, which allows you to connect to TVico wirelessly)
* [**TVico**](./Platforms/TVico.apk) app installed on TVico device (in case of using the TVico sensor)
* [**TVico**](/Platforms/TVico.apk) app installed on TVico device (in case of using the TVico sensor)
* **Nuitrack SDK**, which is the most interesting thing here

## How does it work?
Expand Down
2 changes: 1 addition & 1 deletion iOS-beta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ To activate the license, you have to use *Nuitrack Device API*. For example:
}
```

Please refer to *Nuitrack Device API* [C++ example](Examples/nuitrack_device_api_sample/src/main.cpp) for more details.
Please refer to *Nuitrack Device API* [C++ example](/Examples/nuitrack_device_api_sample/src/main.cpp) for more details.

_**Note**: "Network.ProxyUrl" parameter should be set immediately after Nuitrack initialization._

Expand Down

0 comments on commit ae213f2

Please sign in to comment.