Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicoco007/BeatSaberCustomAvatars
Beat Saber mod that allows the use of custom player avatars for in-game body presence.
https://github.com/nicoco007/BeatSaberCustomAvatars
beatsaber unity unity-scripts
Last synced: about 1 month ago
JSON representation
Beat Saber mod that allows the use of custom player avatars for in-game body presence.
- Host: GitHub
- URL: https://github.com/nicoco007/BeatSaberCustomAvatars
- Owner: nicoco007
- License: lgpl-3.0
- Created: 2019-11-12T21:20:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T21:33:43.000Z (about 2 months ago)
- Last Synced: 2024-05-06T22:32:25.638Z (about 2 months ago)
- Topics: beatsaber, unity, unity-scripts
- Language: C#
- Homepage:
- Size: 21.3 MB
- Stars: 243
- Watchers: 18
- Forks: 41
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Lists
- awesome-stars - BeatSaberCustomAvatars - game body presence. | nicoco007 | 203 | (C#)
- awesome-stars - BeatSaberCustomAvatars - game body presence. | nicoco007 | 198 | (C#)
- awesome-beatsaber - BeatSaberCustomAvatars - Beat Saber mod that allows the use of custom player avatars for in-game body presence. (Mods)
README
# Beat Saber Custom Avatars Plugin
[](https://github.com/nicoco007/BeatSaberCustomAvatars/actions?query=workflow%3Abuild+branch%3Amain)
[](https://github.com/nicoco007/BeatSaberCustomAvatars/releases/latest)
[](https://github.com/nicoco007/BeatSaberCustomAvatars/blob/master/LICENSE.txt)
## Getting Started
The easiest way to get Custom Avatars up and running is to use [ModAssistant](https://github.com/Assistant/ModAssistant). The latest version of Custom Avatars will always be posted in the [releases](https://github.com/nicoco007/BeatSaberCustomAvatars/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.
### Installing manually
Install [BeatSaberMarkupLanguage](https://github.com/monkeymanboy/BeatSaberMarkupLanguage) and [DynamicOpenVR](https://github.com/nicoco007/DynamicOpenVR/releases) (the required versions are listed in Custom Avatars' release notes). Download [the latest release of Custom Avatars](https://github.com/nicoco007/BeatSaberCustomAvatars/releases/latest) 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
Full-body tracking requires setting up tracker roles in SteamVR. For instructions, check out [OpenXRTrackerProfiles' instructions](https://github.com/nicoco007/BeatSaber-ExtraOpenXRFeatures/tree/main/OpenXRTrackerProfiles#assigning-steamvr-tracker-roles).
## 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
C:\Program Files (x86)\Steam\steamapps\common\Beat Saber
C:\Program Files (x86)\Steam\steam.exe
```
### CustomAvatar-Editor.csproj.user
```xml
C:\Program Files (x86)\Steam\steamapps\common\Beat Saber
C:\Users\Me\Documents\AvatarsUnityProject
```