Skip to content

Commit 3f603e8

Browse files
committed
Moved the back to previous page buttons above page titles
1 parent 2f96d3d commit 3f603e8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+80
-80
lines changed

automation-scripts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: Automation scripts | Stipple Effect documentation
33
---
44

5-
# Automation scripts
6-
75
[`< Scripting`](./scripting.md)
86

7+
# Automation scripts
8+
99
As the name suggests, **automation scripts** are designed for the automation of tasks that would be repetitive and tedious to complete manually. However, their scope extends far beyond that, as they can be used to programmatically execute most program actions.
1010

1111
## Contract

brush.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Brush
2-
31
[`< Tools`](./tools.md)
42

3+
# Brush
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/brush.png)
66

77
**Hotkey:** <kbd>B</kbd>

cel.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: Cel | Stipple Effect documentation
33
---
44

5-
# Cel
6-
75
[`< Projects`](./project.md)
86

7+
# Cel
8+
99
A **cel** is an intersection of a [layer](./layer.md) and a [frame](./frame.md). A cel comprises the contents of a layer at a particular frame index.
1010

1111
A [project](./project.md) with 6 layers and 12 frames consists of 72 (6 x 12) cels. Thus, a project can be thought of as a matrix of cels.

child-scripts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Child scripts
2-
31
[`< Scripting`](./scripting.md)
42

3+
# Child scripts
4+
55
**Child script** is a catch-all categorization for a script that is executed from within another script. A script that calls a child script is known as the **parent script**. Like "child script", this is also a relative, contextually-dependent categorization.
66

77
Child scripts are useful for housing atomic chunks of work that would otherwise have to be written over and over as part of longer automation, preview, and color scripts.

color-actions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Color actions
2-
31
[`< Overview`](./README.md)
42

3+
# Color actions
4+
55
**Color actions** are algorithmic operations that operate over every pixel in a given [scope](./scope.md) of the current [project](./project.md).
66

77
## ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/palettize.png) Palettization

color-picker.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Color Picker
2-
31
[`< Tools`](./tools.md)
42

3+
# Color Picker
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/color_picker.png)
66

77
**Hotkey:** <kbd>C</kbd>

color-scripts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Color scripts
2-
31
[`< Scripting`](./scripting.md)
42

3+
# Color scripts
4+
55
**Color scripts** are used to define the behaviour of the [script brush](./script-brush.md) ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/script_brush.png) tool and the ["run a color script"](./color-actions.md#run-a-color-script) ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/color_script.png) color action. They describe a **color to color transformation**.
66

77
**Note:**

color.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Color
2-
31
[`< Overview`](./README.md)
42

3+
# Color
4+
55
This article is meant to (1) provide an overview of the digital color theory concepts that one should understand in order to best use *Stipple Effect*, and (2) explain and illustrate some of *Stipple Effect*'s color-related jargon and conventions.
66

77
## Color models

eraser.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Eraser
2-
31
[`< Tools`](./tools.md)
42

3+
# Eraser
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/eraser.png)
66

77
**Hotkey:** <kbd>E</kbd>

extract-to-pal.md

Whitespace-only changes.

fill-tool.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Fill
2-
31
[`< Tools`](./tools.md)
42

3+
# Fill
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/fill.png)
66

77
**Hotkey:** <kbd>F</kbd>

fonts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Fonts
2-
31
[`< Overview`](./README.md)
42

3+
# Fonts
4+
55
*Stipple Effect* uses the underlying [*Delta Time*![](./assets/ui/external.png)](https://github.com/jbunke/delta-time) library to load and display fonts. Thus, the program's native system fonts, as well as user-defined fonts uploaded for use by the [text tool](./text-tool.md) at runtime, must comply with Delta Time's **font standard**.
66

77
## Font files

frame.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: Frame | Stipple Effect documentation
33
---
44

5-
# Frame
6-
75
[`< Projects`](./project.md)
86

7+
# Frame
8+
99
A **frame** is a snapshot of an animation. Multi-frame [projects](./project.md) are considered **animations**, while a project with a single frame is **static**.
1010

1111
Frames are *Stipple Effect* projects' horizontal organizational axis. Conversely, [layers](./layer.md) make up the vertical axis. The intersection of a particular frame and a particular layer is called a [cel](./cel.md).

gradient-tool.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Gradient Tool
2-
31
[`< Tools`](./tools.md)
42

3+
# Gradient Tool
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/gradient_tool.png)
66

77
**Hotkey:** <kbd>G</kbd>

hand.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Hand
2-
31
[`< Tools`](./tools.md)
42

3+
# Hand
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/hand.png)
66

77
**Hotkey:** <kbd>H</kbd>

hsv-shift.md

Whitespace-only changes.

interface.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: The Interface | Stipple Effect documentation
33
---
44

5-
# The Interface
6-
75
[`< Overview`](README.md)
86

7+
# The Interface
8+
99
![](./assets/interface/panel-config.gif)
1010

1111
The program interface consists of a viewport called the "workspace" surrounded by a series of panels. Any of these panels can be hidden according to the preferences of the user or the demands of the task at hand.

layer.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: Layer | Stipple Effect documentation
33
---
44

5-
# Layer
6-
75
[`< Projects`](./project.md)
86

7+
# Layer
8+
99
**Layers** are stacked on top of one another and rendered in order to compose the [project](./project.md).
1010

1111
Layers are *Stipple Effect* projects' vertical organizational axis. Conversely, [frames](./frame.md) make up the horizontal axis. The intersection of a particular layer and a particular frame is called a [cel](./cel.md).

line-tool.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Line Tool
2-
31
[`< Tools`](./tools.md)
42

3+
# Line Tool
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/line_tool.png)
66

77
**Hotkey:** <kbd>L</kbd>

outline.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Outlining
2-
31
[`< Overview`](./README.md)
42

3+
# Outlining
4+
55
**Outlining** in *Stipple Effect* works differently than it does in most similar art programs. Rather than filling the outline of a layer or a selection, the various outline actions in *Stipple Effect* simply propagate the [pixel selection](./selection.md) to its own outline based on a certain **outline configuration**, also called a **side mask**.
66

77
## ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/outline.png) Outline configuration menu

palette.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Color palettes
2-
31
[`< Overview`](./README.md)
42

3+
# Color palettes
4+
55
A core component of pixel art is a restricted **color palette**.
66

77
In modern digital art, a [24-bit RGB color space](./color.md#rgba) allows us to represent over 16 million unique colors. However, pixel art is a medium of constraints. One of the constraints of traditional pixel art is a highly restrictive color palette comprised from as little as two to a few dozen colors.

pencil.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Pencil
2-
31
[`< Tools`](./tools.md)
42

3+
# Pencil
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/pencil.png)
66

77
**Hotkey:** <kbd>P</kbd>

pixel-grid.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Pixel grid and checkerboard
2-
31
[`< Overview`](./README.md)
42

3+
# Pixel grid and checkerboard
4+
55
The **pixel grid** and **checkerboard** are visual aides that are central to many workflows in *Stipple Effect*.
66

77
Pixel grid lines can vary in length per dimension from 1 pixel to 128 pixels, while checkerboard squares/rectangles can range from 1 pixel to 256 pixels high and wide.

preview-scripts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Preview scripts
2-
31
[`< Scripting`](./scripting.md)
42

3+
# Preview scripts
4+
55
*Stipple Effect* has a [preview window](./preview-window.md) to give the user a secondary viewport with which to view the [project](./project.md) alongside the [workspace](./interface.md#workspace). By default, the preview window merely displays the project as it is. However, with **preview scripts**, the user can define an algorithm that transforms the project's contents for the sake of display in the preview window.
66

77
The script is executed every time that the user edits the project. An edit to the project might be a brush stroke or an [undo](./state-control.md#undo) operation or a paste action. However, advancing the frame index, for example, is not considered an edit.

preview-window.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Preview window
2-
31
[`< The interface`](./interface.md)
42

3+
# Preview window
4+
55
The **preview window** is a secondary viewport that complements the [workspace](./interface.md#workspace). It can be used to view the [project](./project.md) at a different zoom level or to loop an animation while editing a particular [frame](./frame.md) in the workspace.
66

77
It can be opened ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/preview.png) with <kbd>Shift</kbd> + <kbd>Space</kbd> or with `View > Show preview`.

project.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
title: Project | Stipple Effect documentation
33
---
44

5-
# Project
6-
75
[`< Overview`](./README.md)
86

7+
# Project
8+
99
A *Stipple Effect* session consists of one or multiple **projects**. Projects are sometimes referred to – especially in the [source code![](./assets/ui/external.png)](https://github.com/stipple-effect/stipple-effect) – as **contexts**.
1010

1111
The projects that are currently loaded in the program are arranged in the [projects panel](./interface.md#projects).

save.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Saving & Exporting
2-
31
[`< Overview`](./README.md)
42

3+
# Saving & Exporting
4+
55
In addition to saving [projects](./project.md) to *Stipple Effect*'s native file type, users have several export options depending on whether a project is [static or an animation](./frame.md), and for which purposes they intend to use or distribute an asset.
66

77
## Native file type

scope.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Scope
2-
31
[`< Overview`](./README.md)
42

3+
# Scope
4+
55
Algorithmic operations such as [color actions](./color-actions.md) are executed over a user-determined **scope**. This page lists and briefly describes the possible scopes for such operations, as well as the related **options**.
66

77
### Scopes

script-brush.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Script Brush
2-
31
[`< Tools`](./tools.md)
42

3+
# Script Brush
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/script_brush.png)
66

77
**Hotkey:** <kbd>Q</kbd>

scripting.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Scripting
2-
31
[`< Overview`](./README.md)
42

3+
# Scripting
4+
55
*Stipple Effect* lets users write scripts for a wide range of potential uses and applications. A **script** is a short series of instructions for the program to execute.
66

77
## DeltaScript

sel-area-tools.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Selection area tools
2-
31
[`< Tools`](./tools.md)
42

3+
# Selection area tools
4+
55
## Universal
66

77
Selection area tools have **simple**, **additive**, and **subtractive** selection modes:

sel-move-tools.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Selection movement tools
2-
31
[`< Tools`](./tools.md)
42

3+
# Selection movement tools
4+
55
## Universal
66

77
The **move selection** and **pick up selection** behave almost identically. The only difference is that the move selection tool modifies the *selection area*, while the pick up selection tool modifies the *contents of the selection*.

selection.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Selection
2-
31
[`< Overview`](./README.md)
42

3+
# Selection
4+
55
At any given point, a set of pixels on a [project](./project.md)'s canvas may be selected.
66

77
Selections can me determined by [selection area tools](./sel-area-tools.md) and transformed by [selection movement tools](./sel-move-tools.md). Pixels outside the bounds of the canvas can also be selected by certain tools.

shade-brush.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Shade Brush
2-
31
[`< Tools`](./tools.md)
42

3+
# Shade Brush
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/shade_brush.png)
66

77
**Hotkey:** <kbd>D</kbd>

shape-tool.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Shape Tool
2-
31
[`< Tools`](./tools.md)
42

3+
# Shape Tool
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/shape_tool.png)
66

77
**Hotkey:** <kbd>R</kbd>

shortcuts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Shortcuts
2-
31
[`< Overview`](./README.md)
42

3+
# Shortcuts
4+
55
This page lists the keyboard shortcuts in *Stipple Effect*.
66

77
Tool hotkeys can be found [here](./tools.md).

sizing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Sizing and frame control
2-
31
[`< Overview`](./README.md)
42

3+
# Sizing and frame control
4+
55
The [project](./project.md) canvas is a rectangle of certain pixel dimensions. Both the width and height of the canvas must be positive (`w,h > 0`).
66

77
Currently, the maximum dimensions for a *Stipple Effect* project are **1920 pixels wide** and **1080 pixels high**. This will likely increase in a future update.

state-control.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# State control
2-
31
[`< Overview`](./README.md)
42

3+
# State control
4+
55
Most program actions in *Stipple Effect* constitute **edits**, and thus change the [project state](./project.md#state). It is important for users to be able to navigate between project states to revert to earlier or later states, in case of mistakes or simply for reference.
66

77
## State manager

stipple-pencil.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Stipple Pencil
2-
31
[`< Tools`](./tools.md)
42

3+
# Stipple Pencil
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/stipple_pencil.png)
66

77
**Hotkey:** <kbd>O</kbd>

text-tool.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Text Tool
2-
31
[`< Tools`](./tools.md)
42

3+
# Text Tool
4+
55
**Icon:** ![](https://raw.githubusercontent.com/stipple-effect/stipple-effect/master/res/icons/text_tool.png)
66

77
**Hotkey:** <kbd>T</kbd>

0 commit comments

Comments
 (0)