Skip to content

Commit bfbafe3

Browse files
committed
update readme
1 parent 2fa0822 commit bfbafe3

File tree

4 files changed

+47
-35
lines changed

4 files changed

+47
-35
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,14 @@ A collection of workflow related tools for Maya.
99
- Windows: `~/Documents/maya/modules/`
1010
- Mac: `~/Library/Preferences/Autodesk/maya/modules/`
1111
- Linux: `~/maya/modules/`
12-
- You may have to create the `modules` folder if it does not exist
13-
- Once installed, the result should look like this:
14-
- `.../modules/workflowtools/...`
15-
- `.../modules/workflowtools.mod`
12+
13+
> Note that you may need to create the `modules` folder if it does not exist.
14+
15+
Once installed, the result should look like this:
16+
```
17+
.../modules/workflowtools/
18+
.../modules/workflowtools.mod
19+
```
1620

1721
## Setup & Usage
1822

src/workflowtools/scripts/quickmenus/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,40 +4,40 @@ A set of marking menus for making common tasks more eficient.
44

55
There are currently 2 sets of menus, F-Menus, and Q-Menus, named by the default hotkeys that they are assigned to.
66

7+
## Hotkey Setup
8+
9+
After launching Maya, a first-time setup is required for registering the hotkeys, run this python script in the Script
10+
Editor:
11+
12+
```python
13+
import quickmenus
14+
quickmenus.qmenus.registerHotkeys()
15+
quickmenus.fmenus.registerHotkeys()
16+
```
717

818
## F-Menus
919

10-
F-menus allow you to create quick selection sets that are assigned to slots in a radial marking menu. They are designed for workflows like animation, where it is faster to use the gestural nature of marking menus instead of having to use a picker UI or select controls interactively.
20+
F-menus allow you to create quick selection sets that are assigned to slots in a radial marking menu. They are designed
21+
for workflows like animation, where it is faster to use the gestural nature of marking menus instead of having to use a
22+
picker UI or select controls interactively.
1123

1224
#### Usage
1325

1426
- Hold `f` and use `left-mouse-button` to summon the main quick selection menu.
15-
- Hold `f` and use `right-mouse-button` to summon a manager menu for switching between different collections of quick select sets.
16-
27+
- Hold `f` and use `right-mouse-button` to summon a manager menu for switching between different collections of quick
28+
select sets.
1729

1830
## Q-Menus
1931

20-
Q-menus are a set of selection and display related marking menus. Menus include a selection masking radial menu, display masking radial menu, and improved component selection mode switching. The Q-Menus are assigned to Q because of the relationship with the Q (selection) tool itself.
32+
Q-menus are a set of selection and display related marking menus. Menus include a selection masking radial menu, display
33+
masking radial menu, and improved component selection mode switching. The Q-Menus are assigned to Q because of the
34+
relationship with the Q (selection) tool itself.
2135

2236
#### Usage
2337

2438
- Hold `q` and use `left-mouse-button` to summon the selection masking menu
2539
- Hold `q` and use `middle-mouse-button` to summon the display masking menu
2640
- Hold `q` and use `right-mouse-button` to summon a camera quick switching menu
2741
- Hold `alt+q` and use `left-mouse-button` to summon the component selection menu
28-
- Hold `alt+q` and use `middle-mouse-button` to summon a [resetter](https://github.com/bohdon/maya-resetter) menu for quickly resetting object transforms, etc
29-
30-
31-
## Setup
32-
33-
After launching Maya, a first-time setup is required for registering the hotkeys, run this python script in the Script Editor:
34-
35-
```python
36-
# register Quick Menu hotkeys
37-
quickmenus.qmenus.registerHotkeys()
38-
quickmenus.fmenus.registerHotkeys()
39-
```
40-
41-
42-
## Version 1.0.0 (2017-12-19)
43-
- Initial release
42+
- Hold `alt+q` and use `middle-mouse-button` to summon a [resetter](https://github.com/bohdon/maya-resetter) menu for
43+
quickly resetting object transforms, etc

src/workflowtools/scripts/resetter/README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,39 @@
22

33
A simple util for quickly resetting transform or other node attributes to their defaults in Maya.
44

5-
Resetter is most useful in animation workflows, where you often want to reset a control to its default state without having to type in 0s and 1s in the channel box. Any transform node can be reset to its "zeroed-out" state without any setup, and special attributes (such as IKFK blend attributes) can have their default values stored on the node so that they are also restored when resetting a node to its default state.
5+
Resetter is most useful in animation workflows, where you often want to reset a control to its default state without
6+
having to type in 0s and 1s in the channel box. Any transform node can be reset to its "zeroed-out" state without any
7+
setup, and special attributes (such as IKFK blend attributes) can have their default values stored on the node so that
8+
they are also restored when resetting a node to its default state.
69

10+
## Usage
711

8-
## Setup
9-
10-
Run the following to launch the Resetter GUI:
12+
Run the following to launch the Resetter UI:
1113

1214
```python
1315
import resetter
1416
resetter.GUI()
1517
```
1618

17-
## Main Commands
19+
### Useful Commands
1820

19-
Here are some of the main commands that make useful shelf buttons or hotkeys.
21+
Store the current keyable values for the selected nodes as defaults:
2022

2123
```python
2224
import resetter
23-
24-
# store the selected nodes current keyable values as their defaults
2525
resetter.setDefaults()
26+
```
2627

27-
# reset selected nodes using defined defaults or basic transform defaults
28+
Reset selected nodes using defined defaults or basic transform defaults:
29+
30+
```python
31+
import resetter
2832
resetter.reset()
33+
```
34+
35+
Reset selected nodes using only defined defaults:
2936

30-
# reset selected nodes using only defined defaults
37+
```python
38+
import resetter
3139
resetter.reset(useBasicDefaults=False)
3240
```

src/workflowtools/scripts/rmbmenuhook/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Adding marking menus using hotkeys for most button combinations is easy, but the
66
inextensible in vanilla Maya. This project makes it easy to conditionally add menus that can replace the RMB default
77
marking menus.
88

9-
## Basic Example
9+
## Usage
1010

1111
A simple example would be adding a menu that displays `Switch to IK` or `Switch to FK` if an IKFK animation control is
1212
selected.

0 commit comments

Comments
 (0)