Skip to content

Beat Saber mod that allows the use of custom player avatars for in-game body presence.

License

Notifications You must be signed in to change notification settings

WabsRevenge/BeatSaberCustomAvatars_WithVRMSupport

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Beat Saber Custom Avatars Plugin

GitHub Actions Build Status Latest Release License

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 setting up tracker roles in SteamVR. For instructions, check out OpenXRTrackerProfiles' 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.

Contributing

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>

About

Beat Saber mod that allows the use of custom player avatars for in-game body presence.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 93.8%
  • ShaderLab 5.8%
  • HLSL 0.4%