Skip to content

Commit

Permalink
manual:1.2.0: Sweeping changes
Browse files Browse the repository at this point in the history
A lot of changes that mostly surround the page directory scheme,
creating dummy pages, and using fancy buttons on the index page.

Signed-off-by: Aesara Binder <[email protected]>
  • Loading branch information
AesaraB committed Aug 23, 2024
1 parent 5b2007a commit 2c5938b
Show file tree
Hide file tree
Showing 64 changed files with 118 additions and 90 deletions.
2 changes: 1 addition & 1 deletion pages/docs/contributing/building/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ These dependencies are developed by the MyPaint project.

{{< flex >}}
{{< button content="Building libmypaint" href="libmypaint" >}}
{{< button content="Building MyPaint Brushes" href="brushes" >}}
{{< button content="Building MyPaint Brushes" href="./brushes" >}}
{{< /flex >}}

## User Installation
Expand Down
95 changes: 42 additions & 53 deletions pages/docs/manuals/v1.2.0/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,73 +17,62 @@ background where you can draw (the **canvas**). At the top, there are toolbars a
status bar with some buttons and indicators clustered in the corners.

{{< img src="mypaint-window-new.jpg" caption="A fresh installation of MyPaint" >}}
<br>
{{< img src="mypaint-window-in-use.jpg" caption="MyPaint can be customised with dockable panels and palettes, all hideable while you work.">}}

{{< img src="mypaint-window-in-use.jpg" caption="MyPaint's user interface adapts to meet your needs">}}

MyPaint can be customised with dockable panels and palettes, all hideable while you work.

## Read more
To learn more about MyPaint's user interface, refer to these pages:
<br>

{{< flex grow="true" >}}
{{< button content="Main Toolbar" href="ui/main-toolbar" >}}
{{< button content="UI Toolbar" href="ui/ui-toolbar" >}}
{{< button content="Footer Bar" href="ui/footer-bar" >}}
{{< button content="Dockable Panels" href="./panels" >}}
{{< button content="Fullscreen Mode" href="ui/fullscreen" >}}
{{< bigbutton title="Main Toolbar" subtitle="Painting tools and other commands" href="ui/main-toolbar" >}}
{{< bigbutton title="UI Toolbar" subtitle="Customise the user interface" href="ui/ui-toolbar" >}}
{{< bigbutton title="Footer Bar" subtitle="Application status and brush controls" href="ui/footer-bar" >}}
{{< bigbutton title="Dockable Panels" subtitle="Tailor your painting experience" href="./panels-popups" >}}
{{< bigbutton title="Fullscreen Mode" subtitle="Maximise drawing space" href="ui/fullscreen" >}}
{{< /flex >}}

# Tools
## Anatomy of a stroke
When you paint a stroke, the result is defined by different parts of MyPaint. You can combine any _Painting Tool_,
_Brush_ and _Paint Mode_ to suit your drawing style. MyPaint uses one and the same engine for all kinds of brushes (and
the eraser).

* Painting Tool: Defines how the **shape** of a stroke is made
* Brush: Defines the **look** of the stroke
* Paint Mode: Defines how the resulting color is **applied** to the canvas.

# Painting
When brush strokes are placed on the canvas, three elements determine the change made to the picture: The *painting
tool*, *brush*, and *paint mode*. These three elements can be combined arbitrarily to fit any desired art style.

## The Painting Tools
{{< img src="mypaint-preferences.jpg" caption="Menu -> Edit -> Current Tool" width="250px" float="right" >}}
1. **Painting Tool**: Determines the broad *geometry* of the stroke.
2. **Brush**: Determines the *design* of the stroke.
3. **Paint Mode**: Determines the *effect* of the stroke unto the canvas.

The general painting tools change the input method of strokes and can be used to construct geometrical shape. The lines
that are created will be made with the current brush, colour, and paint blend mode.

* [Freehand]({{< relref "tools/freehand" >}}) - free drawing without constraints
* [Inking]({{< relref "tools/inking" >}}) - smooth Strokes than can be modified
* Lines and Curves
* Connected Lines
* [Ellipses and Circles]({{< relref "tools/ellipses-and-circles" >}})
## Painting Tools
> *Menu → Edit → Current Tool*
### Other Tools
MyPaint also offers Tools for:
- [Navigation]({{< relref "ui/main-toolbar#view-main" >}})
- [Canvas tools]({{< relref "ui/main-toolbar#core-tools" >}})
- the colour picker.
Painting tools change how the user makes strokes by adding or removing contraints on stroke input.

# Shortcuts for brush settings
Brush shortcut keys are used to quickly save and restore brush settings. You can paint with one hand and change brushes
with the other, even in mid-stroke.

There are 10 slots available for brushes. By default, shortcuts are assigned to the keys `1` through `9`, and to the `0`
key. To save your current brush’s settings to one of these press `Ctrl+<number>`, for example `Ctrl+9`. To load stored
settings back, just press the number key on its own.
{{< flex grow=true >}}
{{< bigbutton title="Freehand" subtitle="Unconstrained strokes" href="painting/freehand" >}}
{{< bigbutton title="Lines & Curves" subtitle="Singular constrained strokes" href="painting/lines-and-curves" >}}
{{< bigbutton title="Connected Lines" subtitle="Consecutive lines & curves" href="painting/connected-lines" >}}
{{< bigbutton title="Ellipses & Circles" subtitle="Constrained circular strokes" href="painting/ellipses-and-circles" >}}
{{< bigbutton title="Inking" subtitle="Modify a stroke before committing to it" href="painting/inking" >}}
{{< /flex >}}

The brush shortcuts you assign are saved to your personal MyPaint settings, allowing you to use them in future sessions.
## Brushes
[Read more]({{< relref "./painting/brushes" >}})

By default, pressing the `Q` key saves your current brush’s settings to the most recently used shortcut slot.
## Paint Modes
blend modes, eraser. [Read more]({{< relref "painting/paint-modes" >}})

## Options
By default, brush shortcut keys remember the colour you had active when you saved the brush.
# Canvas Tools
Tools also exist to interact with the canvas in other ways.

This behaviour can be turned off using the main menu:
- _Brush → Shortcut Keys → Brush Shortcut Keys Restore Colour_.
{{< flex grow=true >}}
{{< bigbutton title="View Tools" subtitle="Modify the viewport" href="ui/main-toolbar#view-main" >}}
{{< bigbutton title="Reposition Layer" subtitle="Modify a layer's position" href="canvas-tools/reposition-layer" >}}
{{< bigbutton title="Flood Fill" subtitle="Fill an enclosed area with colour" href="canvas-tools/flood-fill" >}}
{{< bigbutton title="Colour Picker" subtitle="Pick a brush colour from the canvas" href="canvas-tools/colour-picker" >}}
{{< bigbutton title="Stroke/Layer Picker" subtitle="Pick a brush stroke from the canvas" href="canvas-tools/stroke-layer-picker" >}}
{{< bigbutton title="Symmetry" subtitle="Add lines of symmetry brush strokes" href="canvas-tools/symmetry" >}}
{{< bigbutton title="Edit Frame" subtitle="Set a working space in the canvas" href="canvas-tools/frame" >}}
{{< /flex >}}

# Preferences
The [Preferences Window]({{< relref "preferences" >}}) gives you options to configure
MyPaint's appearance, input, keyboard shortcuts and many other settings.
> *Edit → Edit Preferences*, or *Window → Edit Preferences*
Open the Preferences Window by:
* Menu Edit -> Edit Preferences
* Menu Window -> Edit Preferences
The preferences window gives you options to configure MyPaint's appearance, input, keyboard shortcuts and many other
settings. [Read more]({{< relref "preferences" >}})
File renamed without changes.
6 changes: 6 additions & 0 deletions pages/docs/manuals/v1.2.0/canvas-tools/flood-fill.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
+++
title = "Flood Fill Tool"
tags = "Incomplete"
+++

TBD.
6 changes: 6 additions & 0 deletions pages/docs/manuals/v1.2.0/canvas-tools/frame.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
+++
title = "Frame Tool"
tags = "Incomplete"
+++

TBD.
6 changes: 6 additions & 0 deletions pages/docs/manuals/v1.2.0/canvas-tools/reposition-layer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
+++
title = "Reposition Layer Tool"
tags = "Incomplete"
+++

TBD.
6 changes: 6 additions & 0 deletions pages/docs/manuals/v1.2.0/canvas-tools/symmetry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
+++
title = "Symmetry Tool"
tags = "Incomplete"
+++

TBD.
3 changes: 0 additions & 3 deletions pages/docs/manuals/v1.2.0/mypaint-preferences.jpg

This file was deleted.

3 changes: 3 additions & 0 deletions pages/docs/manuals/v1.2.0/painting/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
+++
title = "Painting"
+++
22 changes: 22 additions & 0 deletions pages/docs/manuals/v1.2.0/painting/brushes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
+++
title = "Brushes"
+++

# Shortcuts for brush settings
Brush shortcut keys are used to quickly save and restore brush settings. You can paint with one hand and change brushes
with the other, even in mid-stroke.

There are 10 slots available for brushes. By default, shortcuts are assigned to the keys `1` through `9`, and to the `0`
key. To save your current brush’s settings to one of these press `Ctrl+<number>`, for example `Ctrl+9`. To load stored
settings back, just press the number key on its own.

The brush shortcuts you assign are saved to your personal MyPaint settings, allowing you to use them in future sessions.

By default, pressing the `Q` key saves your current brush’s settings to the most recently used shortcut slot.

## Options
By default, brush shortcut keys remember the colour you had active when you saved the brush.

This behaviour can be turned off using the main menu:
- _Brush → Shortcut Keys → Brush Shortcut Keys Restore Colour_.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ title = "Inking Tool"
The Inking tool helps you draw controlled, smooth curved lines. You can use it for making sharp ink-like strokes over
the top of pencil sketch layers. It also works as a way of gaining some fine control of your painting strokes.

smooth Strokes than can be modified

## Capturing strokes
To use your current brush with extra inking guidance, click on the Inking Tool icon in the toolbar. This tool works best
with brush settings that emulate an ink pen. A brush whose width responds to your stylus pressure is ideal.
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
title = "Dockable Panels"
title = "Panels & Popups"
weight = 40
+++

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
11 changes: 0 additions & 11 deletions pages/docs/manuals/v1.2.0/tools/other-tools/index.md

This file was deleted.

12 changes: 7 additions & 5 deletions pages/docs/manuals/v1.2.0/ui/footer-bar/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,13 @@ The colour controls are clustered on the left side of the footer bar.

**Eyedropper** button
> Press <kbd>r</kbd>, or <kbd>alt</kbd>+<kbd>lmb</kbd>
- Pick a colour from the canvas. [Read more]({{< relref "../tools/colour-picker" >}})
- Pick a colour from the canvas. [Read more]({{< relref "../canvas-tools/colour-picker" >}})
**Current and Previous Colour** indicator and menu
> *Colour → Change Colour…*, or <kbd>C</kbd>
- A rectangle consisting of two sides (swatches). The left swatch shows the current brush colour, the right swatch shows
the previous colour.
- Clicking the left swatch (current colour) opens the colour selector popup. [Read more]({{< relref "../popups/colour-selector" >}})
- Clicking the left swatch (current colour) opens the colour selector popup. [Read more]({{< relref
"../panels-popups/colour-selector" >}})
- Clicking the right swatch (previous colour) reverts the brush to the previous colour.

**Edit Colour Details** button
Expand All @@ -34,7 +35,7 @@ the previous colour.
**Add Colour to Palette** button
> *Colour → Add Colour to Palette*
- Adds the current brush colour to the palette. The palette will open in a sidebar panel if it isn't already open. [Read
more]({{< relref "../panels/palette" >}})
more]({{< relref "../panels-popups/palette" >}})

# Brush controls
{{< img src="mypaint-footer-bar-brush.jpg" float="right" >}}
Expand All @@ -44,9 +45,10 @@ The brush controls are clustered on the right side of the footer bar.
**Current Brush** indicator and menu
> *Brush → Change Brush…*, or <kbd>B</kbd>
- A square containing the current brush icon.
- Clicking the icon opens the brush groups popup. [Read more]({{< relref "../popups/brush-groups" >}})
- Clicking the icon opens the brush groups popup. [Read more]({{< relref "../panels-popups/brush-groups" >}})

**Pick Stroke and Layer** button
> Press <kbd>W</kbd>
- Pick a brushstroke from the screen. If the stroke is on a different layer, MyPaint will switch to that layer.
Invisible and locked layers can't be picked. Not every kind of image has a strokemap. [Read more]({{< relref "../tools/stroke-layer-picker" >}})
Invisible and locked layers can't be picked. Not every kind of image has a strokemap. [Read more]({{< relref
"../canvas-tools/stroke-layer-picker" >}})
20 changes: 10 additions & 10 deletions pages/docs/manuals/v1.2.0/ui/main-toolbar/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,20 @@ The core set of tools cannot be hidden using the popup menu.
> *Brush → Paint Mode → Paint Mode: Eraser*, or <kbd>E</kbd>
- Toggles the Eraser paint/blend mode, which affects how the painting tools operate. [Read more]({{< relref
"../paint-modes#eraser" >}})
"../painting/paint-modes#eraser" >}})
- Other optional paint modes can be toggled on the toolbar, see [blend modes]({{< relref "#blend-modes" >}}).


**Freehand** (paintbrush)
> *Edit → Freehand*, or <kbd>P</kbd>
- The default painting tool; paint using the current brush and colour, without constraints. [Read more]({{< relref
"../tools/freehand" >}})
"../painting/freehand" >}})

**Pick Colour** (eyedropper)
> *Colour → Pick Colour*, or <kbd>R</kbd>
- Pick a new painting colour from the canvas. [Read more]({{< relref "../tools/colour-picker" >}})
- Pick a new painting colour from the canvas. [Read more]({{< relref "../canvas-tools/colour-picker" >}})

**Flood Fill** (paint bucket)
> *Edit → Flood Fill*
Expand Down Expand Up @@ -119,20 +119,20 @@ The toolbar items are only sensitive when you can undo or redo a step.

Paint blend modes change how your brush affects the layer you paint on. These toolbar buttons are optional, and you need
to use the [main toolbar's context menu]({{< relref "#main-toolbar-image" >}}) to make them visible. [Read more about
paint modes]({{< relref "../paint-modes" >}})
paint modes]({{< relref "../painting/paint-modes" >}})

**Lock Alpha** (padlock)
> *Brush → Paint Mode → Paint Mode: Lock Alpha*, or <kbd>Shift</kbd>+<kbd>L</kbd>
- Applying the brush doesn't change the transparency of the pixels you paint over (in the target layer). Use this for
further highlighting or shading objects that are painted on their own layer. [Read more]({{< relref
"../paint-modes#lock-alpha" >}})
"../painting/paint-modes#lock-alpha" >}})
- It's analogous to painting on layer groups which contain a mask, but a lot less fiddly.

**Colourize** (rainbow)
> *Brush → Paint Mode → Paint Mode: Colourize*, or <kbd>Shift</kbd>+<kbd>K</kbd>
- Painting applies the _hue_ (kind of colour) and _saturation_ (degree of colour) of your brush to whatever you paint on.
The _value_ (brightness or darkness) of what you paint on isn't affected. [Read more]({{< relref
"../paint-modes#colourize" >}})
"../painting/paint-modes#colourize" >}})
- This paint mode also doesn't change the transparency of what you paint on.
- Use this for adjusting colours, or _assigning_ colour to something you've painted in greyscale.

Expand All @@ -145,25 +145,25 @@ paint blend mode.

**Lines and Curves**
> *Edit → Lines and Curves*, or <kbd>K</kbd>
- Draw straight lines, hold down <kbd>Ctrl</kbd> to constrain the angle. [Read more]({{< relref "../tools/lines-and-curves" >}})
- Draw straight lines, hold down <kbd>Ctrl</kbd> to constrain the angle. [Read more]({{< relref "../painting/lines-and-curves" >}})
- When this tool is active, you can add curves to the last straight line you drew by pressing <kbd>Shift</kbd> and dragging.
- You can add up to two bends in each straight line.

**Connected Lines**
> *Edit → Connected Lines*, or <kbd>J</kbd>
- Draw a line from where you last painted. Constraints and curving work just like the Lines and Curves tool. [Read
more]({{< relref "../tools/connected-lines" >}})
more]({{< relref "../painting/connected-lines" >}})

**Ellipses and Circles**
> *Edit → Ellipses and Circles*, or <kbd>O</kbd>
- Draw circles and ellipses (stretched-out circles). [Read more]({{< relref "../tools/ellipses-and-circles" >}})
- Draw circles and ellipses (stretched-out circles). [Read more]({{< relref "../painting/ellipses-and-circles" >}})
- Holding down <kbd>Shift</kbd> allows you to change the angle of an ellipse.
- Holding down <kbd>Ctrl</kbd> constrains the aspect ratio (how stretched-out it looks).
- When you hold down <kbd>Ctrl</kbd>+<kbd>Shift</kbd> together, the angle is constrained instead.
**Inking**
> *Edit → Inking*
- Draw smooth strokes with your stylus or mouse. [Read more]({{< relref "../tools/inking" >}})
- Draw smooth strokes with your stylus or mouse. [Read more]({{< relref "../painting/inking" >}})
# Navigation
## View (Main)
Expand Down
12 changes: 6 additions & 6 deletions pages/docs/manuals/v1.2.0/ui/ui-toolbar/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,29 @@ way of changing the painting colour. [Read more]({{< relref "../colour/selectors
**Brush Groups Menu** (three brushes)
> *Brush → Brush Groups* or *Window → Brush Groups*
- The entries in this menu open different brush group dock-panels. Each dock-panel allows you to change the brush you
paint with. [Read more]({{< relref "../popups/brush-groups" >}})
paint with. [Read more]({{< relref "../panels-popups/brush-groups" >}})

**Tool Options Panel** (cog)
> *Edit → Show Tool Options Panel*
- This panel shows options for the current tool. [Read more]({{< relref "../panels/tool-options" >}})
- This panel shows options for the current tool. [Read more]({{< relref "../panels-popups/tool-options" >}})
**Layers Panel** (stack of paper)
> *Layer → Show Layers Panel*, or <kbd>L</kbd>
- This panel shows the layers tree (layer stack) for your working document. [Read more]({{< relref "../panels/layers" >}})
- This panel shows the layers tree (layer stack) for your working document. [Read more]({{< relref "../panels-popups/layers" >}})
**Scratchpad Panel** (clipboard)
> *Scratchpad → Show Scratchpad Panel*, or <kbd>Shift</kbd>+<kbd>S</kbd>
- This panel is a little area where you can work on thumbnail sketches, stash references, or make palettes. Scratchpads
can be saved and loaded independently of the main working doc. [Read more]({{< relref "../panels/scratchpad" >}})
can be saved and loaded independently of the main working doc. [Read more]({{< relref "../panels-popups/scratchpad" >}})

**Preview Panel** (camera viewfinder)
> *View → Preview*, or <kbd>Shift</kbd>+<kbd>P</kbd>
- The preview panel shows an overview of the entire document, and a viewfinder showing where you're zoomed to. [Read
more]({{< relref "../panels/preview" >}})
more]({{< relref "../panels-popups/preview" >}})

**History Panel** (clock)
> *Edit → Recent Brushes and Colours*
- The history panel shows a short timeline of recent brushes and colours. [Read more]({{< relref "../panels/history" >}})
- The history panel shows a short timeline of recent brushes and colours. [Read more]({{< relref "../panels-popups/history" >}})
{{< id "fullscreen-toggle" >}}**Fullscreen Mode Toggle**{{< /id >}}
> *View → Fullscreen*, or <kbd>F11</kbd>
Expand Down

0 comments on commit 2c5938b

Please sign in to comment.