Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
icetotem committed Mar 1, 2022
1 parent 29628ff commit e186b65
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# NEURON MOCAP LIVE Plugin for Unity

This plugin provide the ability to stream motion data from Axis Studio into Unity

Download plugin package from Github [release page](https://github.com/pnmocap/Neuron_Mocap_Live_Unity/releases)

### Prerequisites

```
Unity 5.4.2p4 or higher
Unity 2017 or higher
Window x86_64
```

## Getting Started

```
Import the SDK package to unity
Expand All @@ -22,7 +22,7 @@ Open Axis Studio software
Run QuickStart Scene
```

## Usage

* Live motion data to animator or common avatar transform
Expand All @@ -36,11 +36,7 @@ Run QuickStart Scene

## Public Variables of "Neuronanimatorinstance.cs"

* **Address** is the IP address of the machine running Axis Studio. If it's the same computer, the address should be 127.0.0.1. You can use this stream motion data from any other computer in the same network. In this case change the address accordingly.
* **Port Tcp** is the port number associated with the BVH data stream output setting in Axis for tcp
* **Port Udp** is the port number associated with the BVH data stream output setting in Axis for udp
* **Actor ID** is the id number for the actor you want to use. If you have more than one actor connected in Axis Neuron this id number will increase. Default is 0 which is the first actor.
* **Connect To Axis** means the script will connect to Axis Neuron and apply the motion data. You can use this toggle to starts/stop the data stream.
* **Skeleton Type** if it’s value is Perception Neuron Studio, it means the script will use the PN Studio seleton structure which includes 3 joints of spine, and 2 joints of neck.
if it’s value is Perception Neuron, it means the script will use the PN/PN Pro seleton structure which includes 4 joints of spine and 1 joint of neck.
* **Bound Animator** the Animator component this instance should use for the received motion data. You can use this if you don’t want to keep the script on the same GameObject as the animator component.
Expand Down

0 comments on commit e186b65

Please sign in to comment.