Skip to content

Commit 2ccd6df

Browse files
committed
Add Keyboard Shortcuts & Mouse Wheel sections
1 parent a97e620 commit 2ccd6df

10 files changed

+186
-5
lines changed

customization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
You can change the most common Aseprite configuration from these menus:
44

55
* *Edit > [Preferences](preferences.md)* (<kbd>Ctrl+K</kbd> key, or on macOS: <kbd>⌘K</kbd> or <kbd>⌘,</kbd>)
6-
* *Edit > Keyboard Shortcuts* (<kbd>Ctrl+Alt+Shift+K</kbd> or <kbd>⌥⇧⌘K</kbd> on macOS)
6+
* *Edit > [Keyboard Shortcuts](keyboard-shortcuts.md)* (<kbd>Ctrl+Alt+Shift+K</kbd> or <kbd>⌥⇧⌘K</kbd> on macOS)
77

88
Other ways of customization are more advance and require downloading
99
some file (extensions or script) and installing it from *Edit >

drag-value.md

+2
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,6 @@ increment one unit (in this case one unit of the Brush Size).
2121

2222
**SEE ALSO**
2323

24+
[Mouse Wheel](mouse-wheel.md) |
25+
[Keyboard Shortcuts](keyboard-shortcuts.md) |
2426
[Issue #3195](https://github.com/aseprite/aseprite/issues/3195)

keyboard-shortcuts.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Keyboard Shortcuts
2+
3+
You can customize the keyboard shortcuts or the combination of keys +
4+
[mouse wheel](mouse-wheel.md) (or [mouse movement](drag-value.md))
5+
from *Edit > [Keyboard Shortcuts](keyboard-shortcuts.md)*
6+
menu option or <kbd>Ctrl+Alt+Shift+K</kbd> key (or <kbd>⌥⇧⌘K</kbd> on macOS).
7+
8+
There is a general overview of the default keyboard shortcuts in the [Quick Reference](/quickref/) page.
9+
10+
## Menus & Commands
11+
12+
In these sections you will find a way to assign a key to every
13+
action/command in Aseprite that is accessible from the [menu bar](menu-bar.md)
14+
and other commands that are not part of the main menu but are still
15+
accessible for advanced users (e.g. "Set Ink Type"
16+
is not associated to any menu or has default keyboard shortcut, but
17+
you can assign a key from the "Commands" section).
18+
19+
Remember to use the search field in this dialog to filter and find a
20+
specific command.
21+
22+
## Tools
23+
24+
In the Tools section you will find a way to see and change the keys
25+
associated with each tool from the [Tool Bar](tool-bar.md). There are
26+
two main considerations:
27+
28+
1. Two or more tools can share the same key. In this case pressing the
29+
key multiple times will switch/go through all the tools that have
30+
the same key assigned. E.g. <kbd>U</kbd> key is assigned to the
31+
![Rectangle icon](tools/rectangle-tool.png) Rectangle and
32+
![Filled Rectangle icon](tools/filled-rectangle-tool.png) Filled Rectangle
33+
by default, so pressing one time
34+
will select the Rectangle tool, and pressing it a second time will
35+
switch to the Filled Rectangle.
36+
2. There are two ways to select a tool:
37+
* A regular way to change the
38+
active tool, it's when you press a key and the active tool changes so
39+
all the following mouse buttons will interact with that tool.
40+
E.g. pressing the <kbd>P</kbd> key switches to the ![Pencil icon](tools/pencil-tool.png) Pencil
41+
tool, or the <kbd>H</kbd> key selects the ![Hand icon](tools/hand-tool.png) Hand
42+
tool as the active one, so then you can pan the [sprite editor](sprite-editor.md)
43+
just dragging it with the left mouse button + moving the mouse
44+
without pressing any other key.
45+
* An alternative quick way (identified as "(quick)" in the *Keyboard Shortcuts* dialog)
46+
where the tool is active while you keep the key pressed (and then Aseprite
47+
returns to the previously selected tool when you release the key).
48+
This happens with the <kbd>Alt</kbd> key to select the ![Eyedropper icon](tools/eyedropper-tool.png) Eyedropper tool
49+
or the <kbd>Space bar</kbd> key to select the ![Hand icon](tools/hand-tool.png) Hand tool temporarily.
50+
Here an example of how the ![Hand icon](tools/hand-tool.png) Hand tool
51+
looks in the configuration:
52+
53+
![Hand tool example](keyboard-shortcuts/hand-shortcuts.png)
54+
55+
## Action Modifiers
56+
57+
These actions depend on a specific context in Aseprite, for example
58+
when you have a selection tool, or you are scaling a selection, etc.
59+
The given keys are the default options.
60+
61+
The following is the list of contexts and the possible actions inside
62+
that context:
63+
64+
* **Freehand Tool**: When the ![Pencil icon](tools/pencil-tool.png) Pencil tool
65+
is active.
66+
* **Straight Line from Last Point**: Use the <kbd>Shift</kbd> key
67+
to create a straight line from the last painted pixel with the brush.
68+
* **Angle Snap from Last Point**: Add the <kbd>Ctrl</kbd> key
69+
to snap the angle of that straight line.
70+
71+
* **Move Tool**: When you are using the ![Move Tool Icon](tools/move-tool.png) Move tool.
72+
* **Auto Select Layer**: If you press the <kbd>Ctrl</kbd> (or <kbd>⌘</kbd> on macOS)
73+
you'll select the layer that is above the cursor with a single click.
74+
* **Shape Tool**: These keys can be used while you are drawing (after pressing & before releasing the mouse button)
75+
with a rectangular or elliptical-like tool (e.g. ![Rectangle Icon](tools/rectangle-tool.png) Rectangle,
76+
![Ellipse Icon](tools/ellipse-tool.png) Ellipse,
77+
![Rectangular Marquee Icon](tools/marquee-tool.png) Rectangular Marquee, etc.).
78+
* **Square Aspect**: You can use the <kbd>Shift</kbd> key to create a square or a circle.
79+
* **Draw From Center**: You can use the point where the mouse was
80+
pressed as the center of the shape when pressing the <kbd>Ctrl</kbd> key, e.g. to create an ellipse specifying the center (instead of both corners).
81+
* **Rotate Shape**: Pressing the <kbd>Alt</kbd> you start rotating the shape.
82+
* **Move Origin**: You can press the <kbd>Space</kbd> key to move the
83+
whole shape to a new position before releasing the mouse button, just in case
84+
the origin was not specified correctly.
85+
* **Selection**: When we have any selection tool we can use some keys to
86+
change what to do with the selected area.
87+
* **Add/Subtract/Intersect Selection**: These options
88+
are explained in the [Selecting](selecting.md#add/subtract/intersect) section.
89+
* **Translating Selection**: When you're moving the selection.
90+
* **Snap To Grid**: Pressing <kbd>Alt</kbd> the selection will snap to grid.
91+
* **Lock Axis**: You can use <kbd>Shift</kbd> to lock the movement in the X or Y axis only.
92+
* **Copy Selection**: With <kbd>Ctrl</kbd> key you can copy the
93+
selection if you press it *before* you start moving the
94+
selection.
95+
* **Fine Translating**: When you are moving the selection, pressing
96+
the <kbd>Ctrl</kbd> will start a fine-tuning movement (not only
97+
pixel by pixel, but by subpixels).
98+
* **Scaling Selection**: When you're scaling the selection.
99+
* **Maintain Aspect Ratio**: Press <kbd>Shift</kbd> key to keep the
100+
ratio between width/height intact.
101+
* **Scale From Center**: Scale from the center (or current pivot
102+
position) using the <kbd>Alt</kbd> key.
103+
* **Fine Scaling**: When you are scaling the selection, pressing
104+
the <kbd>Ctrl</kbd> will start a fine-tuning scaling (not only
105+
pixel by pixel, but by subpixels).
106+
* **Rotating Selection**: When you're rotating the selection.
107+
* **Angle Snap**: You can use the <kbd>Shift</kbd> key to snap the
108+
angle to angles of 26.6°, 45°, 90°, etc.
109+
110+
* **Trigger Left/Right Mouse Button**: You can configure a specific
111+
key to simulate the left/right mouse buttons inside the [sprite
112+
editor](sprite-editor.md).
113+
114+
## Keyboard + Mouse
115+
116+
You can configure to trigger some special actions when a key is
117+
pressed and the mouse wheel is moved (or the mouse itself is moved in
118+
a specific axis):
119+
120+
* [Mouse Wheel](mouse-wheel.md)
121+
* [Drag Value](drag-value.md)
122+
123+
---
124+
125+
**SEE ALSO**
126+
127+
[Preferences](preferences.md) |
128+
[Customization](customization.md)

keyboard-shortcuts/hand-shortcuts.png

5.1 KB
Loading
3.46 KB
Loading

mouse-wheel.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Mouse Wheel
2+
3+
The default mouse wheel behavior depends
4+
on the [*Edit > Preferences > Editor > Zoom with scroll wheel*](preferences.md#editor) option.
5+
Some of this behavior will change in a near future: [Issue #2896](https://github.com/aseprite/aseprite/issues/2896)
6+
7+
As reference and only in this section, the following symbols have the given meaning:
8+
9+
<kbd>⬆</kbd>: the mouse wheel is moved up <br/>
10+
<kbd>⬇</kbd>: the mouse wheel is moved down
11+
12+
## With *Zoom with scroll wheel*
13+
14+
| Action | Windows | macOS |
15+
|---------------------|--------------------|--------------------|
16+
| Horz. Scroll Left | <kbd>Shift+⬆</kbd> | <kbd>Shift+⬇</kbd> |
17+
| Horz. Scroll Right | <kbd>Shift+⬇</kbd> | <kbd>Shift+⬆</kbd> |
18+
| Zoom In | <kbd>⬆</kbd> | <kbd>⬇</kbd> |
19+
| Zoom Out | <kbd>⬇</kbd> | <kbd>⬆</kbd> |
20+
| Increase Brush Size | <kbd>Ctrl+⬇</kbd> | <kbd>Ctrl+⬆</kbd> |
21+
| Decrease Brush Size | <kbd>Ctrl+⬆</kbd> | <kbd>Ctrl+⬇</kbd> |
22+
23+
## Without *Zoom with scroll wheel*
24+
25+
| Action | Windows | macOS |
26+
|--------------------|--------------------|--------------------|
27+
| Scroll Up | <kbd>⬆</kbd> | <kbd>⬇</kbd> |
28+
| Scroll Down | <kbd>⬇</kbd> | <kbd>⬆</kbd> |
29+
| Horz. Scroll Left | <kbd>Shift+⬆</kbd> | <kbd>Shift+⬇</kbd> |
30+
| Horz. Scroll Right | <kbd>Shift+⬇</kbd> | <kbd>Shift+⬆</kbd> |
31+
| Zoom In | <kbd>Ctrl+⬆</kbd> | <kbd>Ctrl+⬇</kbd> |
32+
| Zoom Out | <kbd>Ctrl+⬇</kbd> | <kbd>Ctrl+⬆</kbd> |
33+
34+
## Customization
35+
36+
From *Edit > Keyboard Shortcuts > Mouse Wheel* you can
37+
configure the mouse wheel behavior when some extra key is pressed:
38+
39+
![Mouse Wheel on Keyboard Shortcuts](keyboard-shortcuts/mouse-wheel-custom.png)
40+
41+
---
42+
43+
**SEE ALSO**
44+
45+
[Drag Value](drag-value.md) |
46+
[Keyboard Shortcuts](keyboard-shortcuts.md) |
47+
[Issue #2896](https://github.com/aseprite/aseprite/issues/2896)

preferences.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Preferences
22

3-
We can change the configuration of Aseprite from the *Edit >
3+
You can change the configuration of Aseprite from the *Edit >
44
Preferences* menu or pressing <kbd>Ctrl+K</kbd> key (or <kbd>⌘K</kbd>
5-
or <kbd>⌘,</kbd> on macOS).
5+
or <kbd>⌘,</kbd> on macOS). In case that you are looking to configure
6+
the keyboard shorcuts, that's done through
7+
the *Edit > [Keyboard Shortcuts](keyboard-shortcuts.md)* menu option.
68

79
The Preferences dialog is divided in several sections:
810

@@ -62,7 +64,7 @@ You can re-enable these dialogs from *Edit > Preferences > Alerts*.
6264
Options to change the general behavior of the [Sprite Editor](sprite-editor.md):
6365

6466
* **Zoom with scroll wheel**: Checked by default, you zoom with the
65-
mouse wheel (if you uncheck this, the vertical scroll will be the
67+
[mouse wheel](mouse-wheel.md) (if you uncheck this, the vertical scroll will be the
6668
default action for the mouse wheel).
6769
* **Zoom sliding two fingers up or down**: This is available on macOS
6870
only, and if you enable it you will be able to zoom using two
@@ -71,7 +73,7 @@ Options to change the general behavior of the [Sprite Editor](sprite-editor.md):
7173
[zoom](zoom.md) from the center of the sprite editor instead zooming
7274
from the mouse position when the mouse wheel is used.
7375
* **Zoom from center with keys**: Zoom from the center of the sprite
74-
instead of the mouse position when we use the keys
76+
instead of the mouse position when you use the keys
7577
[to zoom](zoom.md) <kbd>1</kbd>, <kbd>2</kbd>, <kbd>3</kbd>, etc.
7678
* **Show scroll-bars in sprite editor**: Uncheck this to hide the
7779
scroll bars on all sprite editors.

selecting.md

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ shortcut):
2727
* ![Subtract Selection](selecting/subtract-selection.png): Subtracts the new selection to the existing one (drag left mouse button + <kbd>Alt+Shift</kbd> key, or alternative: drag right mouse button)
2828
* ![Intersect Selection](selecting/intersect-selection.png): Intersects the existing selection with the new one (drag left mouse button + <kbd>Ctrl+Shift</kbd>)
2929

30+
These keys can be customized from the [*Edit > Keyboard Shortcuts > Action Modifiers*](keyboard-shortcuts.md#action-modifiers).
31+
3032
## Select Content
3133

3234
You can select the whole sprite canvas using *Select > All* (<kbd>Ctrl+A</kbd>

tools/filled-rectangle-tool.png

182 Bytes
Loading

tools/hand-tool.png

245 Bytes
Loading

0 commit comments

Comments
 (0)