BeatSaberCustomAvatars

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!

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

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)

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

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).

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 arm span calculation not respecting avatar configuration in certain cases
• Fixed improper tracking when using room adjust
• Fixed calibration not applying properly when using room adjust
• Fixed avatar not respecting floor position when manually calibrating
• Fixed calibration buttons resetting if tracking state changes while calibrating

After nearly a year of beta, it's finally out!

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
• Applying both a position and rotation offset in room adjust makes the avatar not follow the HMD/controllers/trackers properly
• Calibration sometimes doesn't work as expected when room adjust is used

Changes

General

• Updated for Beat Saber 1.12.2
• Added loading indicators to Avatars menu
• Completely reworked the tracking system so it's more reliable, especially with extra trackers
• Fixed trackers not being detected at all when too many SteamVR devices are connected (#40)
• Fixed LIV camera being detected as a full body tracker (#70)
• Fixed TwistRelaxers not working as expected
• Fixed avatars list scrolling when an avatar is selected
• Fixed settings causing errors and breaking if the "No Avatar" option is selected
• Fixed avatar not resizing when player height is changed

For Developers

• Tracking information for the player can now be accessed externally via the VRPlayerInput class available through Zenject (#54). Check out the updated API sample for an example.

Game Compatibility

✔️ Tested with version 1.11.1

❌ Not compatible with 1.12.1/1.12.2

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.

Changes

• Added setting to lock feet in place (#62)
• Fixed Avatars menu not opening properly when the "No Avatar" option was previously selected
• Fixed error on game start when the "No Avatar" option was previously selected
• Fixed default full body tracking smoothing values
• Fixed saber start/stop colliding events not working
• Fixed exception when game is closed
• Fixed calibration data loading data for nonexistent files
• Fixed floor not moving after entering a song (#59)
• Fixed avatars sometimes floating above/sinking into the floor when calibrating (#61)
• Fixed tracking issues with certain avatars (#65)

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.

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.

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!)

Hotfixes!

Compatible with Beat Saber 1.7.0 only.

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

• 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

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

• 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

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

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

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™