Add Easy Weights to pipeline docs #51

Merged
Nick Alberelli merged 5 commits from docs/add-easy-weights into main 2023-05-17 23:06:02 +02:00
9 changed files with 37 additions and 6 deletions

View File

@ -67,6 +67,7 @@ export default defineConfig({
{ text: 'Blender Gizmos', link: '/addons/bone_gizmos'}, { text: 'Blender Gizmos', link: '/addons/bone_gizmos'},
{ text: 'Cache Manager', link: '/addons/cache_manager'}, { text: 'Cache Manager', link: '/addons/cache_manager'},
{ text: 'Contact Sheet', link: '/addons/contactsheet'}, { text: 'Contact Sheet', link: '/addons/contactsheet'},
{ text: 'Easy Weights', link: '/addons/easy_weights'},
{ text: 'Geonode Shapekeys', link: '/addons/geonode_shapekeys'}, { text: 'Geonode Shapekeys', link: '/addons/geonode_shapekeys'},
{ text: 'Grase Converter', link: '/addons/grease_converter'}, { text: 'Grase Converter', link: '/addons/grease_converter'},
{ text: 'Lattice Magic', link: '/addons/lattice_magic'}, { text: 'Lattice Magic', link: '/addons/lattice_magic'},

View File

@ -0,0 +1,2 @@
<!--@include: ../../scripts-blender/addons/easy_weights/README.md-->

View File

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 43 KiB

After

Width:  |  Height:  |  Size: 43 KiB

View File

Before

Width:  |  Height:  |  Size: 374 KiB

After

Width:  |  Height:  |  Size: 374 KiB

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

@ -56,6 +56,12 @@ Add-on to create a contactsheet from sequence editor strips.
Author: Paul Golter Author: Paul Golter
## Easy Weights
Easy Weight is an addon focused on quality of life improvements for weight painting in Blender.
Author & Maintainer: Demeter Dzadik
## Geonode Shapekeys ## Geonode Shapekeys
Add-on used by animators to sculpt on linked and overridden meshes. Add-on used by animators to sculpt on linked and overridden meshes.

View File

@ -1,3 +1,25 @@
# Easy Weights
Easy Weight is an addon focused on quality of life improvements for weight painting in Blender.
## Table of Contents
- [Installation](#installation)
- [How to Use](#how-to-use)
- [Entering Weight Paint Mode](#entering-weight-paint-mode)
- [Weight Paint Context Menu](#weight-paint-context-menu)
- [Hunting Rogue Weights](#hunting-rogue-weights)
- [Vertex Group Operators](#vertex-group-operators)
- [Force Apply Mirror Modifier](#force-apply-mirror-modifier)
- [Previous Features](#previous-features)
## Installation
1. Clone repository `git clone https://projects.blender.org/studio/blender-studio-pipeline.git`
2. From the root of the repository navigate to `/scripts-blender/addons/`
3. Find the the `easy_weights` Place this folder in your Blender addons directory or create a symlink to it.
## How to Use
Easy Weight is an addon focused on quality of life improvements for weight painting in Blender. Easy Weight is an addon focused on quality of life improvements for weight painting in Blender.
### Entering Weight Paint Mode ### Entering Weight Paint Mode
@ -6,13 +28,13 @@ Simply select your mesh object and run the operator. The armature will be un-hid
Run the operator again to reset the armature object's visibility states to what they were before you entered weight paint mode. Run the operator again to reset the armature object's visibility states to what they were before you entered weight paint mode.
I recommend setting up a keybind for this, eg.: I recommend setting up a keybind for this, eg.:
<img src="docs/toggle_wp_shortcut.png" width="400" /> ![toggle_wp_shortcut](/media/addons/easy_weights/toggle_wp_shortcut.png)
If you don't want to use the hotkey editor, you can also just find the operator in the "Object" or "Weights" menus, and simply Right Click->Assign Shortcut. If you don't want to use the hotkey editor, you can also just find the operator in the "Object" or "Weights" menus, and simply Right Click->Assign Shortcut.
### Weight Paint Context Menu ### Weight Paint Context Menu
The default context menu (accessed via W key or Right Click) for weight paint mode is not very useful. The default context menu (accessed via W key or Right Click) for weight paint mode is not very useful.
The Custom Weight Paint Context Menu operator is intended as a replacement for it. The Custom Weight Paint Context Menu operator is intended as a replacement for it.
<img src="docs/custom_wp_context_menu.png" width="250" /> ![custom_wp_context_menu](/media/addons/easy_weights/custom_wp_context_menu.png)
_(The "OK" button is not needed, I just can't avoid it)_ _(The "OK" button is not needed, I just can't avoid it)_
This panel provides quick access to commonly needed tools, whether they are part of core Blender or the addon: This panel provides quick access to commonly needed tools, whether they are part of core Blender or the addon:
@ -24,11 +46,11 @@ It lets you change the brush falloff type (Sphere/Projected) and the Front Faces
Also, the color of your brushes will be darker when you're using Sphere falloff. Also, the color of your brushes will be darker when you're using Sphere falloff.
I recommend to overwrite the shortcut of the default weight paint context menu like so: I recommend to overwrite the shortcut of the default weight paint context menu like so:
<img src="docs/wp_context_menu_shortcut.png" width="500" /> ![wp_context_menu_shortcut](/media/addons/easy_weights/wp_context_menu_shortcut.png)
### Hunting Rogue Weights ### Hunting Rogue Weights
The addon provides a super sleek workflow for hunting down rogue weights efficiently but safely, with just the right amount of automation. This functionality can be found in the Sidebar->EasyWeight->Weight Islands panel. The addon provides a super sleek workflow for hunting down rogue weights efficiently but safely, with just the right amount of automation. This functionality can be found in the Sidebar->EasyWeight->Weight Islands panel.
<img src="docs/weight_islands.png" width="800" /> ![weight_islands](/media/addons/easy_weights/weight_islands.png)
- After pressing Calculate Weight Islands and waiting a few seconds, you will see a list of all vertex groups which consist of more than a single island. - After pressing Calculate Weight Islands and waiting a few seconds, you will see a list of all vertex groups which consist of more than a single island.
- Clicking the magnifying glass icon will focus the smallest island in the group, so you can decide what to do with it. - Clicking the magnifying glass icon will focus the smallest island in the group, so you can decide what to do with it.
@ -38,7 +60,7 @@ The addon provides a super sleek workflow for hunting down rogue weights efficie
### Vertex Group Operators ### Vertex Group Operators
The Vertex Groups context menu is re-organized with more icons and better labels, as well as some additional operators: The Vertex Groups context menu is re-organized with more icons and better labels, as well as some additional operators:
<img src="docs/vg_context_menu.png" width="500" /> ![vg_context_menu](/media/addons/easy_weights/vg_context_menu.png)
- **Delete Empty Deform Groups**: Delete deforming groups that don't have any weights. - **Delete Empty Deform Groups**: Delete deforming groups that don't have any weights.
- **Delete Unused Non-Deform Groups**: Delete non-deforming groups that aren't used anywhere, even if they do have weights. - **Delete Unused Non-Deform Groups**: Delete non-deforming groups that aren't used anywhere, even if they do have weights.
- **Delete Unselected Deform Groups**: Delete all deforming groups that don't correspond to a selected pose bone. Only in Weight Paint mode. - **Delete Unselected Deform Groups**: Delete all deforming groups that don't correspond to a selected pose bone. Only in Weight Paint mode.
@ -51,7 +73,7 @@ If you have any more suggestions, feel free to open an Issue with a feature requ
In Blender, you cannot apply a mirror modifier to meshes that have shape keys. In Blender, you cannot apply a mirror modifier to meshes that have shape keys.
This operator tries to anyways, by duplicating your mesh, flipping it on the X axis and merging into the original. It will also flip vertex groups, shape keys, shape key masks, and even (attempt) shape key drivers, assuming everything is named with .L/.R suffixes. This operator tries to anyways, by duplicating your mesh, flipping it on the X axis and merging into the original. It will also flip vertex groups, shape keys, shape key masks, and even (attempt) shape key drivers, assuming everything is named with .L/.R suffixes.
### Previous Features ## Previous Features
Over time as more things have been fixed on Blender's side, some features have been removed. To avoid confusion, these are listed here: Over time as more things have been fixed on Blender's side, some features have been removed. To avoid confusion, these are listed here:
- As of [Blender 3.1](https://developer.blender.org/rBa215d7e230d3286abbed0108a46359ce57104bc1), holding the Ctrl and Shift buttons in weight painting will use the Subtract and Blur brushes respectively, removing the need for the shortcuts on the 1, 2, 3 keys this addon used to add to provide quick brush switching. - As of [Blender 3.1](https://developer.blender.org/rBa215d7e230d3286abbed0108a46359ce57104bc1), holding the Ctrl and Shift buttons in weight painting will use the Subtract and Blur brushes respectively, removing the need for the shortcuts on the 1, 2, 3 keys this addon used to add to provide quick brush switching.
- As of [Blender 3.0](https://developer.blender.org/rBSc0f600cad1d2d107d189b15b12e2fcc6bba0985c), the weight paint overlay is no longer multiplied on top of the underlying colors, removing the need for this addon to change shading or object display settings when using the Toggle Weight Paint mode operator. - As of [Blender 3.0](https://developer.blender.org/rBSc0f600cad1d2d107d189b15b12e2fcc6bba0985c), the weight paint overlay is no longer multiplied on top of the underlying colors, removing the need for this addon to change shading or object display settings when using the Toggle Weight Paint mode operator.