|
2 | 2 | sidebar_position: 512 |
3 | 3 | --- |
4 | 4 |
|
5 | | -# Vicon Shogun Live |
| 5 | +# Vicon Shogun |
6 | 6 |
|
7 | 7 | :::info |
8 | 8 | This feature is only available in [Warudo Pro](../pro). |
9 | 9 | ::: |
10 | 10 |
|
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. |
12 | 12 |
|
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. |
14 | 14 |
|
15 | 15 | ## Setup |
16 | 16 |
|
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`. |
18 | 18 |
|
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 | + |
20 | 22 |
|
21 | 23 | ### Character Tracking |
22 | 24 |
|
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. |
26 | 26 |
|
27 | 27 | :::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. |
29 | 29 | ::: |
30 | 30 |
|
| 31 | + |
| 32 | + |
31 | 33 | ### Prop Tracking |
32 | 34 |
|
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 | +::: |
36 | 40 |
|
37 | 41 | :::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. |
39 | 43 | ::: |
40 | 44 |
|
41 | 45 | ## Advanced Options |
42 | 46 |
|
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. |
45 | 49 |
|
46 | 50 | ## Frequently Asked Questions |
47 | 51 |
|
48 | 52 | Please refer to [Overview](overview#FAQ) and [Customizing Pose Tracking](body-tracking#FAQ) for common questions. |
49 | 53 |
|
50 | 54 | ### The status says "Failed to connect to Vicon system". |
51 | 55 |
|
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. |
53 | 57 |
|
54 | 58 | ### My character snaps into incorrect poses. |
55 | 59 |
|
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. |
57 | 61 |
|
58 | 62 | <AuthorBar authors={{ |
59 | 63 | creators: [ |
|
0 commit comments