Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion extensions/dithering-matrices.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Dithering Matrices
# Extensions: Dithering Matrices

Content a `.aseprite-extension` file for a dithering matrix extension:

Expand Down
2 changes: 1 addition & 1 deletion extensions/keys.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Keys
# Extensions: Keys

Since **Aseprite v1.2.35** you can create extensions with keyboard
shortcuts. The content of a `.aseprite-extension` file for an
Expand Down
2 changes: 1 addition & 1 deletion extensions/languages.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Languages
# Extensions: Languages

This is an example of a possible extension to translate Aseprite to
Spanish. The content a `.aseprite-extension` file for a language
Expand Down
2 changes: 1 addition & 1 deletion extensions/palettes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Palettes
# Extensions: Palettes

Content a `.aseprite-extension` file for a palette extension:

Expand Down
2 changes: 1 addition & 1 deletion extensions/themes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Themes
# Extensions: Themes

A theme extension is a way to modify the look & feel of the User
Interface (UI) of Aseprite. There is a set of known themes in the
Expand Down
149 changes: 139 additions & 10 deletions preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,38 @@
You can change the configuration of Aseprite from the *Edit >
Preferences* menu or pressing <kbd>Ctrl+K</kbd> key (or <kbd>⌘K</kbd>
or <kbd>⌘,</kbd> on macOS). In case that you are looking to configure
the keyboard shorcuts, that's done through
the *Edit > [Keyboard Shortcuts](keyboard-shortcuts.md)* menu option.
the keyboard shortcuts, that's done through
the *[Edit > Keyboard Shortcuts](keyboard-shortcuts.md)* menu option.

The Aseprite preferences are stored in `aseprite.ini` in the [preferences folder](preferences-folder.md).

The Preferences dialog is divided in several sections:

## General

* **User Interface**:

One window mode ![ui-one](preferences/ui-one-window.png): Menus cannot be moved outside of the main Aseprite menu.

Multi-window mode ![ui-multi](preferences/ui-multi-window.png): Menus can be moved outside of the main Aseprite menu.

* **Light** | **Dark** options: Since v1.3, you can quickly change between
a Light version of the Aseprite theme and a Dark one.
* **Screen Scaling**: Changes the size of each pixel inside every
window of Aseprite. It's 200% by default, which means that each
pixel in the window will be represented with a 2x2 square on the
screen. When using large monitors (e.g. 4K monitors) you can try
screen. When using large monitors (e.g. 4K monitors), you can try
changing to 300% or 400%. If you want to see each pixel of your
sprite represented as one pixel on the screen, you should set this
option to 100%, in this case it's highly probable that you will want
to increase the next option (*UI Elements Scaling*) to 200% or more
if needed.
* **UI Elements Scaling**: It's an extra scale applied only to elements
* **UI Element Scaling**: It's an extra scale applied only to elements
of the User Interface (buttons, labels, etc.), but without modifying
the scale of the sprite editor. It's 100% by default.
* **Light** | **Dark** options: Since v1.3 you can quickly change between
a Light version of the Aseprite theme, and a Dark one.
* **Language**: The language of the User Interface, English by default,
but you can get some translations contributed by users from:
https://github.com/aseprite/languages
https://github.com/aseprite/languages.
* **Show Aseprite menu bar** (only available on macOS): The [Aseprite
menu bar](menu-bar.md) is visible by default on Windows and Linux:

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

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


* **Show Aseprite file dialog**: Use custom Aseprite file viewer menu.
* **Show Home tab when Aseprite is started**: Shows the Home tab when Aseprite is started.
* **Expand menu bar items on mouseover**: With this option checked,
when the mouse is above the [Aseprite menu bar](menu-bar.md), a menu
will be opened automatically. By default this is disabled, so you
have to click a menu to open it.
* **Draw a separation between each palette entry**:
* **Draw a separation between each palette entry**: Draws a black 1px line between each palette entry in the[ color bar](color-bar.md).
* **Share crash data with Aseprite developers**: When Aseprite crashes
(unexpectedly closes) you will be asked to share some crash
information automatically in the future privately with the Aseprite
team. Aseprite doesn't do this by default (this option is unchecked
by default), so you have to give your consent to share this
information. More details in
[#2857](https://github.com/aseprite/aseprite/issues/2857)
[#2857](https://github.com/aseprite/aseprite/issues/2857).

## Tablet

See the [tablet](tablet.md) section.

## Files

* **Default extensions**: Pick the default file extensions for saving/exporting actions.
* **Recent Items**: The number of recent file/folder items to show on the home page and *File > Open Recent* dropdown.
* **Recover files options**: These options handle the intervals to save sprite recovery data.

## Color

* **Alpha & Opacity Ranges**: Whether alpha/opacity color ranges use `0-255` or `0%-100%` ranges.

![ranges example](preferences/ranges.png)

* **Color management**: See the [color profile](color-profile.md) section.

## Alerts

Expand All @@ -66,7 +95,7 @@ Options to change the general behavior of the [Sprite Editor](sprite-editor.md):
* **Zoom with scroll wheel**: Checked by default, you zoom with the
[mouse wheel](mouse-wheel.md) (if you uncheck this, the vertical scroll will be the
default action for the mouse wheel).
* **Zoom sliding two fingers up or down**: This is available on macOS
* **Zoom sliding two fingers up or down (macOS)**: This is available on macOS
only, and if you enable it you will be able to zoom using two
fingers on your MacBook trackpad.
* **Zoom from center with scroll wheel**: Check this if you want to
Expand Down Expand Up @@ -104,10 +133,110 @@ Options to change the general behavior of the [Sprite Editor](sprite-editor.md):
* **Right-click**: You can customize what specific action to do with
the [right-click](right-click.md).

## Selection

* **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.
* **Keep selection after "Edit > Delete" command**: Keep the selection bounds after deleting the content.

![keep selection example](preferences/keep-selection-deleted-content.gif)

* **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)
* **Allow moving selection edges**: Enabling this allows moving the selection bounds. The selection can only be moved if the mouse is hovering over its edge (the marching ants).

![move selection edges example](preferences/move-selection-edges.gif)

* **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.
* **Move selection on Add mode**: Enables moving the selection in the [Add selection mode](selecting.md#Add/Subtract/Intersect).
* **Select a grid tile with double-click**: Enables selecting grid tiles with a double-click.
* **Snap To Grid when the option is enabled**: Snap To Grid when *View > Grid > Snap to Grid* is enabled.
* **Force RotSprite even for right/straight angles**: Use the RotSprite rotation algorithm for right/straight angles.
* **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.

## Timeline

* **Show timeline automatically**: Shows the timeline when a new frame or layer is added.
* **Rewind on stop**: Upon stopping, the current frame is reset to the frame the animation was started at (note that it can be a frame other than the first frame).
* **Default First Frame**: Sets the default first frame.
* **Keep selection**: Keep the timeline selection range when the canvas is edited or the timeline loses focus.
* **Select on Click**: Select frames/cels on click.
* **Select on Shift + Click**: Select frames/cels on <kbd>Shift + Click</kbd>.
* **Select on Drag**: Select frames/cels when dragging.
* **Drag & drop from edges**: Enable dragging and dropping from frame/cel edges.

## Cursors

* **Use native mouse cursors**: Use the OS's cursor. If disabled, use the custom theme cursor.
* **Mouse cursor scale**: Scale of theme cursor.
* **Crosshair Type**: Change the crosshair type when painting.

![crosshair types](preferences/crosshair-types.png)

* **Brush Preview**: Change the brush preview type when painting.

![brush preview types](preferences/brush-preview-types.gif)

* **Crosshair & Brush Edges Color**: Change the edge color of the crosshair and brush preview edges.

![negative black & white](preferences/edge-negative.png) ![specific color](preferences/edge-color.png)

## Background

**Background for New Documents**: Edits the default background for all new documents.

**Background for the Active Document**: Edits the current document background.

* **Size**: Sets the background square sizes.
* **Colors**: Sets the background square colors.

## Grid

**Grid for New Documents**: Edits the default grid for all new documents.

**Grid for the Active Document**: Edits the current document grid.

* **X & Y**: X and Y grid offsets.
* **Color**: Grid line color.
* **Opacity**: Grid line opacity.
* **Visible Pixel Grid**: Enables/disables the pixel grid.
* **Color**: Pixel grid line color.
* **Opacity**: Pixel grid line opacity.

## Guides & Slices

* **Layer Edges Color.**: Layer edge guide color.
* **Auto Guides Color**: Auto guide color.

![guides and edges example](preferences/auto-guides.png)

* **Default Color**: Default slice edge color.

## Undo

* **Undo Limit**: The memory limit for undo information, in megabytes, for each sprite.
* **Go to modified frame/layer**: Sets the current frame/layer to the one where the undo occurred.
* **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.
![nonlinear undo history example](preferences/nonlinear-undohistory.gif)
* **Show Undo Tooltip**: Show the undo tooltip in the bottom right corner of the window.

## Aseprite Format

* **Cel Content Format**: Changes the cel image format. See https://github.com/aseprite/aseprite/blob/main/docs/ase-file-specs.md#cel-chunk-0x2005.

## Experimental

These features are experimental, and may be removed or changed in the future, which is why they are not listed here.

## Reset

The Reset section contains various editor values to reset.

To reset a value, select it and press the *Reset* button.

---

**SEE ALSO**

[Preferences Folder](preferences-folder.md) |
[Reset Preferences](reset-preferences.md) |
[Keyboard Shortcuts](keyboard-shortcuts.md) |
[Customization](customization.md)
Binary file added preferences/auto-guides.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/brush-preview-types.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/crosshair-types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/edge-color.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/edge-negative.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/keep-selection-deleted-content.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/move-selection-edges.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/nonlinear-undohistory.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/ranges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/ui-multi-window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added preferences/ui-one-window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.