Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
theRussetPotato committed Aug 22, 2021
1 parent ee68062 commit c078415
Showing 1 changed file with 43 additions and 24 deletions.
67 changes: 43 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,78 @@
# Weights Editor

A tool to edit skin weights on a vertex level.

A tool to edit skin weights on a vertex level.<br>
It was heavily influenced by Softimage's weight editor.

At the moment it has been tested and used in production in Maya 2016.5 and 2018. As a result, this tool is supported for both Qt4 and Qt5.
![weightsEditorTable](https://user-images.githubusercontent.com/14979497/130363389-e8066ff5-5469-41d2-bede-c395baf90716.png)<br>
_Interface using the table view_

![weightsEditorList](https://user-images.githubusercontent.com/14979497/130364248-ee8185c4-c03d-4e28-a219-f0cfcec54269.png)<br>
_Interface using the list view_

## Features

- Editable table and list views to quickly set weights
- Buttons with preset values to add, subtract, scale, or set weights
- Quickly lock or unlock selected influences by pressing space
- Influence list on the side
- Displays weights in different color themes
- Weight utilities to prune, smooth, mirror, and copy weights
- Button to flood full weights to the vertex's closest influence for quick blocking
- All operations support undo/redo

## Supported versions

In short, Maya 2017 and above is supported.<br>
Release v2.0.0 was heavily used in production in Maya 2018 Extension 4.<br>
It was also rewritten to work with Python 3 so it will run on Maya 2022.<br>

<img src="http://www.jasonlabbe3d.com/resources/images/github/weights_editor_window.jpg" width="500">
For earlier versions of Maya using PySide (Qt4), only release v1.0.0 will work as future releases will only support PySide2 (Qt5).

## Installation

Open up a session of Maya then drag and drop the installer file DRAG_AND_DROP_INSTALLER.py into the viewport. Please do not move this file, it uses relative paths to copy over the files.
Follow the instructions to complete the installation.
- Open up a session of Maya<br>
- Drag and drop the installer file `DRAG_AND_DROP_INSTALLER.py` into the viewport. Please do not move this file, it uses relative paths to copy over the files.<br>
- Follow the instructions to complete the installation.

If you chose the option to add a shelf button then Maya needs to restart in order for it to show up.
If you prefer to manually install it then simply copy the `weights_editor_tool` directory to wherever your Python path is pointing to.

After installation you can immediately test if it's working ok by executing the following in the script editor to run the tool:
After installation you can immediately launch the tool by executing in the script editor:

```
from weights_editor_tool import weights_editor
weights_editor.run()
```

If you prefer to manually install it then simply copy the `weights_editor_tool` directory to wherever your Python path is pointing to.

## Dependencies

There's no need to install any extra libraries as this tool uses all native Python modules that ship with Maya.
This tool doesn't require any extra libraries and uses all native modules that ship with Maya.

The tool does use a plugin to do a smooth with all influcences, but is not necessary to install. By default this feature will be disabled if the plugin is not loaded.
An optional plugin is needed to perform a smooth with all influences.<br>
By default this feature will be disabled if the plugin is not loaded.

The plugin is smoothSkinClusterWeight by Ingo Clemens (Brave Rabbit). You can find the appropriate plugin for your OS and Maya version <a href='http://www.braverabbit.com/smoothskinclusterweight'>here</a>.
The plugin is `smoothSkinClusterWeight` by <a href='http://www.braverabbit.com'>Ingo Clemens</a>.<br>
It's fantastic, free, and you can download it <a href='https://www.braverabbit.com/braverabbit/tools/brsmoothweights/'>here</a>.

## Reporting a bug

If you run into any errors during installation or using the tool itself, then please send an e-mail to jasonlabbe@gmail.com
If you run into any errors during installation or using the tool itself, then please <a href='https://github.com/theRussetPotato/weights_editor/issues'>create a new issue</a> from this repository.

Please include the following:

* Your operating system
* Your operating system (Windows, Linux, Mac)
* Your version of Maya
* If possible, open up the script editor and copy & paste the error message.
* If possible, include a screenshot showing the error.
* Include any steps that will reproduce the error.

## Requests and new features

If you have any ideas to improve this tool then feel free to send any suggestions!
If you have any ideas to improve this tool then feel free to <a href='https://github.com/theRussetPotato/weights_editor/issues'>send any suggestions</a>!

## Credits and thanks

Enrique Caballero and John Lienard for pushing me to make this.

Ingo Clemens (Brave Rabbit) for his <a href='http://www.braverabbit.com/smoothskinclusterweight'>smoothSkinClusterWeight plugin</a>.

Tyler Thornock for his <a href='http://www.charactersetup.com/tutorial_skinWeights.html'>tutorial</a> on a faster approach to get/set skin weights.

Enrique Caballero and John Lienard for pushing me to make this.<br>
Ingo Clemens (Brave Rabbit) for his <a href='https://www.braverabbit.com/braverabbit/tools/brsmoothweights/'>smoothSkinClusterWeight plugin</a>.<br>
Tyler Thornock for his <a href='http://www.charactersetup.com/tutorial_skinWeights.html'>tutorial</a> on a faster approach to get/set skin weights.<br>

<br>
<b>Happy skinning :)</b>
### Happy skinning :)

0 comments on commit c078415

Please sign in to comment.