Version 5.2.4

Not sure what to do here? Check out the quick start instructions in the README!

Game Compatibility

❌ Broken on version 1.16.2

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.5.3
• SiraUtil ≥ 2.5.5

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Added mirror render scale option to avatars menu
• Improved avatar caching process to reduce cache file size
• Reduced stutter when first opening the avatars menu
• Fixed any error when loading avatar causing the menu to lock up
• Fixed floor not adjusting in Health Warning scene
• Fixed avatar not following user viewing position when in ScoreSaber replays
• Fixed various minor issues introduced by 1.16.2

Version 5.2.3

Not sure what to do here? Check out the quick start instructions in the README!

Game Compatibility

✔️ Tested with version 1.16.1

⚠️ Some issues with 1.16.2

Known Issues

• If an avatar fails to load, the loading spinner will stay visible forever and you won't be able to change the selected avatar (#107).
• Room adjust doesn't get applied properly in Beat Saber 1.16.2

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.5.3
• SiraUtil ≥ 2.5.5

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Updated for Beat Saber 1.16.0/1.16.1
• Mirror now scales to full height when floor adjust is used
• Improved "Reload all avatars" performance
• Reworked settings interface to improve clarity
• Fixed cache possibly saving images that are too large
• Various small internal changes and performance improvements

Version 5.2.2

Not sure what to do here? Check out the quick start instructions in the README!

Game Compatibility

✔️ Tested with version 1.15.0

❌ Not compatible with versions 1.16.0+

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.5.1

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Fixed tracking not working at all when an incompatible version of SteamVR is used (#98)
• Fixed calibration not respecting room adjust (#99/#102)
• Fixed a rare issue where certain text elements in the avatar list would become huge
• Fixed a compatibility issue with Counters+ that caused the spawned avatar to disappear
• Fixed tracking always thinking all devices are available
• Various small internal changes

Version 5.2.1

Not sure what to do here? Check out the quick start instructions in the README!

Game Compatibility

✔️ Tested with version 1.13.4 and 1.13.5

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.5.1

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Updated for Beat Saber 1.13.4
• Fixed Noodle Extensions' Player Track not affecting avatar (#95)
• Fixed calibration not centering avatar in world space when using room adjust
• Fixed turning off locomotion not resetting position to world origin
• Fixed black screen when SteamVR doesn't initialize properly
• Fixed multiplayer not respecting floor height adjust
• Fixed buttons in settings being enabled when they shouldn't

Editor

• Updated to Unity 2019.4.18f (dark mode!)
• Improved VRIK Manager inspector
• Fixed VRIK Manager not defaulting to weight of 1 on pelvis and legs

Version 5.2.0

Not sure what to do here? Check out the quick start instructions in the README!

Game Compatibility

✔️ Tested with version 1.13.2

Dependencies

Required

• DynamicOpenVR ≥ v0.3.5
• BeatSaberMarkupLanguage ≥ v1.4.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.3.5

Known Issues

• SteamVR tracker roles might not be recognized properly and prevent the use of full-body tracking

Changes

General

• Made Avatars menu mirror opaque since the transparent one couldn't show glow/dither shaders (#74)
• Calibration indicators are now visible on top of everything so their position is easier to see
• Improved performance of dynamic bones
• Improved the clarity of the warning message when Automatic Player Height is used
• Improved performance of avatar list
• Fixed "Enable Locomotion" setting defaulting to off instead of on
• Fixed avatars being kept loaded in background even when not in use
• Fixed events not working in multiplayer
• Fixed camera clip plane not being applied properly in multiplayer
• Fixed black screen when CustomAvatars folder doesn't exist
• Fixed invisible parts of menu mirror not being destroyed properly when exiting the menu
• Fixed disabling locomotion not resetting the current avatar to it's original position
• Various minor internal changes

For Developers

• Added a way to register external components through AvatarSpawner's RegisterComponent<T>() that will automatically be added to any spawned avatar; an example is available in the API sample project
• LoadedAvatar has been deprecated in favor of AvatarPrefab

Version 5.1.2

Not sure what to do here? Check out the quick start instructions in the README!

Game Compatibility

✔️ Tested with version 1.13.2

Dependencies

Required

• DynamicOpenVR ≥ v0.3.5
• BeatSaberMarkupLanguage ≥ v1.4.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.3.5

Known Issues

• Events do not work in multiplayer
• SteamVR tracker roles might not be recognized properly and prevent the use of full-body tracking

Changes

General

• Added an in-game warning when a height adjust option is used when the base game's automatic height is enabled
• Added an in-game error message if an avatar fails to load
• Minor UI adjustments
• Fixed error when entering avatars menu before current avatar is loaded
• Fixed avatars not in cache showing up as "Unknown" when first loaded
• Fixed loading spinner not disappearing if an avatar fails to load
• Fixed mod ID not matching BeatMods for automatic updates

For Avatar Creators

• Added a force reload button on the bottom right of the avatars list view
• Changes to the avatars in the CustomAvatars folder (created/changed/deleted) are now automatically reflected in-game – no need to restart!

Version 5.1.1

Game Compatibility

✔️ Tested with version 1.13.0

Dependencies

Required

• DynamicOpenVR ≥ v0.3.2
• BeatSaberMarkupLanguage ≥ v1.4.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.3.2

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.
• UnityProject contains a barebones Unity project to get started with creating avatars. Make sure to copy FinalIK.dll and DynamicBone.dll from the game's installation folder into the Assets\Libraries folder before opening the project in Unity to get it working.
• Editor contains only the CustomAvatar.dll file for use in the editor. Use this if you want to update your current Unity project to the latest version of Custom Avatars.

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

Known Issues

• Events do not work in multiplayer
• SteamVR tracker roles might not be recognized properly and prevent the use of full-body tracking

Changes

General

• Fixed tracking not working when using -vrmode oculus (#89)
• Fixed arm span measurement attempting to measure even if both controllers are not connected and tracking

Version 5.1.0

Game Compatibility

✔️ Tested with version 1.13.0

Dependencies

Required

• DynamicOpenVR ≥ v0.3.2
• BeatSaberMarkupLanguage ≥ v1.4.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.3.2

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.
• UnityProject contains a barebones Unity project to get started with creating avatars. Make sure to copy FinalIK.dll and DynamicBone.dll from the game's installation folder into the Assets\Libraries folder before opening the project in Unity to get it working.
• Editor contains only the CustomAvatar.dll file for use in the editor. Use this if you want to update your current Unity project to the latest version of Custom Avatars.

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

Known Issues

• Events do not work in multiplayer
• SteamVR tracker roles might not be recognized properly and prevent the use of full-body tracking

Changes

General

• All avatars can now be used with full-body calibration and tracking! (#77)
• Added new "Entire Environment" floor adjust option that works better with environments with a floor that extends past the player's space (e.g. Linkin Park)
• Fixed mirrors not working properly when floor adjust is used (#79)
• Fixed avatar not following spectator spot in multiplayer (#80)
• Fixed floor not resetting when no avatar is selected
• Fixed controller offset being wrong for Index controllers in certain situations
• Fixed smooth camera not displaying avatar – this can be reverted to the old behaviour by changing showAvatarInSmoothCamera to false in UserData\CustomAvatars.json
• Various small performance improvements

Unity Project

• Switched from Gamma to Linear color space since that's what Beat Saber uses
• PoseManager now shows a message if Animator isn't human
• Fixed hand poses not interpolating properly if hands don't have all 5 fingers with 3 bones each (#86)
• Fixed avatar exporter not working properly on Linux (#85)

Version 5.0.3

Game Compatibility

✔️ Tested with version 1.13.0

Dependencies

Required

• DynamicOpenVR ≥ v0.3.2
• BeatSaberMarkupLanguage ≥ v1.4.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.3.2

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.
• UnityProject contains a barebones Unity project to get started with creating avatars. Make sure to copy FinalIK.dll and DynamicBone.dll from the game's installation folder into the Assets\Libraries folder before opening the project in Unity to get it working.
• Editor contains only the CustomAvatar.dll file for use in the editor. Use this if you want to update your current Unity project to the latest version of Custom Avatars.

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

Known Issues

• Events do not work in multiplayer
• Avatar doesn't follow player when in multiplayer spectator mode (#80)
• Mirror surfaces break when using floor adjust (#79)

Changes

General

• Updated for Beat Saber 1.13.0

Version 5.0.2

Game Compatibility

✔️ Tested with version 1.12.2

Dependencies

Required

• DynamicOpenVR ≥ v0.3.2
• BeatSaberMarkupLanguage ≥ v1.4.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.3.2

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.
• UnityProject contains a barebones Unity project to get started with creating avatars. Make sure to copy FinalIK.dll and DynamicBone.dll from the game's installation folder into the Assets\Libraries folder before opening the project in Unity to get it working.
• Editor contains only the CustomAvatar.dll file for use in the editor. Use this if you want to update your current Unity project to the latest version of Custom Avatars.

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

Known Issues

• Events do not work in multiplayer

Changes

General

• Fixed the game not loading when the VR SDK isn't initialized and the game is started with the first person flying controller (FPFC).