Skip to content

Home

Jump to bottom
Malcolm Nixon edited this page Jan 21, 2024 · 2 revisions

Welcome to the Godot-XR-Avatar wiki!

This Wiki contains technical and user information on the Godot XR Avatar addon.

Once the project gets more stable this information will probably be migrated to a Github Pages site/.

Project Goals

The Godot-XR-Avatar project is intended to provide avatar support for Godot XR applications. The following types of avatars are planned for support:

  • Basic toon-like avatars with fixed hands
  • Basic toon-like avatars with local-animated hands
  • Godot SkeletonProfileHumanoid rigged avatars with animated hands (future)
  • Integration with basic Godot XR rigs
  • Simple out-of-the-box integration with Godot-XR-Tools

Installation

The Godot-XR-Avatar addon is intended to be published on the Godot Asset Library, but can also be downloaded from the Github site via the Releases or from experimental builds in the CI Actions.

The addon must be installed to the addons/godot-xr-avatar subfolder of the project. Note that the repository contains this folder and you should copy that folder over to your project. If you're downloading this add on from the asset library make sure to only add this subfolder to your project!

XR Tools Integration

The following shows a basic Godot-XR-Tools setup with Avatar support:

image

The scene contains:

  1. A basic XR Rig - XROrigin3D / XRCamera3D / XRController3Ds
  2. "PlayerBody" from Godot-XR-Tools to provide physics body and movement
  3. "PlayerBodyAvatar" from Godot-XR-Avatar to drive an avatar from a PlayerBody and XR Rig
  4. "WheeledRobotAvatar" demo avatar from Godot-XR-Avatar
  5. "StartXR" from Godot-XR-Tools to start the XR system
Clone this wiki locally