Merge branch 'HakuyaLabs:master' into docs/mod-sdk-update-20251207

Author: cubesky

.gitignore

@@ -31,6 +31,11 @@ yarn-error.log*
 !.yarn/sdks
 !.yarn/versions
 
+# C# build output
+**/bin/
+**/obj/
+*.sln
+
 # Obsidian
 .obsidian
 *.base

docs/blueprints/miscellaneous/_category_.json

@@ -0,0 +1,6 @@
+{
+  "position": 100,
+  "label": "Miscellaneous",
+  "collapsible": true,
+  "collapsed": true
+}

docs/blueprints/miscellaneous/transition-easing.md

@@ -0,0 +1,19 @@
+---
+sidebar_position: 10
+translate_from_version: 2026-01-09
+---
+
+# Transition Easing
+
+**Transition Easing** argument is used in multiple blueprint nodes, such as the powerful "Set Asset Property" node.
+
+For a detailed explanation of the effect of each option, please refer to: [Easing Functions Cheat Sheet](https://easings.net/) .
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'hanekit', github: 'hanekit'},
+  ],
+  translators: [
+    {name: 'hanekit', github: 'hanekit'},
+  ],
+}} />

docs/blueprints/tutorials/dance.md

@@ -11,7 +11,7 @@ Looking for a fun way to thank your viewers for their support? In this tutorial,
 
 ## Connecting to Streaming Platforms
 
-Before we get started, you need to use the onboarding assistant to connect Warudo to your Twitch, YouTube or Bilibili account. If you haven't done so, please refer to the [Getting Started](../../tutorials/readme-1#interaction-setup) tutorial. We will assume you stream on Twitch in this tutorial, but the steps are similar for other platforms.
+Before we get started, you need to use the onboarding assistant to connect Warudo to your Twitch, YouTube or Bilibili account. If you haven't done so, please refer to the [Getting Started](../../tutorials/getting-started.md#interaction-setup) tutorial. We will assume you stream on Twitch in this tutorial, but the steps are similar for other platforms.
 
 :::tip
 You can also use third-party integration such as [Streamer.bot](Streamer.bot) that can send a WebSocket message to Warudo when you receive a donation or other stream events. In that case, you don't need to use the onboarding assistant.

docs/blueprints/tutorials/karaoke.md

@@ -15,7 +15,7 @@ If you want to use this karaoke room environment, you can download it from our S
 
 ## Playing Idle Animations
 
-First, add a microphone prop and attach it to your character's left hand. Refer to the [Getting Started](../../tutorials/readme-1.md#assets-tab) tutorial if you are not sure how to do this. Then, in the prop asset, set **Enabled** to No to hide the microphone for now.
+First, add a microphone prop and attach it to your character's left hand. Refer to the [Getting Started](../../tutorials/getting-started.md#assets-tab) tutorial if you are not sure how to do this. Then, in the prop asset, set **Enabled** to No to hide the microphone for now.
 
 Next, try to recreate the blueprint below using the On Keystroke Pressed node that we are already very familiar with, with two new nodes: **Toggle Asset Enabled** and **Play Character Idle Animation**. (Their names are pretty telling, aren't they?) Remember to set **Toggle Asset Enabled → Asset** to the microphone prop, and **Play Character Idle Animation → Animation** to a singing pose. I am using "010_0970," but feel free to experiment with other poses.
 

docs/mocap/ifacialmocap.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 60
-version: 2025-09-29
+version: 2025-10-30
 ---
 
 # iFacialMocap / FaceMotion3D
@@ -68,7 +68,7 @@ Please check the following points in order:
 1. **Admin**: Run Warudo in administrator mode
 2. **Port**: Check the input port
 3. **IP**: Check whether the input IP is consistent
-4. **Blendshapes Naming**: Check model Blendshapes naming, make sure they contain correct naming and lower/uppercase (The model needs to have Arkit standard Blendshapes, see the following list**: https**://docs.warudo.app/docs/tutorials/3d-primer)
+4. **Blendshapes Naming**: Check model Blendshapes naming, make sure they contain correct naming and lower/uppercase (The model needs to have Arkit standard Blendshapes, check: [3D VTubing Primer](../tutorials/3d-primer))
 5. **Same Wifi**: Confirm that the mobile device and PC device use the same Wifi
 6. **Private Network**: Confirm that the Private Network is used
 7. **Firewall**: Add Warudo to the whitelist of the computer firewall; try to turn off the firewall and see if you can connect normally after restarting the app (if successful, please remember to re-open the firewall)

docs/mocap/motionbuilder.md

@@ -8,7 +8,7 @@ sidebar_position: 510
 This feature is only available in [Warudo Pro](../pro).
 :::
 
-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.
+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.
 
 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.
 

docs/mocap/optitrack.md

@@ -24,7 +24,7 @@ To connect OptiTrack Motive to Warudo, please enable **Streaming** in OptiTrack
 
 ![](/doc-img/en-optitrack-2.png)
 
-In the **OptiTrack Skeleton Receiver** asset, make sure the name matches the one in OptiTrack Motive:
+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:
 
 ![](/doc-img/en-optitrack-3.png)
 

docs/mocap/overview.md

@@ -25,9 +25,10 @@ Whether you are streaming at home or at a professional mocap studio, Warudo has
 
 [Warudo Pro](../pro.md) also supports the following motion capture systems:
 
-* Any optical tracking system compatible with [Autodesk MotionBuilder](./motionbuilder), e.g., [Vicon](https://www.vicon.com/), [OptiTrack](https://optitrack.com/)
+* [Vicon Shogun](./vicon)
 * [OptiTrack Motive](./optitrack)
 * [Chingmu Avatar](./chingmu)
+* Any tracking system compatible with [Autodesk MotionBuilder](./motionbuilder)
 
 ## What motion capture systems should I use?
 

docs/mocap/vicon.md

@@ -0,0 +1,69 @@
+---
+sidebar_position: 512
+---
+
+# Vicon Shogun
+
+:::info
+This feature is only available in [Warudo Pro](../pro).
+:::
+
+Body tracking via [Vicon Shogun](https://www.vicon.com/software/shogun/). Requires access to a [Vicon](https://www.vicon.com) optical tracking system.
+
+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.
+
+## Setup
+
+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`.
+
+Set **Enabled** to Yes. You should see a status message that says "Connected to Vicon Shogun" once Warudo establishes the connection.
+
+![](/doc-img/en-vicon-1.jpg)
+
+### Character Tracking
+
+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.
+
+:::tip
+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.
+:::
+
+![](/doc-img/en-vicon-2.jpg)
+
+### Prop Tracking
+
+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**.
+
+:::info
+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.
+:::
+
+:::tip
+To access the tracking data in blueprints, you can use the **Get Vicon Subject Receiver Data** or **Get Vicon Prop Receiver Data** nodes.
+:::
+
+## Advanced Options
+
+* **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.
+* **Use Pre Fetch**: Requests buffered frames from Vicon Shogun to smooth latency-sensitive setups.
+
+## Frequently Asked Questions
+
+Please refer to [Overview](overview#FAQ) and [Customizing Pose Tracking](body-tracking#FAQ) for common questions.
+
+### The status says "Failed to connect to Vicon system".
+
+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.
+
+### My character snaps into incorrect poses.
+
+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.
+
+<AuthorBar authors={{
+  creators: [
+    {name: 'HakuyaTira', github: 'TigerHix'},
+  ],
+  translators: [
+  ],
+}} />
+