Skip to content

Latest commit

 

History

History
92 lines (56 loc) · 3.45 KB

README.md

File metadata and controls

92 lines (56 loc) · 3.45 KB

Godot XR Axis Studio Tracker

GitHub forks GitHub Repo stars GitHub contributors GitHub

This repository contains an Axis Studio BVH Broadcast decoder for Godot that can drive avatars through the XR Tracker system.

Axis Studio Preview

Versions

Official releases are tagged and can be found here.

The following branches are in active development:

Branch Description Godot version
master Current development branch Godot 4.3-dev6+

Overview

Axis Studio is a Motion Capture package by Perception Neuron.

Usage

The following steps show how to add the Godot Axis Studio tracker to a project.

Enable Addon

The addon files needs to be copied to the /addons/godot_axis_studio_tracker folder of the Godot project, and then enabled in Plugins under the Project Settings: Enable Plugin

Plugin Settings

The plugin has numerous options to control behavior:

Plugin Options

Option Description
Tracking - Position Mode Controls the position of the character:
- Free = Free Movement
- Calibrate = Calibrate to origin on first frame
- Locked = Lock to origin
Tracking - Body Tracker Name Name for the XRBodyTracker
Network - Udp Listener Port Port to listen for BVH network packets

Character Importing

The character model must be in Godot Humanoid format. This can be achieved in the importer settings by retarteting the skeleton to the SkeletonProfileHumanoid bone map:

Character Import

Body Driving

The body is positioned using an XRNode3D node configured to track the character body:

XRNode3D

The body is driven using an XRBodyModifier3D node configured to drive the skeleton of the character:

XRBodyModifier3D

Note that the Body Tracker name should match the Body Tracker Name specified in the Plugin Settings.

Axis Studio Application

Axis Studio must be configured for BVH broadcasting.

Axis Studio BVH

Option Description
Skeleton Use the standard Axis Studio Skeleton
Rotation Use YXZ
Displacement Enable
Frame Type Binary
Protocol UDP
Destination Address 255.255.255.255 (broadcast)
Destination Port 7004 (default)

Licensing

Code in this repository is licensed under the MIT license.

About this repository

This repository was created by Malcolm Nixon

It is primarily maintained by:

For further contributors please see CONTRIBUTORS.md