Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 2 days 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 (about 5 years ago)
Default Branch: main
Last Pushed: 2024-11-03T19:29:47.000Z (10 days ago)
Last Synced: 2024-11-05T06:33:45.272Z (9 days ago)
Topics: beatsaber, unity, unity-scripts
Language: C#
Homepage:
Size: 21.5 MB
Stars: 262
Watchers: 17
Forks: 41
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# Beat Saber Custom Avatars Plugin
[![GitHub Actions Build Status](https://img.shields.io/github/actions/workflow/status/nicoco007/BeatSaberCustomAvatars/build.yml?branch=main&style=flat-square)](https://github.com/nicoco007/BeatSaberCustomAvatars/actions?query=workflow%3Abuild+branch%3Amain)
[![Latest Release](https://img.shields.io/github/v/release/nicoco007/BeatSaberCustomAvatars?style=flat-square)](https://github.com/nicoco007/BeatSaberCustomAvatars/releases/latest)
[![License](https://img.shields.io/github/license/nicoco007/BeatSaberCustomAvatars?style=flat-square)](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.

### 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).

### Creating your own avatar
To get started, check out [the avatars guide on the BSMG wiki](https://bsmg.wiki/models/avatars-guide.html). If you have questions, join the [the BSMG Discord server](https://discord.gg/beatsabermods) and ask in the [#pc-3d-modeling](https://discord.com/channels/441805394323439646/468249466865057802) 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

C:\Program Files (x86)\Steam\steamapps\common\Beat Saber

```

### CustomAvatar-Editor.csproj.user
```xml

C:\Program Files (x86)\Steam\steamapps\common\Beat Saber

C:\Users\Me\Documents\AvatarsUnityProject

```