forked from aseprite/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New sections: Customization, Files, Menu Bar, & Preferences
- Loading branch information
Showing
16 changed files
with
263 additions
and
52 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# Customization | ||
|
||
You can change the most common Aseprite configuration from these menus: | ||
|
||
* *Edit > [Preferences](preferences.md)* (<kbd>Ctrl+K</kbd> key, or on macOS: <kbd>⌘K</kbd> or <kbd>⌘,</kbd>) | ||
* *Edit > Keyboard Shortcuts* (<kbd>Ctrl+Alt+Shift+K</kbd> or <kbd>⌥⇧⌘K</kbd> on macOS) | ||
|
||
Other ways of customization are more advance and require downloading | ||
some file (extensions or script) and installing it from *Edit > | ||
Preferences > Extensions* or *File > Scripts > Open Scripts Folder*: | ||
|
||
* [Extensions](extensions.md) | ||
* [Language](language.md) | ||
* [Themes](themes.md) | ||
* [Scripting](scripting.md) | ||
|
||
--- | ||
|
||
**SEE ALSO** | ||
|
||
[Overview](overview.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Files | ||
|
||
Aseprite uses several file formats to save and load different | ||
information. The main thing you need to know is that your work is | ||
saved in your local computer when you use the [*File > Save* menu](save.md). | ||
There is no "cloud" or remote server funcionality involved, so keep in mind to | ||
backup your work or use a cloud-like folder service like Dropbox, | ||
Drive, OneDrive, etc. if you want to keep your work safe or shared | ||
between computers. | ||
|
||
## .aseprite | ||
|
||
Aseprite has its own file format to [save](save.md) your work: `.aseprite` files | ||
(or `.ase`, [both are the same](/faq/#is-there-any-difference-between-ase-and-aseprite-files)). | ||
When you save your sprites in an `.aseprite` file you | ||
will be able to keep all the information intact ([color | ||
mode](color-mode.md), [layers](layers.md), [frames](frames.md), | ||
palette, [tags](tags.md), [slices](slices.md), etc.) | ||
|
||
Generally you will want to [export your work](exporting.md) to other | ||
formats (`.png`, `.gif`, etc.) for publishing purposes or to use your | ||
assets in a game. But keep the original `.aseprite` in a safe place to | ||
modify the sprite when it's required. | ||
|
||
The internal structure of these files is described in the [Aseprite | ||
File Format Specs](https://github.com/aseprite/aseprite/blob/main/docs/ase-file-specs.md). | ||
|
||
## .aseprite-extension | ||
|
||
You can create extensions in the `.aseprite-extension` format which is | ||
a `.zip` file with a specific set of files inside, see the [File | ||
Content](extensions.md#file-content) section in the | ||
[Extensions](extensions.md) page for more information. | ||
|
||
## .lua | ||
|
||
A script in the *File > Scripts > Open Scripts Folder* folder used for | ||
[scripting purposes](scripting.md). | ||
|
||
## Preferences | ||
|
||
[Preferences](preferences.md) are saved inside the [preferences | ||
folder](preferences-folder.md) in several files: | ||
|
||
### aseprite.ini | ||
|
||
The main options/configuration specified in the *Edit > Preferences* | ||
dialog are in this file. | ||
|
||
### user.aseprite-brushes | ||
|
||
Custom brushes are stored in this file (a XML file). In the future | ||
we'll bring more options to export/import brushes between different | ||
files. | ||
|
||
### user.aseprite-keys | ||
|
||
Your customized keyboard shortcuts are stored in this file, and when | ||
you export/import keyboard shortcuts the same `.aseprite-keys` file | ||
format is used (a XML file). | ||
|
||
### sessions | ||
|
||
The `sessions` folder has some backup files used | ||
in [data recovery process](data-recovery.md). | ||
|
||
--- | ||
|
||
**SEE ALSO** | ||
|
||
[Save](save.md) | | ||
[Exporting](exporting.md) | | ||
[Preferences](preferences.md) | | ||
[Aseprite File Format Specs](https://github.com/aseprite/aseprite/blob/main/docs/ase-file-specs.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Menu Bar | ||
|
||
The Aseprite menu bar is the menu at the top of the [main window](workspace). | ||
|
||
![Aseprite Menu Bar](menu-bar/aseprite-menubar.png) | ||
|
||
You can access the main functionality of Aseprite from this menu. | ||
Pressing <kbd>Alt+underscored letter</kbd> will open the given menu, | ||
e.g. <kbd>Alt+F</kbd> will open the *File* menu. After that you can | ||
press an underscored key to access submenus. E.g. <kbd>Alt+F</kbd> and | ||
then <kbd>N</kbd> will access *File > New* menu option. | ||
|
||
On macOS this bar is hidden by default as you can use the macOS menu | ||
at the top of the screen: | ||
|
||
![macOS Menu Bar](menu-bar/macos-menubar.png) | ||
|
||
Anyway you can show the Aseprite menu bar checking the [*Edit > | ||
Preferences > General > Show Aseprite menu | ||
bar*](preferences.md#general) option. | ||
|
||
--- | ||
|
||
**SEE ALSO** | ||
|
||
[Workspace](workspace.md) | | ||
[Preferences](preferences.md) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
# Preferences | ||
|
||
We 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). | ||
|
||
The Preferences dialog is divided in several sections: | ||
|
||
## General | ||
|
||
* **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 | ||
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 probably 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 | ||
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 | ||
* **Show Aseprite menu bar** (only available on macOS): The [Aseprite | ||
menu bar](menu-bar.md) is visible by default on Windows and Linux: | ||
|
||
![Aseprite Menu Bar](menu-bar/aseprite-menubar.png) | ||
|
||
But it's hidden by default on macOS, as in macOS you can use the | ||
system menu bar: | ||
|
||
![macOS Menu Bar](menu-bar/macos-menubar.png) | ||
|
||
* **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**: | ||
* **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 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) | ||
|
||
## Alerts | ||
|
||
Several (non-undoable) actions on Aseprite show a warning message with | ||
a *Don't show this alert again* checkbox: | ||
|
||
![Alert example](preferences/show-alert.png) | ||
|
||
You can re-enable these dialogs from *Edit > Preferences > Alerts*. | ||
|
||
## Editor | ||
|
||
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 (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 | ||
only, and if you enable it you will be zoom using two fingers in | ||
your MacBook trackpad. | ||
* **Zoom from center with scroll wheel**: Check this if you want to | ||
[zoom](zoom.md) from the center of the sprite editor instead zooming | ||
from the mouse position when the mouse wheel is used. | ||
* **Zoom from center with keys**: Zoom from the center of the sprite | ||
instead of the mouse position when we use the keys | ||
[to zoom](zoom.md) <kbd>1</kbd>, <kbd>2</kbd>, <kbd>3</kbd>, etc. | ||
* **Show scroll-bars in sprite editor**: Uncheck this to hide the | ||
scroll bars on all sprite editors. | ||
* **Auto-scroll on editor edges**: With this option checked, when you | ||
are [drawing](drawing.md) (have the mouse button pressed) and the | ||
mouse touches the edges of the sprite editor, it will scrolls | ||
automatically. | ||
* **Auto-fit on screen when a sprite is opened**: When it's checked, | ||
after you create a new sprite or open an existent one, the editor | ||
will show the whole image fitting it in the available space of the | ||
canvas. When this option is unchecked (the default option), the | ||
initial zoom level will be 100% by default. | ||
* **Preview straight line immediately on Pencil tool**: When you use | ||
the ![Pencil icon](tools/pencil-tool.png) Pencil tool, pressing | ||
the <kbd>Shift</kbd> key will draw a straight line from the last painted | ||
point. With this option checked, you will see the line preview | ||
immediately after pressing the <kbd>Shift</kbd> key (instead of | ||
waiting for the mouse button). If this is too annoying for you, you | ||
can uncheck the option. | ||
* **Discard custom brush when eyedropper is used**: If you create a | ||
custom brush with *Edit > New Brush* option, using the eyedropper | ||
![Eyedropper tool icon](tools/eyedropper-tool.png) tool will change | ||
the color of your brush. Checking this option, after picking a color | ||
with the eyedropper, the custom brush will be completely discarded | ||
and a a regular brush with the picked color will be selected. | ||
* **Downsampling**: The algorithm to use to show the sprite when the | ||
zoom level is <= 50%. By default it's *Bilinear mipmapping*. | ||
* **Right-click**: You can customize what specific action to do with | ||
the [right-click](right-click.md). | ||
|
||
--- | ||
|
||
**SEE ALSO** | ||
|
||
[Preferences Folder](preferences-folder.md) | | ||
[Reset Preferences](reset-preferences.md) | | ||
[Customization](customization.md) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters