Skip to main content

Godot Plugin

Plugin Installation​

  1. Open the Godot software and drag the plugin archive into a new project in the engine.
godot-1
  1. Enter the project name in the pop-up window, select the save path for the project, and then click "Install".
godot-2
  1. Locate the main.tscn file in the file system, double-click it, and then click "3D" to enter the sample scene.
godot-3

Human Body Motion Driving​

  1. Open the Nokov panel in the Godot plugin. In the Server IP drop-down list, select the SDK address of the XINGYING software broadcast. Before connecting, make sure that the XINGYING software has enabled the SDK stream. Click "Online" to establish the connection.

  2. After the connection is successful, the connection status on the Nokov plugin panel will change to a green indicator. If the data connection is interrupted, the connection status will change from green to yellow. When not connected, it will be red. After the connection is successful, the number of assets obtained, their IDs, and their names will be displayed below.

godot-4
  1. When the SDK stream of XINGYING selects the local coordinate for the skeleton, you need to click "Local Coordinate" to synchronize the Godot skeleton coordinate mode to the local coordinate system before proceeding with the connection.
godot-5
  1. In the example scenario, locate the NokovSkeleton node in the left column of the scene and select it. This node is the one that drives the model's skeleton. On the right side of the inspector, expand the "Skeleton Asset Name" drop-down list and select the human asset. Note: Only Y-axis human data-driven models are supported.
godot-6
  1. Click on the sub-node "RetargetModifier3D" of the "NokovSkeleton" node. Drag the "SkeletonProfile.tres" file from the file system onto the "Profile" field in the "Inspector" on the right side. Check the "Use Global pose" option, and the model in the scene will be successfully driven.
godot-7
  1. Note: The "SkeletonProfile.tres" file in the file system is the redirection configuration file for a human body without fingers, while the "SkeletonProfileWithHand.tres" file is the redirection configuration file for a human body with fingers. Please select the appropriate one based on the current type of human asset as needed.

Rigid body drive​

  1. In the left scene panel of the example scenario, select the "NokovRigid Body" node. This node is responsible for driving the rigid body skeleton. Expand the "Rigid Body Asset" list below the Inspector panel, select the rigid body asset, keep the "Animate in Editor" option enabled, and the model in the scene will be driven.
godot-8

Data loading and pause/play​

Remote Control​

  1. Enable remote capture in the data broadcast panel of the XINGYING software, with the port set to 7060.
godot-9

Motion capture data switching​

  1. In the Nokov plugin panel of the Godot software, click on "Online Connection". Make sure the connection status is "Connected". Clicking the "Switch to Post-Processing Mode" button will open a window.

  2. Select the desired .cap motion capture data file and click "Open". In the XINGYING software, the selected .cap motion capture data from the Godot plugin will be automatically loaded. Note: The path of the loaded .cap motion capture file cannot contain any Chinese characters

godot-10

Pause / Play​

  1. If the data in the XINGYING software is in a paused playback state, clicking the Timeline Play button in the Nokov plugin panel will cause the data to resume playing.

  2. Clicking the Timeline Pause button in the Nokov plugin panel will pause the playback of the data in the XINGYING software.

godot-11

Plugin information and operation manual​

  1. Expand the "Info" at the bottom of the Nokov plugin panel to view the current version number of the Nokov plugin being used. Click "Nokov Documentation" to quickly navigate to the operation manual on the Nokov official website.
godot-12