Version 5.0.0 Release Candidate 1

Game Compatibility

✔️ Tested with versions 1.11.0 and 1.11.1

Dependencies

Required

• DynamicOpenVR ≥ v0.2.0
• BeatSaberMarkupLanguage ≥ v1.3.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.2.0

Known Issuses

• If starting the game from a clean install or restarting after choosing the "No Avatar" option in-game, the mod will not load properly and the Avatars menu will not work. If you are running into this issue, please use the version I uploaded here.

What to download

• RELEASE is what you should download if you just want to use the mod. If you are unsure what to download, this is the file you are looking for.
• DEBUG contains debug code and a PDB for debugging purposes.
• Editor is for use in the Unity editor when creating avatars. You will also need to import FinalIK.dll and DynamicBone.dll from the game's installation folder to get it working.

If you are unsure how to install the mod, check out the installation instructions in the README.

Changes

General

• Fixed certain avatars not tracking at all (#42)
• Fixed jerky motion when pressing "Play" on a song (#45)
• Fixed bad SteamVR detection preventing tracking from working (#46)
• Fixed EveryNthComboFilter and ComboReachedEvent not working properly (#55)
• Fixed campaings not ending/saving score properly (#56)
• Fixed a memory leak related to the Avatars menu mirror
• Fixed exception when settings file isn't found
• Fixed Avatars menu not loading when reading an out-of-date CustomAvatars\Shaders\customavatars.assetbundle file

For Developers

• The Zenject implementation has changed. The sample project has been updated and you can look at Zenject's documentation for more details on how it works.

Version 5.0.0 beta 8

Game Compatibility

✔️ Tested with version 1.10.0

⚠️ Untested on 1.11.0

Dependencies

Required

• DynamicOpenVR ≥ v0.2.0
• BeatSaberMarkupLanguage ≥ v1.3.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.2.0

What to download

• RELEASE is what you should download if you just want to use the mod. If you are unsure what to download, this is the file you are looking for.
• DEBUG contains debug code and a PDB for debugging purposes.
• Editor is for use in the Unity editor when creating avatars. You will also need to import FinalIK.dll and DynamicBone.dll from the game's installation folder to get it working.

If you are unsure how to install the mod, check out the installation instructions in the README.

Known issues

• Avatars may not show up or be missing parts (often the head) when using Camera Plus versions 4.2.0 and earlier. A fix is on its way. In the meantime, you can use the unofficial version from this issue.
• The mod may not load for users running -vrmode oculus. Please use the version I posted in this comment for now.

Changes

General

• Added manual VRChat-like calibration. Works best with resize mode set to Height. Note that FBT now requires calibration or explicit bypass before tracking.
• Added "Move Floor with Room Adjust" option in settings (#33).
• Certain settings are now saved on a per-avatar basis.
• Avatar info is cached for a better experience in the avatar selection menu.
• Fixed hotkey switching not working properly when no avatar is loaded (#19).
• Fixed avatars with invalid game objects in first person exclusions causing the mod to fail to load (#21).
• Fixed avatar height not being calculated properly on certain avatars (#22).
• Fixed platform mirror not reflecting first-person exclusions (#34).
• Fixed tracker roles not being detected properly without DynamicOpenVR.BeatSaber installed.
• Fixed some avatars not loading properly when some arm bones are missing.
• Fixed pelvis movement issues related to maintainPelvisPosition.
• Fixed mirror going black when no avatar is displayed (#39).

For Avatar Creators

• Updated PoseManager editor UI for better ease-of-use and fixed undo/redo not working when using it.
• The Avatar Exporter window is now part of the Editor DLL – please delete the Editor\CompileAvatarWindow.cs file from your Unity project.

For Developers

• Custom Avatars now uses Zenject. Check out the sample project and Zenject's documentation for details on how to use it.
• Migrated to .NET Standard 2.0.
• Replaced the AvatarInput abstract class with the IAvatarInput interface.

Version 5.0.0 beta 7

Game Compatibility

✔️ Tested with versions 1.8.0 – 1.9.1

⚠️ Some issues with 1.10.0

A quick note on downloads

• RELEASE is what you should download if you just want to use the mod. If you are unsure what to download, this is the file you are looking for.
• DEBUG contains debug code and a PDB for debugging purposes.
• Editor is for use in the Unity editor when creating avatars.

If you are unsure how to install the mod, check out the installation instructions in the README.

Known Issues

• Scrolling the avatar list breaks everything in 1.10.0.
• Full body tracking calibration does not work with all avatars. This is due to the approach I took; I will be adding something more along the lines of VRChat's full body calibration soon™.
• Tracker roles aren't resolved properly if DynamicOpenVR.BeatSaber isn't installed; they are assigned to the left foot, right foot, and waist respectively based on the order in which they're turned on, similarly to how it was done in versions 4.x.x of Custom Avatars.
• The OnLevelFinish event may not work properly.
• Some avatars with first person exclusions cause the mod to fail to load.

Changes

• Support Beat Saber 1.8.0 & BSIPA 4
• Added preliminary Driver4VR & KinectToVR support
• Removed implicit DynamicOpenVR.BeatSaber dependency – it is now optional and only necessary if you want finger tracking
• For avatar creators – targets can now be omitted when creating an avatar and will be automatically created at the right spots at runtime
• Fixed issues related to full body calibration (thanks @Ormei!)
• Fixed height adjust issues on certain avatars where targets and bones were at different places (thanks @alexankitty!)

Version 5.0.0 beta 6.1

Hotfixes!

Compatible with Beat Saber 1.7.0 only.

• Fixed T-Posing avatars with native Oculus tracking
• Fixed DynamicBones sometimes interfering with VRIK

Version 5.0.0 beta 6

• Added default image for avatars that don't have one
• Hardcoded the "No Avatar" option (no need for the No Avatar.avatar file anymore)
• Fixed full body tracker rotation not working properly when not using full body calibration
• Fixed IK sometimes not working as expected (thanks to Eidilon on Discord!)
• Fixed dynamic bones not working properly
• Fixed non-IK avatars causing errors when trying to use arm span resizing
• Fixed avatar resizing allowing scale 0
• Fixed some lag/stuttering issues
• Fixed trackers not working properly with floor adjust

Version 5.0.0 beta 5

Changes:

• Support Beat Saber 1.6.2
• Support built-in controller position/rotation adjustment
• Fix sabers/hands disappearing when close to the face (you will need to delete UserData\CustomAvatars.json for this to work)

Known Issues:

• Full body tracking using Kinect (KinectToVR or Driver4VR) doesn't work properly

Version 5.0.0 beta 4

• Fixed TwistRelaxer and DynamicBone backwards compatibility
• Fixed exceptions when using native Oculus tracking
• Fixed room adjust issues (thanks to laugexd on Discord!)
• Fixed avatars using legacy IKManager not working

Version 5.0.0 beta 3

This version may not work properly for native Oculus users. If you can, please use SteamVR for now.

Will this ever come out of beta? Who knows!

• Updated to support Beat Saber 1.6.0
• Fixed loading crash when settings file doesn't exist
• Use Beat Saber's included Dynamic Bone and FinalIK libraries

Version 5.0.0 beta 2

IMPORTANT INFORMATION

There have been reports that this version immediately crashes when starting the game. To circumvent this issue temporarily, please create a file called CustomAvatars.json inside the UserData folder in your Beat Saber installation folder (e.g. C:\Program Files (x86)\Steam\steamapps\common\Beat Saber\UserData for Steam) and put the following inside:

{
    "previousAvatarPath": ""
}

This issue will be fixed in the next version of Custom Avatars.

---

• Mark IKManager and IKManagerAdvanced as deprecated in favor of VRIKManager
• Use JSON file (UserData\CustomAvatars.json) for settings instead of UserPrefs
• Add full body motion smoothing settings
• Fix floor adjustment not working properly with full body tracking
• Various other small improvements

Version 5.0.0 beta 1

Lots of changes (some breaking)! Requires BeatSaberMarkupLanguage, BS Utils, CustomUI, and DynamicOpenVR.

• Added finger tracking support*
• Added full body tracking calibration*
• Full body tracking now tries to get tracker roles from SteamVR instead of relying on the order in which they were turned on
• Updated VRIK to version 1.8
• Replaced 2D mirror with stereo mirror
• Rewrote UI using BSML
• Fixed floor moving for non-custom platforms
• Lots of under-the-hood cleanup

(*) more information coming soon™