Skip to content
This repository has been archived by the owner on Jan 1, 2024. It is now read-only.

Latest commit

 

History

History
148 lines (97 loc) · 6.49 KB

AvatarSetup.md

File metadata and controls

148 lines (97 loc) · 6.49 KB
Raw

HRtoVRChat_OSC Avatar Setup

The HRtoVRChat-Prefab (which can be found on the Latest Release Artifacts for HRtoVRChat_OSC) contains contents to get started with HRtoVRChat_OSC. Please read through this whole document for information on everything included.

ℹ️ IMPORTANT ℹ️

If you need any extended help, please don't be afraid to join the discord server, or ask on the discussions board!

Video Tutorial

If you find it difficult to understand the written instructions, please see the video tutorial below:

https://vimeo.com/697202508

HRtoVRChat Prefab

Version 2

Created by 200Tigersbloxed

Terminology

  • Avatar - The GameObject containing the VRC Avatar Descriptor Component
  • v1 - The old HRtoVRChat prefab
  • v2 - This new HRtoVRChat prefab
  • FX Layer - The Animator Controller being used as the FX Layer
  • TargetHRObject - The GameObject containing the TargetHRObject Component

Supported Parameters

The Expression Parameters supported with a description

Parameter Name Parameter Type Parameter Default Parameter Saved Description
onesHR int 0 false Ones spot in the Heart Rate reading; 123 (legacy)
tensHR int 0 false Tens spot in the Heart Rate reading; 123 (legacy)
hundredsHR int 0 false Hundreds spot in the Heart Rate reading; 123 (legacy)
isHRConnected bool false false Returns whether the device's connection is valid or not
isHRActive bool false false Returns whether the connection is valid or not
isHRBeat bool false false Estimation on when the heart is beating
HRPercent float 0.0 false Range of HR between the MinHR and MaxHR config value
FullHRPercent float 0.0 false Range of HR between the MinHR and MaxHR config value on a scale of -1 to 1
HR int 0 false Returns the raw HR, ranged from 0 - 255. (required)

Getting Started

The HRtoVRChat Prefab v2 was designed to be as simple as possible with a quick setup.

Preparing your Avatar

Unlike v1, v2 is designed to be snap-able, meaning you can put the prefab wherever you want, and it'll work.

⚠️ Before continuing any further! ⚠️

Please make a backup of your avatar!

This system is entirely automated and may cause damage to your Avatar!

you have been warned...

Inside of the HRtoVRChat folder, find the HRContainer (1) prefab. Take this prefab and move it anywhere into your Avatar (2). Select the HRContainer prefab in the hierarchy (3), and find the TargetHRObject component (4).

Preparing your Avatar

The TargetHRObject Component

The TargetHRObject component is used by the Editor to grab specific settings for the HRContainer being worked on. This includes information like which materials to use for the number, references for number Transforms, etc.

All of the following fields will already be filled out for you:

  • Ones Icon
  • Tens Icon
  • Hundreds Icon
  • Ones Materials
  • Tens Material
  • Hundreds Materials

Please do not change the Ones Icon, Tens Icon, or Hundreds Icon fields, unless they're null, as they're specific to the GameObject.

You may change the Materials if you wish to.

For the Avatar Root field, set that to your Avatar.

For the FX Controller field, set that to your FX Layer.

The TargetHRObject Component

Open the Editor Window

On your top bar, find the Window button, click it, then click the HRtoVRChat_SDK button, and the main window will open.

Opening the Window

You should now see a window popup containing all the functions required to setup your avatar.

The Editor Window

The GitHub button will just take you to the GitHub Repository.

Underneath the Discovered TargetHRObjects header, you will see a list of buttons that correspond to every GameObject in the scene that has a TargetHRObject Component. Click the button for the HRContainer you'll be working with.

You will then see a label Saying SelectedHRTarget: [name] (1), click that.

You may press the Create Animations! Button (3) whenever you're ready to continue.

Options (2)

  • friendlyName - An identifier to be used in the Layers corresponding to your HRContainer
    • This should be different for each HRContainer
  • useSmallerHR - Uses only one HR int parameter instead of the conventional three parameters
    • Note: This will lock your HR from 0-255, but to be fair, if your HR is over 255, you need to go to the ER.
  • deleteComponentOnDone - Will remove the TargetHRObject Component on the HRContainer when finished
  • overwriteLayers - Will overwrite all layers that have the same name
    • This will not overwrite any of your layers outside of the HR Layers.

The Editor Window

Once finished, you will see a DialogWindow saying Completed Operation!

If you get a Dialog Window saying 'Failed to Complete Operation!', then please check your Console window for errors.

Finishing Up

Once the process is complete, make sure to Apply your FX Controller to your Avatar

Don't forget to add any parameters used to your Expression Parameters

If you used a Smaller HR:

Add the HR (int) Parameter

If you did NOT use a Smaller HR:

Add the following Parameters:

  • onesHR (int)
  • tensHR (int)
  • hundredsHR (int)

Now you're all set to publish!

Source Code

All code is visible in the Scripts folder (under the respective LICENSE), but is also mirrored at this gist