BeatSaberCustomAvatars

Game Compatibility

✔️ Compatible with Beat Saber 1.37.3

Dependencies

Required

• AssetBundleLoadingTools
• BeatSaberMarkupLanguage
• DynamicBone
• FinalIK
• protobuf-net
• SiraUtil

Optional

• OpenVR API (for showing SteamVR controller/tracker models in-game)
• OpenXR Tracker Profiles (for full body tracking)
• OpenXR Hands (for finger tracking)

Changes

• Updated for Beat Saber 1.37.3

Game Compatibility

✔️ Compatible with Beat Saber 1.37.2

Dependencies

Required

• AssetBundleLoadingTools
• BeatSaberMarkupLanguage
• DynamicBone
• FinalIK
• protobuf-net
• SiraUtil

Optional

• OpenVR API (for showing SteamVR controller/tracker models in-game)
• OpenXR Tracker Profiles (for full body tracking)
• OpenXR Hands (for finger tracking)

Changes

• Fixed a regression introduced in 5.4.2

Game Compatibility

✔️ Compatible with Beat Saber 1.37.2

Dependencies

Required

• AssetBundleLoadingTools
• BeatSaberMarkupLanguage
• DynamicBone
• FinalIK
• protobuf-net
• SiraUtil

Optional

• OpenVR API (for showing SteamVR controller/tracker models in-game)
• OpenXR Tracker Profiles (for full body tracking)
• OpenXR Hands (for finger tracking)

Changes

• Updated for Beat Saber 1.37.2

Game Compatibility

✔️ Compatible with Beat Saber 1.37.0 – 1.37.1

Dependencies

Required

• AssetBundleLoadingTools
• BeatSaberMarkupLanguage
• DynamicBone
• FinalIK
• protobuf-net
• SiraUtil

Optional

• OpenVR API (for showing SteamVR controller/tracker models in-game)
• OpenXR Tracker Profiles (for full body tracking)
• OpenXR Hands (for finger tracking)

Changes

• Fixed various issues with BeatLeader replay compatibility (#159)
• Minor adjustments to automatic full body calibration

Game Compatibility

✔️ Compatible with Beat Saber 1.37.0

Dependencies

Required

• AssetBundleLoadingTools
• BeatSaberMarkupLanguage
• DynamicBone
• FinalIK
• protobuf-net
• SiraUtil

Optional

• OpenVR API (for showing SteamVR controller/tracker models in-game)
• OpenXR Tracker Profiles (for full body tracking)
• OpenXR Hands (for finger tracking)

Changes

• Completely reworked tracking and calibration
• Fixed duplication of dust particles after opening the avatars menu
• Various other bug fixes and minor performance improvements

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

Game Compatibility

❌ Not compatible with 1.29.4

✔️ Tested with Beat Saber 1.29.0 – 1.29.3

Known Issues

• Some full body tracking solutions like VMT do not work.
• SaberTailor adjustments do not apply to avatar hands.

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.6.0
• SiraUtil ≥ 3.0.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

• Updated for Beat Saber 1.29.0
• Fixed tracking delays when running on AMD 7900 XTX GPUs (#145)

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

Game Compatibility

✔️ Tested with Beat Saber 1.28.0

Known Issues

• Some full body tracking solutions like VMT do not work.
• SaberTailor adjustments do not apply to avatar hands.

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.6.0
• SiraUtil ≥ 3.0.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

• Various updates and fixes to EventManager (#144):
  • Added left/right events where applicable
  • Added new events for bad cuts, missed notes, multiplier down, multiplayer lobby entered
  • Made chain notes count as a single note instead of triggering for each segment
  • Fixed level start event triggering too early and not working for animator triggers
  • Fixed enter menu event not triggering at the right times
  • Fixed bombs counting as valid cuts
• Added helper gizmos for wrist to palm axis and palm to thumb axis
• Fixed Dynamic Bones being overridden by animations
• Fixed saber sparkles triggering at the wrong height when floor is offset

Note: the lighting system that used to be included has been extracted as its own mod and will be available within a few days of this release.

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

Game Compatibility

✔️ Tested with Beat Saber 1.27.0

⚠️ Works with 1.28.0 but avatar list may have promo colors/tags visible

Known Issues

• Some full body tracking solutions like VMT do not work.
• SaberTailor adjustments do not apply to avatar hands.

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.6.0
• SiraUtil ≥ 3.0.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Added height measurement separate from game's height
• Added toggle to prevent menu mirror from rendering on non-HMD cameras
• Removed bad motion smoothing "algorithm"
• Fixed controller Z offset not rotating left hand in the correct direction (#140)
• Fixed unnecessary performance hit in levels with mirrors
• Fixed animations overriding finger tracking
• Fixed floor height adjust not working as expected in levels when set to "Player's Place Only"
• Fixed excessive resolution on menu mirror
• Fixed locomotion behaving strangely in Noodle Extensions maps that move the player (#127)

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

Game Compatibility

✔️ Tested with Beat Saber 1.20.0 to 1.27.0

Known Issues

• Some full body tracking solutions like VMT do not work.
• SaberTailor adjustments do not apply to avatar hands.

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.6.0
• SiraUtil ≥ 3.0.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Updated for Beat Saber 1.20.0
• Fixed hands not matching controller Z rotation offset
• Disabled the OnBlueLightOn and OnRedLightOn events since they were inconsistent at best and don't make sense with the new lighting system

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

Game Compatibility

✔️ Tested with Beat Saber 1.19.0/1.19.1

❌ Not compatible with Beat Saber 1.20.0+

Known Issues

• Some full body tracking solutions like VMT do not work.
• SaberTailor adjustments do not apply to avatar hands.

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.6.0
• SiraUtil ≥ 3.0.0

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Updated for Beat Saber 1.19.0
• Fixed current avatar not being selected when first opening the Avatars menu
• Fixed joystick scrolling not working on avatars list

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

Game Compatibility

✔️ Tested with Beat Saber 1.18.0

❌ Not compatible with Beat Saber 1.19.0+

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.5.9
• SiraUtil ≥ 2.5.8

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Updated for Beat Saber 1.18.0

Editor

• Switched back to Unity 2019.3.15f1 since 2019.4.28f1 was causing issues with ModelSaber.

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

Game Compatibility

✔️ Tested with Beat Saber 1.17.0-1.18.0

❌ Not compatible with Beat Saber 1.19.0+

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.5.4
• SiraUtil ≥ 2.5.6

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Added progress bar when loading an avatar
• Added show in smooth camera setting
• Added show in mirrors setting
• Fixed mod potentially not loading at all when running on Linux/Proton
• Fixed potential hard crash on Linux/Proton (#119)

Editor

• Updated to Unity 2019.4.28f1

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

Game Compatibility

✔️ Tested with Beat Saber 1.16.3/1.16.4

❌ Not compatible with Beat Saber 1.17.0+

Known Issues

• Trying to load the plugin on Linux/Proton can completely fail
• Starting a song when on Linux/Proton can cause a hard crash of the game (#119)

Dependencies

Required

• DynamicOpenVR ≥ v0.4.0
• BeatSaberMarkupLanguage ≥ v1.5.4
• SiraUtil ≥ 2.5.6

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Updated for Beat Saber 1.16.3
• Added manual input for arm span (#115)
• Fixed mirror anti-aliasing showing "1x" instead of "Off"
• Fixed room adjust not applying to avatar properly in ScoreSaber's spectator mode
• Various internal improvements

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

Game Compatibility

❌ Does not work with 1.16.3+

✔️ Tested with 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

• Fixed performance issues in menu (#110)

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

Game Compatibility

⚠️ Some issues with version 1.16.2

Known Issues

• Some people have reported stutters/very low framerate/crashes when opening the avatars menu (#110).

Dependencies

Required

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

Optional

• DynamicOpenVR.BeatSaber ≥ v0.4.0

Changes

General

• Fixed crash at startup

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

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

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

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

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