Skip to content
Open
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 color-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The color bar shows the palette for the active sprite:

![Color bar](color-bar/color-bar.png)
![Color bar diagram](color-bar/color-bar.png)

Each color can be identified by its index, starting from 0 to 255.

Expand Down
Binary file modified color-bar/color-bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ 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](keyboard-shortcuts.md)* (<kbd>Ctrl+Alt+Shift+K</kbd> or <kbd>⌥⇧⌘K</kbd> on macOS)
* *View > [Workspace Layout](workspace-layout.md)* (<kbd>Shift+W</kbd> or <kbd>⌘W</kbd> on macOS)

Other ways of customization are more advanced and require downloading
some file (extensions or script) and installing it from *Edit >
Expand Down
1 change: 1 addition & 0 deletions keyboard-shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,5 +124,6 @@ a specific axis):

**SEE ALSO**

[Run Command](run-command.md) |
[Preferences](preferences.md) |
[Customization](customization.md)
69 changes: 69 additions & 0 deletions run-command.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# Run Command

The Run Command window can run any option from the [menu bar](menu-bar.md#menu-bar), any installed script, or any command from the [keyboard shortcuts](keyboard-shortcuts.md#keyboard-shortcuts) menu. It can be accessed with *View > Run Command* or <kbd>Ctrl+Space</kbd>.

![run command example](run-command/run-command.gif)

## Running a Command

To run a command, search the name of the command you want to run in the search box. Below the search box, search results will appear. Press <kbd>Enter</kbd> to execute the first result; use the arrow keys to pick other results.

![run command search/arrow keys example ](run-command/search.gif)

## Math Expressions

The Run Command window supports math expressions. To enter a math expression, type <kbd>=</kbd> (equals sign) followed by a math expression. The result will be shown below the entry box. If the math expression is invalid (e.g: there is an unclosed parenthesis) then the result will be `NaN`.

![math expressions example](run-command/math.gif)


### Supported Symbols, Constants, & Functions

| Symbol | Description
|-|-
| `+` | Add
| `-` | Subtract/Negate
| `*` | Multiply
| `/` | Divide
| `^` | Exponent/Power
| `%` | [Modulus](https://en.wikipedia.org/wiki/Modulo) (remainder divide)

| Constant | Description
|-|-
| `pi` | The value of [Pi](https://en.wikipedia.org/wiki/Pi) (`3.14159...`).
| `e` | E for use in [scientific notation](https://en.wikipedia.org/wiki/Scientific_notation#E_notation), e.g (`2.4e8`).

**Supported Functions:**
* `abs(x)`
* `acos(x)`
* `asin(x)`
* `atan(x)`
* `atan2(x, y)`
* `ceil(x)`
* `cos(x)`
* `cosh(x)`
* `exp(x)`
* `floor(x)`
* `ln(x)`
* `log(x)`
* `log10(x)`
* `pow(x, y)`
* `sin(x)`
* `sinh(x)`
* `sqrt(x)`
* `tan(x)`
* `tanh(x)`

## Inline Lua Expressions

The Run Command window supports inline [Lua](https://www.lua.org/) code. To start a codeline, type <kbd>@</kbd>.

![lua expressions example](run-command/lua.gif)

Global variables and functions can be created and accessed with another Run Command codeline; the variables and functions are reset after the Aseprite instance is closed.

---

**SEE ALSO**

[Keyboard Shortcuts](keyboard-shortcuts#keyboard-shortcuts.md)
Binary file added run-command/lua.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 run-command/math.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 run-command/run-command.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 run-command/search.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions scripting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
**[Aseprite v1.2.10-beta2](https://www.aseprite.org/release-notes/#aseprite-v1-2-10-beta10)**
introduced the possibility to write scripts with Lua:

* [API Reference](https://github.com/aseprite/api#aseprite-api)
* [Known issues and report bugs](https://github.com/aseprite/api/issues)
* [API Reference](https://www.aseprite.org/api)
* [Known issues and report bugs](https://github.com/aseprite/aseprite/issues)

Scripts are located in the [user scripts folder](https://community.aseprite.org/t/locate-user-scripts-folder/2170)
that you can easily locate going to *File > Scripts > Open Script Folder*.
that you can easily locate going to *File > Scripts > Open Scripts Folder*.

Script Examples:

Expand Down
5 changes: 4 additions & 1 deletion sidebar.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
### Table of content
### Table of contents

[Overview](overview.md)

[Basics](basics.md)
* [Workspace](workspace.md)
* [Image & Sprite](sprite.md)
* [Color](color.md)
* [Drawing](drawing.md)
Expand All @@ -23,5 +24,7 @@

[Customization](customization.md)
* [Preferences](preferences.md)
* [Keyboard Shortcuts](keyboard-shortcuts.md)
* [Workspace Layout](workspace-layout.md)
* [Extensions](extensions.md)
* [Scripting](scripting.md)
34 changes: 34 additions & 0 deletions workspace-layout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Workspace Layout

Certain UI window elements can be moved (docked) to different positions in the window. To enter the Workspace Layout mode, you can press <kbd>Shift+W</kbd>, *View > Workspace Layout*, or click the *boxes icon* in the top right corner of the window. There are two native layouts: Default (Default Aseprite layout) and Mirrored Default (The Default layout but mirrored).

![where to find the layout button demo](workspace-layout/layout-button.gif)

## Saving Layouts

Aseprite allows custom layouts to be saved. The dropdown menu in the top right corner of the window (next to the layout button) controls the selected layout. The first two layouts in the dropdown (the "Workspace Layout" section) are native Aseprite layouts: Default (Default Aseprite layout) and Mirrored Default (The Default layout but mirrored). Below this (the "User Layouts" section), clicking "New Layout" creates a new layout. When moving around UI elements, the changes are saved to the currently selected layout.

![new layout demo](workspace-layout/new-layout.gif)


## Moving UI Elements

In the Workspace Layout mode, these UI elements can be moved:
- [Timeline](timeline.md)
- [Color Bar](color-bar.md)
- [Context Bar](context-bar.md)
- [Tool Bar](tool-bar.md)
- [Status Bar](status-bar.md)

Each element has three lines at the top or side of them. Clicking and dragging the three lines allows an element to be moved. When a dragged element is hovering over a valid place to move the element, an open space will appear, indicating that the element can be placed there.

![moving elements demo](workspace-layout/dragging-elements.gif)

With the exception of the timeline, which can be moved to the top, bottom, left, and right in the window, vertical UI elements cannot be moved horizontally and horizontal UI elements cannot be moved vertically (e.g the toolbar cannot be moved to the top of the screen).

---

**SEE ALSO**

[Workspace](workspace.md) |
[Customization](customization.md)
Binary file added workspace-layout/dragging-elements.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 workspace-layout/layout-button.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 workspace-layout/new-layout.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 13 additions & 8 deletions workspace.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
# Workspace

You should become familiar with these window elements:
This is what the Aseprite workspace looks like in the Default layout:

<img src="/docs/workspace/screen.png" alt="Workspace Screenshot" class="xN" />
![workspace diagram](workspace/workspace.png)

The most important elements are the
[sprite editor](sprite-editor.md), the
[timeline](timeline.md), the [color bar](color-bar.md),
[timeline](timeline.md), the [color bar and color pickers](color-bar.md),
and the [preview window](preview-window.md).
Other familiar elements are the [menu bar](menu-bar.md) and
Other elements are the [menu bar](menu-bar.md) and
the [tool bar](tool-bar.md). The [status bar](status-bar.md) also gives you valuable
information about the current sprite.

The timeline is not visible by default, you can make it visible with the
*View > Timeline* menu option or <kbd>Tab</kbd> key. (It also pops up
automatically when you add a new frame or a new layer.)
The timeline is not visible by default; it can be made visible with
*View > Timeline* or the <kbd>Tab</kbd> key (It also pops up
automatically when you add a new frame or a new layer).

## Workspace Layout (Docking)

See the [Workspace Layout](workspace-layout.md#workspace-layout) section.

## Drag and drop tabs

Expand All @@ -35,4 +39,5 @@ with the <kbd>Left Mouse Button</kbd>:
[Tabs](tabs.md) |
[Timeline](timeline.md) |
[Tool Bar](tool-bar.md) |
[Menu Bar](menu-bar.md)
[Menu Bar](menu-bar.md) |
[Workspace Layout](workspace-layout.md)
Binary file removed workspace/screen.png
Binary file not shown.
Binary file added workspace/workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.