Skip to content

Commit a5de360

Browse files
CrashTestJavadacap
authored andcommitted
Complete preferences.md
1 parent 17821a0 commit a5de360

File tree

6 files changed

+123
-9
lines changed

6 files changed

+123
-9
lines changed

preferences.md

Lines changed: 123 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,38 @@
33
You can change the configuration of Aseprite from the *Edit >
44
Preferences* menu or pressing <kbd>Ctrl+K</kbd> key (or <kbd>⌘K</kbd>
55
or <kbd>⌘,</kbd> on macOS). In case that you are looking to configure
6-
the keyboard shorcuts, that's done through
6+
the keyboard shortcuts, that's done through
77
the *Edit > [Keyboard Shortcuts](keyboard-shortcuts.md)* menu option.
88

9+
The Aseprite preferences are stored in `aseprite.ini` in the [preferences folder](preferences-folder.md).
10+
911
The Preferences dialog is divided in several sections:
1012

1113
## General
1214

15+
* **User Interface**:
16+
17+
One window mode ![ui-one](preferences/ui-one-window.png): Menus cannot be moved outside of the main Aseprite menu.
18+
19+
Multi-window mode ![ui-multi](preferences/ui-multi-window.png): Menus can be moved outside of the main Aseprite menu.
20+
21+
* **Light** | **Dark** options: Since v1.3, you can quickly change between
22+
a Light version of the Aseprite theme and a Dark one.
1323
* **Screen Scaling**: Changes the size of each pixel inside every
1424
window of Aseprite. It's 200% by default, which means that each
1525
pixel in the window will be represented with a 2x2 square on the
16-
screen. When using large monitors (e.g. 4K monitors) you can try
26+
screen. When using large monitors (e.g. 4K monitors), you can try
1727
changing to 300% or 400%. If you want to see each pixel of your
1828
sprite represented as one pixel on the screen, you should set this
1929
option to 100%, in this case it's highly probable that you will want
2030
to increase the next option (*UI Elements Scaling*) to 200% or more
2131
if needed.
22-
* **UI Elements Scaling**: It's an extra scale applied only to elements
32+
* **UI Element Scaling**: It's an extra scale applied only to elements
2333
of the User Interface (buttons, labels, etc.), but without modifying
2434
the scale of the sprite editor. It's 100% by default.
25-
* **Light** | **Dark** options: Since v1.3 you can quickly change between
26-
a Light version of the Aseprite theme, and a Dark one.
2735
* **Language**: The language of the User Interface, English by default,
2836
but you can get some translations contributed by users from:
29-
https://github.com/aseprite/languages
37+
https://github.com/aseprite/languages.
3038
* **Show Aseprite menu bar** (only available on macOS): The [Aseprite
3139
menu bar](menu-bar.md) is visible by default on Windows and Linux:
3240

@@ -37,18 +45,37 @@ The Preferences dialog is divided in several sections:
3745

3846
![macOS Menu Bar](menu-bar/macos-menubar.png)
3947

48+
49+
* **Show Aseprite file dialog**: Use custom Aseprite file viewer menu.
50+
* **Show Home tab when Aseprite is started**: Shows the Home tab when Aseprite is started.
4051
* **Expand menu bar items on mouseover**: With this option checked,
4152
when the mouse is above the [Aseprite menu bar](menu-bar.md), a menu
4253
will be opened automatically. By default this is disabled, so you
4354
have to click a menu to open it.
44-
* **Draw a separation between each palette entry**:
55+
* **Draw a separation between each palette entry**: Draws a black 1px line between each palette entry in the[ color bar](color-bar.md).
4556
* **Share crash data with Aseprite developers**: When Aseprite crashes
4657
(unexpectedly closes) you will be asked to share some crash
4758
information automatically in the future privately with the Aseprite
4859
team. Aseprite doesn't do this by default (this option is unchecked
4960
by default), so you have to give your consent to share this
5061
information. More details in
51-
[#2857](https://github.com/aseprite/aseprite/issues/2857)
62+
[#2857](https://github.com/aseprite/aseprite/issues/2857).
63+
64+
## Tablet
65+
66+
See the [tablet](tablet.md) section.
67+
68+
## Files
69+
70+
* **Default extensions**: Pick the default file extensions for saving/exporting actions.
71+
* **Recent Items**: The number of recent file/folder items to show on the home page and *File > Open Recent* dropdown.
72+
* **Recover files options**: These options handle the intervals to save sprite recovery data.
73+
74+
## Color
75+
76+
* **Alpha & Opacity Ranges**: Whether alpha/opacity color ranges use `0-255` or `0%-100%` ranges.
77+
* *NEEDS IMAGE*
78+
* **Color management**: See the [color profile](color-profile.md) section.
5279

5380
## Alerts
5481

@@ -66,7 +93,7 @@ Options to change the general behavior of the [Sprite Editor](sprite-editor.md):
6693
* **Zoom with scroll wheel**: Checked by default, you zoom with the
6794
[mouse wheel](mouse-wheel.md) (if you uncheck this, the vertical scroll will be the
6895
default action for the mouse wheel).
69-
* **Zoom sliding two fingers up or down**: This is available on macOS
96+
* **Zoom sliding two fingers up or down (macOS)**: This is available on macOS
7097
only, and if you enable it you will be able to zoom using two
7198
fingers on your MacBook trackpad.
7299
* **Zoom from center with scroll wheel**: Check this if you want to
@@ -104,6 +131,93 @@ Options to change the general behavior of the [Sprite Editor](sprite-editor.md):
104131
* **Right-click**: You can customize what specific action to do with
105132
the [right-click](right-click.md).
106133

134+
## Selection
135+
136+
* **Adjust opaque/transparent mode automatically**: Adjust the opaque/transparent mode when moving over a layer, e.g: moving over a transparent layer would set the mode to transparent.
137+
* **Keep selection after "Edit > Delete" command**: Keep the selection bounds after deleting the content.
138+
139+
![keep selection example](preferences/keep-selection-deleted-content.gif)
140+
* **Show selection edges automatically when the selection is modified**: Automatically enables *View > Show > Selection Edges* when the selection is moved. This will override the menu setting (e.g: if *View > Show > Selection Edges* is disabled, this will enable it)
141+
* **Allow moving selection edges**: Enabling this allows moving the selection bounds.
142+
* **Disable transformation handles when key modifiers are pressed**: Disable transformation handles when key modifiers (<kbd>Shift</kbd>/<kbd>Ctrl</kbd>/<kbd>Alt</kbd>) are pressed.
143+
* **Move selection on Add mode**: Enables moving the selection in the [Add selection mode](selecting.md#Add/Subtract/Intersect).
144+
* **Select a grid tile with double-click**: Enables selecting grid tiles with a double-click.
145+
* **Snap To Grid when the option is enabled**: Snap To Grid when *View > Grid > Snap to Grid* is enabled.
146+
* **Force RotSprite even for right/straight angles**: Use the RotSprite rotation algorithm for right/straight angles.
147+
* **Transform cels in selected layers or frames on timeline**: Selection transformations apply to all cels of the selected layers/frames. If this option is disabled, selection transformations will only apply to all selected cels.
148+
149+
## Timeline
150+
151+
* **Show timeline automatically**: Shows the timeline when a new frame or layer is added.
152+
* **Rewind on stop**: When enabled, the animation is rewound upon stopping.
153+
* **Default First Frame**: Sets the default first frame.
154+
* **Keep selection**: Keep the timeline selection range when the canvas is edited or the timeline loses focus.
155+
* **Select on Click**: Select frames/cels on click.
156+
* **Select on Shift + Click**: Select frames/cels on <kbd>Shift + Click</kbd>.
157+
* **Select on Drag**: Select frames/cels when dragging.
158+
* **Drag & drop from edges**: Enable dragging and dropping from frame/cel edges.
159+
160+
## Cursors
161+
162+
* **Use native mouse cursors**: Use the OS's cursor. If disabled, use the custom theme cursor.
163+
* **Mouse cursor scale**: Scale of theme cursor.
164+
* **Crosshair Type**: Change the crosshair type when painting.
165+
* **Brush Preview**: Change the brush preview type when painting.
166+
* **Crosshair & Brush Edges Color**: Change the edge color of the crosshair and brush preview edges.
167+
168+
## Background
169+
170+
**Background for New Documents**: Edits the default background for all documents.
171+
172+
**Background for the Active Document**: Edits the current document background.
173+
174+
* **Size**: Sets the background square sizes.
175+
* **Colors**: Sets the background square colors.
176+
177+
## Grid
178+
179+
**Grid for New Documents**: Edits the default grid for all documents.
180+
181+
**Grid for the Active Document**: Edits the current document grid.
182+
183+
* **X & Y**: X and Y grid offsets.
184+
* **Color**: Grid line color.
185+
* **Opacity**: Grid line opacity.
186+
* **Visible Pixel Grid**: Enables/disables the pixel grid.
187+
* **Color**: Pixel grid line color.
188+
* **Opacity**: Pixel grid line opacity.
189+
190+
## Guides & Slices
191+
192+
* **Layer Edges Color.**: Layer edge guide color.
193+
* **Auto Guides Color**: Auto guide color.
194+
195+
![guides and edges example](preferences/auto-guides.png)
196+
197+
* **Default Color**: Default slice edge color.
198+
199+
## Undo
200+
201+
* **Undo Limit**: The memory limit for undo information, in megabytes, for each sprite.
202+
* **Go to modified frame/layer**: Sets the current frame/layer to the one where the undo occurred.
203+
* **Allow non-linear history**: Undo history is a list of sprite states. If non-linear undo history is disabled and undo is used (which moves the current state back one entry), the next action will overwrite the undone action/state. If it is enabled and undo is used, the next action will add the new sprite state to the list, keeping the old one intact.
204+
![nonlinear undo history example](preferences/nonlinear-undohistory.gif)
205+
* **Show Undo Tooltip**: Show the undo tooltip in the bottom right corner of the window.
206+
207+
## Aseprite Format
208+
209+
* **Cel Content Format**: Changes the cel image format.
210+
211+
## Experimental
212+
213+
These features are experimental, and may be removed or changed in the future, which is why they are not listed here.
214+
215+
## Reset
216+
217+
The Reset section contains various editor values to reset.
218+
219+
To reset a value, select it and press the *Reset* button.
220+
107221
---
108222

109223
**SEE ALSO**

preferences/auto-guides.png

1.56 KB
Loading
17.5 KB
Loading
347 KB
Loading

preferences/ui-multi-window.png

216 Bytes
Loading

preferences/ui-one-window.png

200 Bytes
Loading

0 commit comments

Comments
 (0)