From 52b4959e78e84f334ee4deef15913f3d4174efed Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 16:15:59 -0400 Subject: [PATCH 1/5] DOCS: Standardize Easy_Weights readme - Add Table of Contents - Add Standard install instructions - Nest features under How to Use header - Add Title - Fix Previous Features Heading --- scripts-blender/addons/easy_weights/README.md | 24 ++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/scripts-blender/addons/easy_weights/README.md b/scripts-blender/addons/easy_weights/README.md index 6a78716a..d5e06141 100644 --- a/scripts-blender/addons/easy_weights/README.md +++ b/scripts-blender/addons/easy_weights/README.md @@ -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. ### Entering 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. 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: - 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. \ No newline at end of file -- 2.30.2 From 7a3000dcc1d617f9a08240668c415bb9f86561ee Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 16:20:52 -0400 Subject: [PATCH 2/5] DOCS: Move Easy_Weights Images --- .../addons/easy_weights}/custom_wp_context_menu.png | Bin .../addons/easy_weights}/toggle_wp_shortcut.png | Bin .../media/addons/easy_weights}/vg_context_menu.png | Bin .../media/addons/easy_weights}/weight_islands.png | Bin .../easy_weights}/wp_context_menu_shortcut.png | Bin scripts-blender/addons/easy_weights/README.md | 10 +++++----- 6 files changed, 5 insertions(+), 5 deletions(-) rename {scripts-blender/addons/easy_weights/docs => docs/media/addons/easy_weights}/custom_wp_context_menu.png (100%) rename {scripts-blender/addons/easy_weights/docs => docs/media/addons/easy_weights}/toggle_wp_shortcut.png (100%) rename {scripts-blender/addons/easy_weights/docs => docs/media/addons/easy_weights}/vg_context_menu.png (100%) rename {scripts-blender/addons/easy_weights/docs => docs/media/addons/easy_weights}/weight_islands.png (100%) rename {scripts-blender/addons/easy_weights/docs => docs/media/addons/easy_weights}/wp_context_menu_shortcut.png (100%) diff --git a/scripts-blender/addons/easy_weights/docs/custom_wp_context_menu.png b/docs/media/addons/easy_weights/custom_wp_context_menu.png similarity index 100% rename from scripts-blender/addons/easy_weights/docs/custom_wp_context_menu.png rename to docs/media/addons/easy_weights/custom_wp_context_menu.png diff --git a/scripts-blender/addons/easy_weights/docs/toggle_wp_shortcut.png b/docs/media/addons/easy_weights/toggle_wp_shortcut.png similarity index 100% rename from scripts-blender/addons/easy_weights/docs/toggle_wp_shortcut.png rename to docs/media/addons/easy_weights/toggle_wp_shortcut.png diff --git a/scripts-blender/addons/easy_weights/docs/vg_context_menu.png b/docs/media/addons/easy_weights/vg_context_menu.png similarity index 100% rename from scripts-blender/addons/easy_weights/docs/vg_context_menu.png rename to docs/media/addons/easy_weights/vg_context_menu.png diff --git a/scripts-blender/addons/easy_weights/docs/weight_islands.png b/docs/media/addons/easy_weights/weight_islands.png similarity index 100% rename from scripts-blender/addons/easy_weights/docs/weight_islands.png rename to docs/media/addons/easy_weights/weight_islands.png diff --git a/scripts-blender/addons/easy_weights/docs/wp_context_menu_shortcut.png b/docs/media/addons/easy_weights/wp_context_menu_shortcut.png similarity index 100% rename from scripts-blender/addons/easy_weights/docs/wp_context_menu_shortcut.png rename to docs/media/addons/easy_weights/wp_context_menu_shortcut.png diff --git a/scripts-blender/addons/easy_weights/README.md b/scripts-blender/addons/easy_weights/README.md index d5e06141..3fcf9342 100644 --- a/scripts-blender/addons/easy_weights/README.md +++ b/scripts-blender/addons/easy_weights/README.md @@ -28,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. I recommend setting up a keybind for this, eg.: - +![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. ### Weight Paint Context Menu 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. - +[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)_ This panel provides quick access to commonly needed tools, whether they are part of core Blender or the addon: @@ -46,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. I recommend to overwrite the shortcut of the default weight paint context menu like so: - +![wp_context_menu_shortcut](/media/addons/easy_weights/wp_context_menu_shortcut.png) ### 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. - +![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. - Clicking the magnifying glass icon will focus the smallest island in the group, so you can decide what to do with it. @@ -60,7 +60,7 @@ The addon provides a super sleek workflow for hunting down rogue weights efficie ### Vertex Group Operators The Vertex Groups context menu is re-organized with more icons and better labels, as well as some additional operators: - +![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 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. -- 2.30.2 From 9c04bca6b6ca4ad3eba87f572c8a7b0a8645a695 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 16:21:10 -0400 Subject: [PATCH 3/5] DOCS: Add Easy_Weights to Sidebar --- docs/.vitepress/config.ts | 1 + docs/addons/easy_weights.md | 2 ++ 2 files changed, 3 insertions(+) create mode 100644 docs/addons/easy_weights.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 2ed40b4e..0802498f 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -67,6 +67,7 @@ export default defineConfig({ { text: 'Blender Gizmos', link: '/addons/bone_gizmos'}, { text: 'Cache Manager', link: '/addons/cache_manager'}, { text: 'Contact Sheet', link: '/addons/contactsheet'}, + { text: 'Easy Weights', link: '/addons/easy_weights'}, { text: 'Geonode Shapekeys', link: '/addons/geonode_shapekeys'}, { text: 'Grase Converter', link: '/addons/grease_converter'}, { text: 'Lattice Magic', link: '/addons/lattice_magic'}, diff --git a/docs/addons/easy_weights.md b/docs/addons/easy_weights.md new file mode 100644 index 00000000..c9af828d --- /dev/null +++ b/docs/addons/easy_weights.md @@ -0,0 +1,2 @@ + + -- 2.30.2 From c61d6ae5109f0395c75c61906b452a1603fabfe3 Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 16:24:04 -0400 Subject: [PATCH 4/5] DOCS: Easy_Weights fix typo in README --- scripts-blender/addons/easy_weights/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts-blender/addons/easy_weights/README.md b/scripts-blender/addons/easy_weights/README.md index 3fcf9342..ba3a2e14 100644 --- a/scripts-blender/addons/easy_weights/README.md +++ b/scripts-blender/addons/easy_weights/README.md @@ -34,7 +34,7 @@ If you don't want to use the hotkey editor, you can also just find the operator ### Weight Paint Context Menu 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. -[custom_wp_context_menu](/media/addons/easy_weights/custom_wp_context_menu.png) +![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)_ This panel provides quick access to commonly needed tools, whether they are part of core Blender or the addon: -- 2.30.2 From 0a1dd43919c17dc7ca63ddfa6994ba78d73b65ca Mon Sep 17 00:00:00 2001 From: Nick Alberelli Date: Wed, 17 May 2023 16:33:15 -0400 Subject: [PATCH 5/5] Docs: Add Easy_Weights to top-level addons readme --- scripts-blender/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/scripts-blender/README.md b/scripts-blender/README.md index 53fe3512..023b3abf 100644 --- a/scripts-blender/README.md +++ b/scripts-blender/README.md @@ -56,6 +56,12 @@ Add-on to create a contactsheet from sequence editor strips. 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 Add-on used by animators to sculpt on linked and overridden meshes. -- 2.30.2