Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/naraenda/narasunitytools

Random tools for Unity to aid in avatar optimization and creation for VRChat.
https://github.com/naraenda/narasunitytools

unity vrchat

Last synced: 3 months ago
JSON representation

Random tools for Unity to aid in avatar optimization and creation for VRChat.

Host: GitHub
URL: https://github.com/naraenda/narasunitytools
Owner: Naraenda
License: other
Archived: true
Created: 2020-11-21T21:44:31.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2023-11-15T16:34:20.000Z (about 1 year ago)
Last Synced: 2024-09-26T08:00:41.202Z (3 months ago)
Topics: unity, vrchat
Language: C#
Homepage:
Size: 19.1 MB
Stars: 61
Watchers: 5
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: LICENSE

Awesome Lists containing this project

README

# Nara's Unity Tools (NUT)

> [!CAUTION]
>
> This package is no longer maintained and thus archived.
> A lot of the features are superseded by other tools and I don't have the time to add new things.
> Thank you all who used Nara's Unity Tools! :heart:
>
> If you're looking for something similar, check out these alternatives:
>
> - PhysBones deprecated the use of the rotation constraint hack.
> The performance of constraints also [does not scale well](https://notes.sleightly.dev/benchmarks/).
> - Animator Tools can be replaced by [Dreadrith's Controller Editor](https://www.dreadrith.com/l/CEditor)
> - Hierarchy Improvements can be replaced by [Drearith's Selection Helper](https://github.com/Dreadrith/SelectionHelper)

---

Place for some of the tools I wrote for Unity.
Specifically for the creation of avatars for VRChat.

## Installation

Installation of Nara's Unity Tools is done via the Unity Package Manager.

### OpenUPM Method

1. In Unity on the top toolbar, go to `Edit > Project Settings > Package Manager`.
2. Add a new Scoped Registry (or edit the existing OpenUPM entry)
```txt
Name package.openupm.com
URL https://package.openupm.com
Scope(s) com.naraenda.nut
```
3. Click Save (or Apply)
4. Open `Window > Package Manager`
5. Next to the `+` icon, select `My Registries`
6. Select `Nara's Unity Tools` and click install on the bottom right.

### Git Method

Make sure [Git](https://git-scm.com/) is installed!

1. In Unity on the top toolbar, go to `Window > Package Manager`.
2. Click the `+` icon and select `Add package from Git URL`.
3. Enter the Git URL of this repository `https://github.com/Naraenda/NarasUnityTools.git`.

## Hierarchy improvements & context menus

Gives a small icon in the hierarchy on game objects that contain dynamic bones (white/gray) or dynamic bone colliders (blue).

![Screenshot of the hierarchy](.Media/hierarchy_screenshot.png)

Also adds a few other context menu items.
Mainly oriented around selecting and setting up dynamic bones.
You can right-click in the hierarchy to quickly select and filter down to dynamic bone components, so you can easily edit multiple items.
Right-clicking a dynamic bone component also allows you to quickly set its root transform to the component's game object.

![Demo of the right menu contexts](.Media/context_demo.gif)

## Animator Tools

Tool that allows the editing of multiple transitions.
This includes conditions and transition timings. Find the window in `Window > Nara > Animator Tools`.

![Screenshot of AT](.Media/at_screenshot.png)

## Chain Rotation Proxy (formerly Dynamic Bone Constraints)

[**>>> Tutorial <<<**](crp_tutorial.md)

Instead of having 50 dynamic bone transformations hogging up the whole main thread it's better to have just a single chain of dynamic bones and have all other bones be move similarly to the single chain.
This can be done via rotation constraints which are significantly cheaper to compute, and they also can be computed on other threads!

![Screenshot of CRP](.Media/crp_screenshot.png)

The tool is pretty simple to use.
Open the window in `Window > Nara > DChain Rotation Proxy`.
Select the objects you want to constrain and click the `From selection` button.
If you already have a chain of bones you want to bind these objects to, then use that as the `Constraint source root`.
`Modify source constraint` will modify (and if needed add) children of the root.
In most cases you can leave the `Constraint source root` empty and just click the magical `Setup constraints` button.
[You can have your PhysBones on your avatar even more optimized in 30 seconds!](https://youtu.be/byvG2FgJEhU)

## Help Me, I'm Stuck

For small questions you can tag me (Nara#0001) in the official VRChat Discord or [join my Discord](https://discord.gg/ysSpNX3HSz).