Skip to content

Latest commit

 

History

History
38 lines (31 loc) · 2.39 KB

README.md

File metadata and controls

38 lines (31 loc) · 2.39 KB
Raw

Beat Saber Custom Avatars Plugin

GitHub Actions Build Status Latest Release License

Installing

Install BeatSaberMarkupLanguage and DynamicOpenVR using one of the many available mod installers for Beat Saber or download the latest version from BeatMods.

Download the latest release of Custom Avatars and extract the entire contents of the ZIP file into your Beat Saber folder (for Steam, this is usually C:\Program Files (x86)\Steam\steamapps\common\Beat Saber), overwriting any existing files.

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>