Revised keyboard shortcuts

[charlielee]

The repetitiveness of some aspects of stop motion animation make solid keyboard shortcuts a must for Boats Animator. A quirk of NW.js's menu API mean that with very little hassle the following shortcuts currently exist in BA:

• Ctrl Z = undo last frame
• Ctrl C = capture frame
• Ctrl M = return to launcher

These are not great for numerous reasons and need to revised to consider standard Mac and PC expectations amongst other things. Some suggestions I have for future and existing features are:

(note NUM refers to the keypad)

Projects

• Ctrl O / Cmd O = open project
• Ctrl S / Cmd S = save project
• Ctrl Shift S / Cmd Shift S = save project as
• Ctrl N / Cmd N = new scene
• Ctrl Shift N / Cmd Shift N = new take
• Ctrl W / Cmd W = close window (and return to the launcher screen)
• Ctrl Q / Cmd Q = quit program

Project shortcuts will be added when #37 and #86 are implemented

Controls

• Enter / NUM Enter = Capture frame
• Ctrl Z / Cmd Z / Backspace / Delete / NUM * = delete last frame captured
• Ctrl Shift Z / Cmd Shift Z / Ctrl Delete / Cmd delete = delete current selected frame in frame reel
• Ctrl M / Cmd M / M = toggle audio

Playback

• Space / 0 / NUM 0 / MediaPlayPause = Play / pause
• P / Num . = Play from start
• 6 / NUM 6 = Play last few captured frames
• 8 / NUM 8 = toggle looping
• Ctrl Right / MediaPrevTrack = jump to the first frame on the framereel
• Ctrl Left / MediaNextTrack = jump to the last frame on the framereel (ie stop)

  Framereel

• left arrow / 1 / NUM 1 = back 1 frame on framereel
• right arrow / 2 / NUM 2 = forward 1 frame on framereel
• L / 3 / NUM 3 = switch to live view
• Ctrl + / Cmd + = zoom into framereel
• Ctrl - / Cmd - = zoom out of framereel
• Ctrl 0 / Cmd 0 = return framereel to default zoom
• Right click (on an individual frame) = menu with option to delete frame or add keyframe.

Keyframes

• i = set currently selected frame as the start keyframe.
• esc = remove start keyframe

Will be added when #122 is merged

Onion skinning

• + / NUM + = move onion skinning slider to the right
• - / NUM - = move onion skinning slider to the left

These will be added when #71 is implemented

Confirm prompts

• Enter = okay
• Esc / / = cancel

Others

• F1 / Cmd + Shift + ? = load documentation
• F12 = load dev tools

I'm aware Mac and PC keypads have some minor differences and as a result have tried to avoid keys that do not appear on both. Here is a visual depiction of the shortcuts above:

**_Note since creating the image above `/` has changed function to cancel confirm prompts rather than mute audio**_

In terms of implementing these Mousetrap.js seems pretty neat.

[le717]

Drive-by comment: remove the milestone, make this more a progress/listing issue. We won't be getting all these in 0.7.x, but rather when the corresponding features are added. ;)

[rioforce]

Looks fantastic.

[charlielee]

I came across this yesterday:
https://github.com/nwjs/nw.js/wiki/Shortcut

Using a built in NW.js API seems preferable to something external like Mousetrap.

[charlielee]

Actually mousetrap seems to allow a much greater range of keys than NW.js's API - better to stick to it.

[le717]

I noticed a number of boxes are checked. I assume you are implementing this on a local branch and will publish when done?

[le717]

Also, since we are going for mousetrap, install it using npm:

npm install mousetrap --save

I've been working on some build scripts for my new site. I'll try to pull them over here too to help us out. :)

[charlielee]

I assume you are implementing this on a local branch and will publish when done?

@le717 that is 100% correct ;)

[charlielee]

Keyboard shortcuts to do:

• See if it is possible to create a system where the shortcut displayed next to a menubar item is taken from the first shortcut listed in default-shortcuts.json
• Custom keyboard shortcuts

[charlielee]

I'm closing this issue. I think I've been asked literally once about additional keyboard shortcuts in the last few years?
New shortcuts will be added with new features.
Custom shortcuts will be added eventually when preferences exist in the UI