Nextr Rig UI
This is a legacy version of the wiki for the legacy version of the UI. You really shouldn't be using the old version. But if you have no choice I'll keep the old wiki. Old version of the UI is kept in the legacy branch
The script allows you to generate custom UI for you characters.
Clone or download the repository. Open Blender and navigate to the text editor. Click on the Text tab and than Open. Navigate to the folder with nextrrig_ui.py and open it.
Every feature is demonstrated in the template.blend file. If you are unsure how to set up something try to compare it with the file.
There are few steps you need to do so the script can work properly.
Open the text editor again with the script and on line 6 is a variable called character_name, replace Suzanne with the name of your character.
Contents of the variable is also the exact name of the master Collection housing the rig which has also the same name and all of the objects belonging to the character.
The master collection should contain at least 3 more collections listed below.
- Suzanne Outfits
- Suzanne Body
- Suzanne Hair
This collection should only contain more collections and each represents an outfit. The name of the collection is going to be used as the name in the UI. It's good to prefix it with the character's name so when using multiple rigs with same collection structure they don't merge.
- Suzanne Outfit 1
- Suzanne Outfit 2
With the config of collections shown above the script will show 2 outfits. Each outfit can contain as many objects as you want, their names are going to be used as the label for the button in the UI. You can nest objects and the parent is going to toggle it's children.
For example if you have a belt and on the belt there are some items, like gun in a holster. You can parent the holster to the belt, and gun to the holster. The UI is going to recognize it and if you hide the belt it's going to hide the holster and since the gun is a child if the holster it's also going to get hidden.
Outfits can also be combined. If you click on the lock button next to item it's not going to be hidden when you select a different outfit. You don't have to do anything for it to work.
Sometimes your weight painting is not perfect on the body and/or on the clothing and you need to mask certain parts to remove clipping. The UI will automatically enable/disable the mask modifier if you toggle the clothing piece or change outfit.
For it to work add a modifier on the body object and name it so it the modifier's name contains the exact name of the object and the word mask
For example like this:
| Possible names |
|---|
| Hatmask |
| HatMask |
| Hat mask |
| Hat Mask |
This feature works like the auto masking but with shape keys.
You just need to add a shape key on the body object containing the name and the word shape
| Possible names |
|---|
| Hatshape |
| HatShape |
| Hat shape |
| Hat Shape |
This feature is stable but lacks user friendly setup
This features differs from attributes. These settings are shown directly next to the outfit piece
You can expose modifiers to the UI but this feature is hard to set up because there is no user friendly or automated way. You will have to open the Console and use this command:
bpy.data.objects['Hat'].data['settings'] = {'modifiers':['Subdivision']}This command sets a custom settings property to the Hat object and sets to contain this value {'modifiers':['Subdivision']}
The key modifiers is there so the script know what type of setting it is(in the future I'd like to add more types) and in the [] are the names of the modifiers on the object. If it's not visible in the UI it means that the name is not exact. If successfully added you'll be able to toggle the visibility of the modifier from the UI.
This collection should contain all of the meshes which are part of the body, eyes, teeth, horns,...
It also has to contain the body object and it's name has to be Suzanne Body
This collection contains all of the hairdos. It is special in a way that it can contain both objects and collections but they are treated the same. It's because complicated hairdos can be made out of multiple different objects.
If your hair object or collection contains in it's name name of an outfit and you don't have the lock icon enabled it is going to change the hair to match the outfit. Not all hairdos have to have outfit and vice versa.
Check the template file if you are not sure how any of this works.
This feature has been tested but is not finished
All of the panels contain a section called Attributes (except for the Links Panel). These attributes are grouped into Attribute Groups which can be collapsed, have their name and icon set.
Attribute can be pretty much anything you can access by Data Path.
Attributes can also be conditionally hidden or shown.
- Show the attribute when only some specific bone is selected
- Show the attribute when an expression is truthful.
- Add UI for setting up settings
- Add UI for setting up attributes
- Finish attributes UI
- Test attributes
- Support multiple UIs in one scene