Giter VIP home page Giter VIP logo

beatsabercustomavatars's Introduction

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.

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. This is useful if you're developing a mod that relies on Custom Avatars.
  • UnityProject contains a barebones Unity project to get started with creating avatars. You will need 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.

Installing manually

Install BeatSaberMarkupLanguage and DynamicOpenVR (the required versions are listed in Custom Avatars' release notes). Download the latest release of Custom Avatars and extract the entire contents of the ZIP file into your Beat Saber folder and overwrite any existing files. By default, your Beat Saber install folder should be C:\Program Files (x86)\Steam\steamapps\common\Beat Saber for Steam and C:\Program Files\Oculus\Software\Software\hyperbolic-magnetism-beat-saber for Oculus.

Usage Notes

Full-Body Tracking

The way full-body tracking works has changed as of version 5.0.0. You must now do the following for full-body tracking to work:

  • Set up your trackers' roles in SteamVR. This makes it so you no longer need to turn on your trackers in a specific order.
  • Calibrate your avatar in-game or use the "Bypass Calibration" option. Both are in the Avatars menu, under "Avatar Specific" in the settings (left-hand) pane.

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>

    <!-- To use the included Steam launch profiles and your Steam installation isn't in the default folder, change this -->
    <SteamExecutable>C:\Program Files (x86)\Steam\steam.exe</SteamExecutable>
  </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>

beatsabercustomavatars's People

Contributors

assistant avatar deadlykitten avatar kitlith avatar lukis101 avatar megalon avatar nicoco007 avatar ormei avatar puredark avatar sneakometer avatar stevoisiak avatar xyonico avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.