Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/foxcapades/blender-vr-avatar-utils

Miscellaneous utilities for working on VR avatars and accessories in Blender.
https://github.com/foxcapades/blender-vr-avatar-utils

blender blender-addon vr vrchat vrchat-avatars

Last synced: 2 months ago
JSON representation

Miscellaneous utilities for working on VR avatars and accessories in Blender.

Awesome Lists containing this project

README

        

= VR Avatar Utilities
:icons: font

:feature-version: 0.2.0

:url-gh-repo: https://github.com/Foxcapades/blender-vr-avatar-utils

A growing collection of utilities that I have created to assist my workflows
working on optimizing and creating custom content for VR avatars in Blender.

image:https://img.shields.io/badge/blender-4.1-ff9f1c?logo=blender[Target Blender Version]
image:https://img.shields.io/github/v/release/Foxcapades/blender-vr-avatar-utils?label=%F0%9F%A7%A9%20release&color=%23cbf3f0[Release Version, link={url-gh-repo}/releases/latest]
image:https://img.shields.io/badge/%F0%9F%93%96%20docs-{feature-version}-ffbf69[Documentation, link=https://foxcapades.github.io/blender-vr-avatar-utils/v{feature-version}]
image:https://img.shields.io/github/license/Foxcapades/blender-vr-avatar-utils?color=2ec4b6[License, link={url-gh-repo}/blob/main/license]

Developed against Blender 4.1.1. May technically be compatible with previous
Blender versions but has not been tested on any.

link:https://foxcapades.github.io/blender-vr-avatar-utils/v{feature-version}/[📖 *Documentation*]

== Features

This plugin adds new collapsible panels titled "VR Avatar Utils" to the "Data"
tab in the "Armature" and "Mesh" contexts.

=== Armatures

==== Bone Rotation Mode Normalization

Allows converting the transform rotation mode of all bones in an armature to a
target value without altering the rotation.

=== Meshes

==== Synchronize Shape Keys

Synchronizes the values of shape keys on the current mesh with matching shape
keys on other meshes in the scene or file.

==== Invert Shape Keys

Allows inverting a shape key, making the shape key value the new basis and
creating a new shape key which returns the object to its former basis state (or
alternatively a custom toggle state).

.YouTube Demo
--
image::https://img.youtube.com/vi/MoKPCiHkieA/0.jpg[link=https://youtu.be/MoKPCiHkieA]
--

==== Rename Shape Keys

Allows mass renaming of shape keys across all meshes in the scene or file.

== Installation Instructions

=== New Installation

General Blender Add-on information, see the https://docs.blender.org/manual/en/latest/editors/preferences/addons.html[Blender docs].

. Download the {url-gh-repo}/releases/latest[latest release] zip file (named
`fxcpds-vr-avatar-utils-v{feature-version}.zip` or similar).

. From Blender, open the Preferences window via *Edit > Preferences*.

. In the Preferences window select the 'Add-ons' section from the list of
sections on the left.

. Click the 'Install...' button near the top right of the Add-ons section.

. Browse to and select the zip file downloaded in step #1.

. Check the checkbox next to the plugin with the text: "Object: Foxcapades' VR
Avatar Utils" to enable the plugin.
+
[NOTE]
--
Occasionally, the Add-ons Preferences section will not automatically filter to
the newly added addon. In this case, use the filter box to type in the plugin
name to find the plugin to enable.
--

=== Updating

Currently, the plugin update process is a bit obnoxious in that Blender must be
restarted to start using the updated plugin.

. Follow the <> instructions.

. Restart Blender

. Follow the <> instructions.

=== Removing

. From Blender, open the Preferences window via *Edit > Preferences*.

. In the preferences window select the 'Add-ons' section from the list of
sections on the left.

. Using the search box near the top right of the Add-ons section, type in the
name of the addon to filter the addon list to locate this addon.

. Click the â–¶ icon on the left of the addon entry in the list to expand the
addon details.

. At the bottom of the expanded addon details, click the button labeled
"Remove".

== Change Log

[cols='1,9a']
|===
| v0.2.1
| * When the 'New Basis' key is the same as the 'Toggle Key' value for shape key
inversion, the shape from that shape key **WILL NOT** be used as the new toggle
key shape. The original basis will be used as the new toggle key shape.

| v0.2.0
| .Features:

* Shape Key Inversion

.Changes:

* Minor phrasing tweaks in help texts.

| v0.1.0
| Initial release.

.Includes:
* Bone Rotation Normalization
* Shape Key Value Synchronization
* Shape Key Bulk Renaming
|===