Skip to content

Commit f49a393

Browse files
dacapdacap
committed
New sections: Customization, Files, Menu Bar, & Preferences
1 parent f1192c1 commit f49a393

16 files changed

+263
-52
lines changed

‎customization.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Customization
2+
3+
You can change the most common Aseprite configuration from these menus:
4+
5+
* *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)
7+
8+
Other ways of customization are more advance and require downloading
9+
some file (extensions or script) and installing it from *Edit >
10+
Preferences > Extensions* or *File > Scripts > Open Scripts Folder*:
11+
12+
* [Extensions](extensions.md)
13+
* [Language](language.md)
14+
* [Themes](themes.md)
15+
* [Scripting](scripting.md)
16+
17+
---
18+
19+
**SEE ALSO**
20+
21+
[Overview](overview.md)

‎exporting.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# Exporting
22

3-
Generally you will use the *File > Save* to save your work with full
4-
information as a `.ase` or `.aseprite` file
5-
([both are the same](/faq/#is-there-any-difference-between-ase-and-aseprite-files)). Then
6-
you can export your sprite for your own game, website, application,
7-
etc. using the *File > Export* menu option to convert your sprite into
8-
a `.gif` file or a sequence of `.png` files.
3+
Generally you will use *File > Save* to [save your work](save.md) with full
4+
information [as an `.aseprite` file](files.md#aseprite). Then you can export
5+
your sprite for your own game, website, application, etc. using the *File > Export*
6+
menu option (<kbd>Ctrl+Alt+Shift+S</kbd> key or <kbd>⌥⇧⌘S</kbd> on macOS)
7+
to convert your sprite into a `.gif` file or a sequence of `.png` files.
98

109
*File > Export* will remember the latest options you've used in case
1110
that you want to save the copy again.

‎files.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Files
2+
3+
Aseprite uses several file formats to save and load different
4+
information. The main thing you need to know is that your work is
5+
saved in your local computer when you use the [*File > Save* menu](save.md).
6+
There is no "cloud" or remote server funcionality involved, so keep in mind to
7+
backup your work or use a cloud-like folder service like Dropbox,
8+
Drive, OneDrive, etc. if you want to keep your work safe or shared
9+
between computers.
10+
11+
## .aseprite
12+
13+
Aseprite has its own file format to [save](save.md) your work: `.aseprite` files
14+
(or `.ase`, [both are the same](/faq/#is-there-any-difference-between-ase-and-aseprite-files)).
15+
When you save your sprites in an `.aseprite` file you
16+
will be able to keep all the information intact ([color
17+
mode](color-mode.md), [layers](layers.md), [frames](frames.md),
18+
palette, [tags](tags.md), [slices](slices.md), etc.)
19+
20+
Generally you will want to [export your work](exporting.md) to other
21+
formats (`.png`, `.gif`, etc.) for publishing purposes or to use your
22+
assets in a game. But keep the original `.aseprite` in a safe place to
23+
modify the sprite when it's required.
24+
25+
The internal structure of these files is described in the [Aseprite
26+
File Format Specs](https://github.com/aseprite/aseprite/blob/main/docs/ase-file-specs.md).
27+
28+
## .aseprite-extension
29+
30+
You can create extensions in the `.aseprite-extension` format which is
31+
a `.zip` file with a specific set of files inside, see the [File
32+
Content](extensions.md#file-content) section in the
33+
[Extensions](extensions.md) page for more information.
34+
35+
## .lua
36+
37+
A script in the *File > Scripts > Open Scripts Folder* folder used for
38+
[scripting purposes](scripting.md).
39+
40+
## Preferences
41+
42+
[Preferences](preferences.md) are saved inside the [preferences
43+
folder](preferences-folder.md) in several files:
44+
45+
### aseprite.ini
46+
47+
The main options/configuration specified in the *Edit > Preferences*
48+
dialog are in this file.
49+
50+
### user.aseprite-brushes
51+
52+
Custom brushes are stored in this file (a XML file). In the future
53+
we'll bring more options to export/import brushes between different
54+
files.
55+
56+
### user.aseprite-keys
57+
58+
Your customized keyboard shortcuts are stored in this file, and when
59+
you export/import keyboard shortcuts the same `.aseprite-keys` file
60+
format is used (a XML file).
61+
62+
### sessions
63+
64+
The `sessions` folder has some backup files used
65+
in [data recovery process](data-recovery.md).
66+
67+
---
68+
69+
**SEE ALSO**
70+
71+
[Save](save.md) |
72+
[Exporting](exporting.md) |
73+
[Preferences](preferences.md) |
74+
[Aseprite File Format Specs](https://github.com/aseprite/aseprite/blob/main/docs/ase-file-specs.md)

‎menu-bar.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Menu Bar
2+
3+
The Aseprite menu bar is the menu at the top of the [main window](workspace).
4+
5+
![Aseprite Menu Bar](menu-bar/aseprite-menubar.png)
6+
7+
You can access the main functionality of Aseprite from this menu.
8+
Pressing <kbd>Alt+underscored letter</kbd> will open the given menu,
9+
e.g. <kbd>Alt+F</kbd> will open the *File* menu. After that you can
10+
press an underscored key to access submenus. E.g. <kbd>Alt+F</kbd> and
11+
then <kbd>N</kbd> will access *File > New* menu option.
12+
13+
On macOS this bar is hidden by default as you can use the macOS menu
14+
at the top of the screen:
15+
16+
![macOS Menu Bar](menu-bar/macos-menubar.png)
17+
18+
Anyway you can show the Aseprite menu bar checking the [*Edit >
19+
Preferences > General > Show Aseprite menu
20+
bar*](preferences.md#general) option.
21+
22+
---
23+
24+
**SEE ALSO**
25+
26+
[Workspace](workspace.md) |
27+
[Preferences](preferences.md)

‎menu-bar/aseprite-menubar.png

3.71 KB
Loading

‎menu-bar/macos-menubar.png

19.1 KB
Loading

‎overview.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,10 @@ at your side.
5151
* [Sprite Sheets](sprite-sheet.md)
5252
* [Command Line Interface (CLI)](cli.md)
5353

54-
**[Extensions](extensions.md)**
54+
**[Customization](customization.md)**
5555

56+
* [Preferences](preferences.md)
57+
* [Extensions](extensions.md)
5658
* [Scripting](scripting.md)
5759

5860
**[Troubleshooting](troubleshooting.md)**:

‎preferences-folder.md

+1
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,5 @@ pointing to other folder.
4545

4646
**SEE ALSO**
4747

48+
[Preferences](preferences.md) |
4849
[Reset Preferences](reset-preferences.md)

‎preferences.md

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Preferences
2+
3+
We can change the configuration of Aseprite from the *Edit >
4+
Preferences* menu or pressing <kbd>Ctrl+K</kbd> key (or <kbd>⌘K</kbd>
5+
or <kbd>⌘,</kbd> on macOS).
6+
7+
The Preferences dialog is divided in several sections:
8+
9+
## General
10+
11+
* **Screen Scaling**: Changes the size of each pixel inside every
12+
window of Aseprite. It's 200% by default, which means that each
13+
pixel in the window will be represented with a 2x2 square on the
14+
screen. When using large monitors (e.g. 4K monitors) you can try
15+
changing to 300% or 400%. If you want to see each pixel of your
16+
sprite represented as one pixel on the screen, you should set this
17+
option to 100%, in this case it's highly probably that you will want
18+
to increase the next option (*UI Elements Scaling*) to 200% or more
19+
if needed.
20+
* **UI Elements Scaling**: It's an extra scale applied only to elements
21+
of the User Interface (buttons, labels, etc.), but without modifying
22+
the scale of the sprite editor. It's 100% by default.
23+
* **Light** | **Dark** options: Since v1.3 you can quickly change between
24+
a Light version of the Aseprite theme, and a Dark one.
25+
* **Language**: The language of the User Interface, English by default,
26+
but you can get some translations contributed by users from:
27+
https://github.com/aseprite/languages
28+
* **Show Aseprite menu bar** (only available on macOS): The [Aseprite
29+
menu bar](menu-bar.md) is visible by default on Windows and Linux:
30+
31+
![Aseprite Menu Bar](menu-bar/aseprite-menubar.png)
32+
33+
But it's hidden by default on macOS, as in macOS you can use the
34+
system menu bar:
35+
36+
![macOS Menu Bar](menu-bar/macos-menubar.png)
37+
38+
* **Expand menu bar items on mouseover**: With this option checked,
39+
when the mouse is above the [Aseprite menu bar](menu-bar.md), a menu
40+
will be opened automatically. By default this is disabled, so you
41+
have to click a menu to open it.
42+
* **Draw a separation between each palette entry**:
43+
* **Share crash data with Aseprite developers**: When Aseprite crashes
44+
(unexpectedly closes) you will be asked to share some crash
45+
information automatically in the future privately with Aseprite
46+
team. Aseprite doesn't do this by default (this option is unchecked
47+
by default), so you have to give your consent to share this
48+
information. More details in
49+
[#2857](https://github.com/aseprite/aseprite/issues/2857)
50+
51+
## Alerts
52+
53+
Several (non-undoable) actions on Aseprite show a warning message with
54+
a *Don't show this alert again* checkbox:
55+
56+
![Alert example](preferences/show-alert.png)
57+
58+
You can re-enable these dialogs from *Edit > Preferences > Alerts*.
59+
60+
## Editor
61+
62+
Options to change the general behavior of the [Sprite Editor](sprite-editor.md):
63+
64+
* **Zoom with scroll wheel**: Checked by default, you zoom with the
65+
mouse wheel (if you uncheck this, the vertical scroll will be the
66+
default action for the mouse wheel).
67+
* **Zoom sliding two fingers up or down**: This is available on macOS
68+
only, and if you enable it you will be zoom using two fingers in
69+
your MacBook trackpad.
70+
* **Zoom from center with scroll wheel**: Check this if you want to
71+
[zoom](zoom.md) from the center of the sprite editor instead zooming
72+
from the mouse position when the mouse wheel is used.
73+
* **Zoom from center with keys**: Zoom from the center of the sprite
74+
instead of the mouse position when we use the keys
75+
[to zoom](zoom.md) <kbd>1</kbd>, <kbd>2</kbd>, <kbd>3</kbd>, etc.
76+
* **Show scroll-bars in sprite editor**: Uncheck this to hide the
77+
scroll bars on all sprite editors.
78+
* **Auto-scroll on editor edges**: With this option checked, when you
79+
are [drawing](drawing.md) (have the mouse button pressed) and the
80+
mouse touches the edges of the sprite editor, it will scrolls
81+
automatically.
82+
* **Auto-fit on screen when a sprite is opened**: When it's checked,
83+
after you create a new sprite or open an existent one, the editor
84+
will show the whole image fitting it in the available space of the
85+
canvas. When this option is unchecked (the default option), the
86+
initial zoom level will be 100% by default.
87+
* **Preview straight line immediately on Pencil tool**: When you use
88+
the ![Pencil icon](tools/pencil-tool.png) Pencil tool, pressing
89+
the <kbd>Shift</kbd> key will draw a straight line from the last painted
90+
point. With this option checked, you will see the line preview
91+
immediately after pressing the <kbd>Shift</kbd> key (instead of
92+
waiting for the mouse button). If this is too annoying for you, you
93+
can uncheck the option.
94+
* **Discard custom brush when eyedropper is used**: If you create a
95+
custom brush with *Edit > New Brush* option, using the eyedropper
96+
![Eyedropper tool icon](tools/eyedropper-tool.png) tool will change
97+
the color of your brush. Checking this option, after picking a color
98+
with the eyedropper, the custom brush will be completely discarded
99+
and a a regular brush with the picked color will be selected.
100+
* **Downsampling**: The algorithm to use to show the sprite when the
101+
zoom level is <= 50%. By default it's *Bilinear mipmapping*.
102+
* **Right-click**: You can customize what specific action to do with
103+
the [right-click](right-click.md).
104+
105+
---
106+
107+
**SEE ALSO**
108+
109+
[Preferences Folder](preferences-folder.md) |
110+
[Reset Preferences](reset-preferences.md) |
111+
[Customization](customization.md)

‎preferences/show-alert.png

1.98 KB
Loading

‎reset-preferences.md

+1
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,5 @@ platform to reset the preferences manually.
4949
**SEE ALSO**
5050

5151
[Troubleshooting](troubleshooting.md) |
52+
[Preferences](preferences.md) |
5253
[Preferences Folder](preferences-folder.md)

‎save.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Save
22

3-
You can save your sprite using *File > Save* menu.
3+
You can save your sprite using the *File > Save* menu or pressing <kbd>Ctrl+S</kbd> (<kbd>⌘S</kbd> on macOS).
44

5-
Aseprite uses `.aseprite` (or `.ase`) file types to save full sprite
6-
information (layers, frames, tags, palettes, etc.). But you can save
7-
your sprite as other file types if you don't need all this information.
8-
For example, you can [open](open.md) a `.png` file, editing it,
9-
and save it again as `.png` (without using the `.aseprite` format).
5+
We highly recommend you to save your sprites in the
6+
[.aseprite](files.md#aseprite) format, so you keep the full sprite
7+
information intact ([layers](layers.md), [frames](frames.md),
8+
etc.). But you can save your sprite as other file types if you don't
9+
need all this information. For example, you can [open](open.md) a
10+
`.png` file, editing it, and save it again as `.png` (without using
11+
the `.aseprite` format).
1012

1113
## Export
1214

‎sidebar.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,12 @@
1515
* [Tilemap](tilemap.md)
1616
* [Slices](slices.md)
1717

18-
Files & Customization
19-
* [Exporting](exporting.md) &mdash; [CLI](cli.md)
18+
[Files](files.md)
19+
* [Save](save.md)
20+
* [Exporting](exporting.md)
21+
* [CLI](cli.md)
22+
23+
[Customization](customization.md)
24+
* [Preferences](preferences.md)
2025
* [Extensions](extensions.md)
2126
* [Scripting](scripting.md)

‎sprite-editor.md

+1-36
Original file line numberDiff line numberDiff line change
@@ -17,42 +17,7 @@ On the sprite editor you can:
1717

1818
### Preferences
1919

20-
There are a lot of things of the Sprite Editor that can be customized
21-
from *Edit > Preferences > Editor* like:
22-
23-
![Sprite Editor Preferences](sprite-editor/editor-preferences.png)
24-
25-
* *Zoom with the wheel*: Checked by default, you zoom with the mouse
26-
wheel (if you uncheck this, the vertical scroll will be the default
27-
action for the mouse wheel)
28-
* *Zoom sliding two fingers up or down*: This is available on macOS
29-
only, and if you enable it you will be zoom using two fingers in
30-
your MacBook trackpad.
31-
* *Zoom from center with scroll wheel*: Check this if you want to [zoom](zoom.md)
32-
from the center of the sprite editor instead zooming from the mouse
33-
position when the mouse wheel is used.
34-
* *Zoom from center with keys*: Zoom from the center of the sprite
35-
instead of the mouse position when we use the keys [to zoom](zoom.md) <kbd>1</kbd>, <kbd>2</kbd>, <kbd>3</kbd>, etc.
36-
* *Show scroll-bars in the sprite editor*: Uncheck to hide the scroll bars.
37-
* *Auto-scroll on editor edges*: With this option checked, when you
38-
are [drawing](drawing.md) (have the mouse button pressed) the mouse
39-
touches the edges of the sprite editor, it will scrolls
40-
automatically.
41-
* *Preview straight line immediately on Pencil tool*: When you use the
42-
Pencil tool, pressing the <kbd>Shift</kbd> key will draw a straight line from
43-
the last painted point. With this option checked, you will see the
44-
line preview immediately after pressing the <kbd>Shift</kbd> key (instead of
45-
waiting for the mouse button). If this is too annoying for you, you
46-
can uncheck the option.
47-
* *Discard custom brush when eyedropper is used*: If you create a
48-
custom brush with *Edit > New Brush* option, using the eyedropper
49-
![Eyedropper tool icon](tools/eyedropper-tool.png)
50-
tool will change the color of your brush. Checking this option,
51-
after picking a color with the eyedropper, the custom brush will be
52-
completely discarded and a a regular brush with the picked color
53-
will be selected.
54-
* *Right-click behavior*: you can customize what action to do with the
55-
[right-click](right-click.md).
20+
You can customize the Sprite Editor behavior from [*Edit > Preferences > Editor*](preferences.md#editor).
5621

5722
---
5823

‎sprite-editor/editor-preferences.png

-21.2 KB
Binary file not shown.

‎workspace.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The most important elements are the
88
[sprite editor](sprite-editor.md), the
99
[timeline](timeline.md), the [color bar](color-bar.md),
1010
and the [preview window](preview-window.md).
11+
Other familiar elements are the [menu bar](menu-bar.md) and
12+
the [tool bar](tool-bar.md).
1113

1214
The timeline is not visible by default, you can make it visible from
1315
*View > Timeline* menu option or pressing <kbd>Tab</kbd> key. (Also it popups
@@ -30,4 +32,5 @@ using <kbd>Ctrl</kbd> or <kbd>Alt</kbd> keys:
3032
[Status Bar](status-bar.md) |
3133
[Tabs](tabs.md) |
3234
[Timeline](timeline.md) |
33-
[Tool Bar](tool-bar.md)
35+
[Tool Bar](tool-bar.md) |
36+
[Menu Bar](menu-bar.md)

0 commit comments

Comments
 (0)