BeatSaberCustomAvatars

Beat Saber Custom Avatars Plugin

Getting Started

The easiest way to get Custom Avatars up and running is to use ModAssistant. The latest version of Custom Avatars will always be posted in the releases here, and then become available on ModAssistant a few days later. If you want to install it manually by using the releases available here or are looking for the files to create an avatar yourself, you can follow the instructions below.

Full-Body Tracking

Full-body tracking requires OpenXR Tracker Profiles (which can be installed through mod managers or downloaded and installed manually) and setting up tracker roles in SteamVR. For instructions on how to do the latter, check out OpenXR Tracker Profiles’ instructions.

Creating your own avatar

To get started, check out the avatars guide on the BSMG wiki. If you have questions, join the the BSMG Discord server and ask in the #pc-3d-modeling channel.

Building Custom Avatars

GitHub Packages

Modern editors will prompt you to enter a username and password for GitHub packages on first build. You can follow GitHub’s Authenticating to GitHub Packages instructions to generate a token you can use as the password in such a prompt. If you use dotnet build, you can set the username and password via CLI:

$ dotnet nuget update source "nicoco007 GitHub Packages" --username "your GitHub username or email" --password "your GitHub access token"

Setting the path to your Beat Saber installation folder

To resolve references and automatically copy the compiled DLL into Beat Saber’s installation directory, first create files called CustomAvatar.csproj.user and CustomAvatar-Editor.csproj.user next to Source\CustomAvatar\CustomAvatar.csproj and Source\CustomAvatar-Editor\CustomAvatar-Editor.csproj respectively. Then paste in the following contents:

CustomAvatar.csproj.user

<?xml version="1.0" encoding="utf-8"?>
<Project>
  <PropertyGroup>
    <!-- Replace this with the path to your Beat Saber installation -->
    <BeatSaberDir>C:\Program Files (x86)\Steam\steamapps\common\Beat Saber</BeatSaberDir>
  </PropertyGroup>
</Project>

CustomAvatar-Editor.csproj.user

<?xml version="1.0" encoding="utf-8"?>
<Project>
  <PropertyGroup>
    <!-- Replace this with the path to your Beat Saber installation -->
    <BeatSaberDir>C:\Program Files (x86)\Steam\steamapps\common\Beat Saber</BeatSaberDir>

    <!-- Replace this with the path to your Custom Avatars Unity Project or leave it empty if you don't have one -->
    <UnityProjectDir>C:\Users\Me\Documents\AvatarsUnityProject</UnityProjectDir>
  </PropertyGroup>
</Project>

Note that if you have Beat Saber Modding Tools installed it should automatically set BeatSaberDir for you but will not set UnityProjectDir for the Editor project.