Skip to content

Commit 9d7880e

Browse files
committed
update vicon
1 parent 126fbf4 commit 9d7880e

File tree

6 files changed

+25
-20
lines changed

6 files changed

+25
-20
lines changed

docs/mocap/motionbuilder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_position: 510
88
This feature is only available in [Warudo Pro](../pro).
99
:::
1010

11-
Body tracking via [Autodesk MotionBuilder](https://www.autodesk.com/products/motionbuilder/), enabling you to receive motion data from optical motion capture systems (e.g., [Vicon](https://www.vicon.com/), [OptiTrack](https://optitrack.com/)) that has Autodesk MotionBuilder integration.
11+
Body tracking via [Autodesk MotionBuilder](https://www.autodesk.com/products/motionbuilder/), enabling you to receive motion data from professional (usually optical) motion capture systems (e.g., [Vicon](https://www.vicon.com/), [OptiTrack](https://optitrack.com/)) that has Autodesk MotionBuilder integration.
1212

1313
In addition to character tracking, prop tracking is also supported. For example, you may want to track a chair or a handheld camera using your optical tracking system and stream the motion data to Warudo, animating a chair prop or camera in Warudo accordingly.
1414

docs/mocap/optitrack.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To connect OptiTrack Motive to Warudo, please enable **Streaming** in OptiTrack
2424

2525
![](/doc-img/en-optitrack-2.png)
2626

27-
In the **OptiTrack Skeleton Receiver** asset, make sure the name matches the one in OptiTrack Motive:
27+
Then, use the [Onboarding Assistant](../tutorials/readme-1) (or run **Character → Setup Motion Capture**) and select **OptiTrack Motive** for pose tracking. After the setup is complete, you should be able to see an **OptiTrack Skeleton Receiver** asset in your scene. Make sure the **OptiTrack Skeleton Name** field matches the one in OptiTrack Motive:
2828

2929
![](/doc-img/en-optitrack-3.png)
3030

docs/mocap/overview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ Whether you are streaming at home or at a professional mocap studio, Warudo has
2525

2626
[Warudo Pro](../pro.md) also supports the following motion capture systems:
2727

28-
* Any optical tracking system compatible with [Autodesk MotionBuilder](./motionbuilder), e.g., [Vicon](https://www.vicon.com/), [OptiTrack](https://optitrack.com/)
28+
* [Vicon Shogun](./vicon)
2929
* [OptiTrack Motive](./optitrack)
3030
* [Chingmu Avatar](./chingmu)
31+
* Any tracking system compatible with [Autodesk MotionBuilder](./motionbuilder)
3132

3233
## What motion capture systems should I use?
3334

docs/mocap/vicon.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,58 +2,62 @@
22
sidebar_position: 512
33
---
44

5-
# Vicon Shogun Live
5+
# Vicon Shogun
66

77
:::info
88
This feature is only available in [Warudo Pro](../pro).
99
:::
1010

11-
Body tracking via [Vicon Shogun Live](https://www.vicon.com/software/shogun-live/). Requires access to a Vicon optical tracking system and the DataStream SDK runtime.
11+
Body tracking via [Vicon Shogun](https://www.vicon.com/software/shogun/). Requires access to a [Vicon](https://www.vicon.com) optical tracking system.
1212

13-
In addition to character tracking, prop tracking is also supported. You can, for example, stream a tracked camera, handheld prop, or stage marker from Shogun Live and animate the corresponding Warudo prop or camera in real time.
13+
In addition to character tracking, prop tracking is also supported. You can, for example, stream a tracked camera, handheld prop, or stage marker from Shogun and animate the corresponding Warudo prop or camera in real time.
1414

1515
## Setup
1616

17-
In Warudo, go to **Menu → Settings → Vicon**. Confirm the **Server Address** points to the PC running Shogun Live (for example `192.168.1.50:801`). If Warudo and Shogun Live run on the same machine, you can keep the default `localhost:801`. Enable **Use Pre Fetch** if you would like Vicon's DataStream client to request data ahead of time to minimize dropped frames on busy networks.
17+
In Warudo, go to **Menu → Settings → Vicon**. Confirm the **Server Address** points to the PC running Shogun (for example `192.168.1.50:801`). If Warudo and Shogun run on the same machine, you can keep the default `localhost:801`.
1818

19-
Set **Enabled** to Yes. You should see a status message that says "Connected to Vicon system" once Warudo establishes the DataStream connection.
19+
Set **Enabled** to Yes. You should see a status message that says "Connected to Vicon Shogun" once Warudo establishes the connection.
20+
21+
![](/doc-img/en-vicon-1.jpg)
2022

2123
### Character Tracking
2224

23-
1. In Shogun Live, expand **System → Local Vicon System → DataStream** and enable streaming. Set the transport to **Unicast** and enter the IP address of the Warudo PC in the client list if prompted.
24-
2. Verify that your subject is labeled in Shogun Live (for example `Subject1`). The DataStream uses the subject name to publish skeleton data.
25-
3. In Warudo, create a **Vicon Receiver** asset (or run **Character → Setup Motion Capture** and select **Vicon Shogun Live**). Set **Vicon Character Name** to match the subject name in Shogun Live. Once the plugin connects, Warudo will automatically bind the incoming joints to your character.
25+
To connect Vicon Shogun to Warudo, use the [Onboarding Assistant](../tutorials/readme-1) (or run **Character → Setup Motion Capture**) and select **Vicon Shogun** for pose tracking. After the setup is complete, you should be able to see a **Vicon Subject Receiver** asset in your scene. Make sure the **Vicon Subject Name** field matches the one in Shogun.
2626

2727
:::tip
28-
If your Shogun skeleton uses custom joint names, use **Override Bone Names** on the **Vicon Receiver** asset to map specific humanoid bones to the names exposed by Shogun Live.
28+
If your Warudo character has different bone names than the ones used in the Shogun skeleton, use **Override Bone Names** on the **Vicon Receiver** asset to map specific humanoid bones to the names exposed by Shogun.
2929
:::
3030

31+
![](/doc-img/en-vicon-2.jpg)
32+
3133
### Prop Tracking
3234

33-
1. In Shogun Live, publish the rigid body (prop) you want to track and confirm it appears on the DataStream.
34-
2. In Warudo, create a **Vicon Prop Receiver** asset. Set **Vicon Prop Name** to the rigid body's label in Shogun Live, and choose the Warudo prop or camera under **Target Asset**.
35-
3. When the plugin reports tracking, the chosen asset follows the live prop pose. If the original hierarchy includes a transform named `root`, Warudo mirrors the entire hierarchy; otherwise, it drives the prop from a generated root.
35+
In Warudo, create a **Vicon Prop Receiver** asset. Set **Vicon Prop Name** to the rigid body's label in Shogun Live, and choose the Warudo prop or camera under **Target Asset**.
36+
37+
:::info
38+
The hierarchy of the Warudo prop file must match the one in Shogun, and the root transform must be named `root`. Otherwise, Warudo will generate a root transform, but the child transforms may not be fully mirrored.
39+
:::
3640

3741
:::tip
38-
To access the tracking data in blueprints, use **Get Vicon Receiver Data** or **Get Vicon Prop Receiver Data** nodes.
42+
To access the tracking data in blueprints, you can use the **Get Vicon Subject Receiver Data** or **Get Vicon Prop Receiver Data** nodes.
3943
:::
4044

4145
## Advanced Options
4246

43-
* **Root Rotation Offset**: Applies a static offset if your character or prop faces a different forward direction than the Vicon coordinate frame.
44-
* **Use Pre Fetch** (plugin setting): Requests buffered frames from the Vicon DataStream to smooth latency-sensitive setups.
47+
* **Root Rotation Offset**: Applies a static offset if your character or prop faces a different forward direction than the Vicon coordinate frame. Usually you shuold not need to change this setting.
48+
* **Use Pre Fetch**: Requests buffered frames from Vicon Shogun to smooth latency-sensitive setups.
4549

4650
## Frequently Asked Questions
4751

4852
Please refer to [Overview](overview#FAQ) and [Customizing Pose Tracking](body-tracking#FAQ) for common questions.
4953

5054
### The status says "Failed to connect to Vicon system".
5155

52-
Ensure the Shogun PC and the Warudo PC are on the same subnet and that the Vicon DataStream service is enabled. Double-check the **Server Address** and confirm that UDP port `801` is open on your firewall.
56+
Ensure the Shogun PC and the Warudo PC are on the same subnet. Double-check the **Server Address** and confirm that port `801` is open on your firewall.
5357

5458
### My character snaps into incorrect poses.
5559

56-
Confirm that the subject in Shogun Live uses a skeleton compatible with your Warudo character (matching bone hierarchy and zeroed T-pose rotations). When necessary, use **Override Bone Names** to align joint names and **Root Rotation Offset** to match coordinate frames.
60+
Confirm that the subject in Shogun uses a skeleton compatible with your Warudo character (matching bone hierarchy and zeroed T-pose rotations). When necessary, use **Override Bone Names** to align joint names and **Root Rotation Offset** to match coordinate frames.
5761

5862
<AuthorBar authors={{
5963
creators: [

static/doc-img/en-vicon-1.jpg

188 KB
Loading

static/doc-img/en-vicon-2.jpg

629 KB
Loading

0 commit comments

Comments
 (0)