Code Monkey home page Code Monkey 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.

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>

beatsabercustomavatars's People

Contributors

nicoco007 avatar assistant avatar deadlykitten avatar xyonico avatar lukis101 avatar hermanest avatar stevoisiak avatar ormei avatar puredark avatar kitlith avatar sneakometer avatar megalon 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.