Skip to content

Free, open-source 3D sculpting for Linux, macOS and Windows: dense meshes, remeshing, painting, built-in AI (image/text to 3D), Send to Unreal, game-ready LODs, Gaussian splats and OpenUSD.

Guide: start page, Windows notes (SmartScreen, Windows Ink, Mouse mode, DPI), troubleshooting quick answers; interface chapter leads with the SculptForge layout

islandmedcb99ee6c5424
diff --git a/docs/guide/first-sculpt.md b/docs/guide/first-sculpt.md
index 9f53fe0d..b1514544 100644
--- a/docs/guide/first-sculpt.md
+++ b/docs/guide/first-sculpt.md
@@ -58,7 +58,7 @@ are there. Every step can be undone with <kbd>Ctrl</kbd>+<kbd>Z</kbd>, so experi
> **Tip:** colour sticks to the surface, so it follows the shape when you sculpt it next.
-> **ZBrush-style layout:** the colour controls are in the **Color** palette on the palette bar; **Masking** is in
+> **ZBrush-style layout:** the colour controls are in the **Paint** menu on the palette bar; **Masking** is in
> the **Tool** palette.
## 4. Pull out the cap
@@ -175,7 +175,7 @@ are there. Every step can be undone with <kbd>Ctrl</kbd>+<kbd>Z</kbd>, so experi
![Render > Materials with PBR shading and Save Render](images/first-sculpt/12-material.jpg)
-> **ZBrush-style layout:** **PBR** and **Save Render** are in the **Material** palette.
+> **ZBrush-style layout:** **PBR** and **Save Render** are in **Render > Materials**.
Well done: that's a sculpt, painted and rendered.
diff --git a/docs/guide/generate-3d.md b/docs/guide/generate-3d.md
index 2c5e9de0..83d58cb4 100644
--- a/docs/guide/generate-3d.md
+++ b/docs/guide/generate-3d.md
@@ -223,7 +223,7 @@ run instantly. The same tools are in **Mesh > Generate 3D** as **Relief**, **Inf
Generated meshes are a starting point. A typical next pass:
-1. Check the size of the remeshed result in the title strip (Verts, Tris). If the detail is too soft, divide once more
+1. Check the size of the remeshed result in the bar along the top (the triangle count). If the detail is too soft, divide once more
(<kbd>Ctrl</kbd>+<kbd>D</kbd>), or generate again with a higher **Resolution**. **Tool > Remesh** has Quad Remesh
(first) and Voxel Remesh for another pass.
2. Turn on **X** symmetry if the subject is symmetrical, and sculpt the forms with Clay Block, Move and Sharp Crease ([Sculpting and brushes](sculpting.md)).
diff --git a/docs/guide/geometry.md b/docs/guide/geometry.md
index 450bcdda..60df6ae2 100644
--- a/docs/guide/geometry.md
+++ b/docs/guide/geometry.md
@@ -57,7 +57,7 @@ multiplies the triangle count by four and rounds off the shape slightly, like ZB
> levels back). Voxel Remesh, Decimate and Quad Remesh do the same. To add triangles only where you sculpt, use
> [Dynamic topology](dynamic-topology.md).
-> **Tip:** The title strip shows the vertex and triangle counts of the whole scene. A few million triangles sculpt
+> **Tip:** The bar along the top shows the triangle count of the whole scene. A few million triangles sculpt
> smoothly on a recent GPU; go up a level only when you need finer detail.
## Voxel remesh
@@ -189,7 +189,7 @@ Subdivide, remesh, Quad Remesh, decimate, Mirror And Weld, Mirror and delete hid
active Part. They can use a lot of memory on dense meshes, and undo keeps a full copy of the previous mesh for
each of them. Before a big change on a heavy sculpt:
-- **Snapshot** (**File > Save Snapshot**, title strip) keeps a timestamped copy of the scene without touching your project file; see
+- **Snapshot** (**File > Save Snapshot**) keeps a timestamped copy of the scene without touching your project file; see
[Projects](projects.md#snapshots).
- **Duplicate** the Part to keep the old version side by side.
diff --git a/docs/guide/glossary.md b/docs/guide/glossary.md
index 6b51dba7..d8eafedd 100644
--- a/docs/guide/glossary.md
+++ b/docs/guide/glossary.md
@@ -51,7 +51,7 @@ for what is planned.
| Polypaint layers | **Tool > Paint Layers**: Photoshop-style colour layers with blend modes. See [Paint layers](vertex-paint.md#paint-layers) |
| Project All (ProjectAll) | **Tool > Parts > Project > Project All** (`project_all`), with Dist, Mean and PA Blur; respects the mask. See [Quad retopology](retopology.md#project-all) |
| Projection Master | Not yet. **Mesh > Generate 3D > Stamp** projects an image onto the model from the view |
-| QuickSave | **File > Save Snapshot** (title strip **Snapshot**, <kbd>9</kbd> in the ZBrush-style keys); the last 10 are kept in the Library **Snapshots** tab. See [Projects](projects.md#snapshots) |
+| QuickSave | **File > Save Snapshot** (<kbd>9</kbd> in the ZBrush-style keys); the last 10 are kept in the Library **Snapshots** tab. See [Projects](projects.md#snapshots) |
| Rgb | **Rgb** on the top shelf (paint while sculpting) |
| Rgb Intensity, Z Intensity, Focal Shift | Same keys: **RGB Intensity** (<kbd>I</kbd>), **Intensity** (<kbd>U</kbd>), **Falloff** (<kbd>O</kbd>) in **Sculpt > Draw & Tablet** and the Quick Menu |
| Sculptris Pro, dynamic topology | **Dynamic** on the top shelf, with **Detail** (`dyntopo`). See [Dynamic topology](dynamic-topology.md) |
diff --git a/docs/guide/index.md b/docs/guide/index.md
index 7de5946e..0cb40ba0 100644
--- a/docs/guide/index.md
+++ b/docs/guide/index.md
@@ -1,14 +1,24 @@
# SculptForge User Guide
-This guide explains every part of SculptForge, the free, open-source sculpting app for VFX, animation and games:
-how the interface is organised, how to sculpt, mask, paint (on vertices or textures) and manage Parts, how to generate models with AI,
-and how to get your work into a game engine, a film pipeline, Blender or ZBrush. It is written for SculptForge
-0.4.
-
-You can read it inside SculptForge (**Help > User Guide**, or <kbd>Shift</kbd>+<kbd>F1</kbd>) or on the
-[SculptForge website](https://sculptforge.app/guide/). New to sculpting? Make
-[your first sculpt in 10 minutes](first-sculpt.md). If you're coming from ZBrush, start with
-[Coming from ZBrush](coming-from-zbrush.md) and keep the [Glossary](glossary.md) at hand: it has SculptForge's names for ZBrush terms and the ZBrush-style keys.
+SculptForge is a free, open-source sculpting app for VFX, animation and games. This guide covers everything in
+it: the interface, sculpting, masking, painting, Parts, AI generation, and getting your work into a game engine,
+a film pipeline, Blender or ZBrush. It is written for SculptForge 0.10.
+
+Read it inside SculptForge (**Help > User Guide**, or <kbd>Shift</kbd>+<kbd>F1</kbd>) or on the
+[SculptForge website](https://sculptforge.app/guide/).
+
+## Start here
+
+| You want to | Read |
+|---|---|
+| Install it | [Install SculptForge](installing.md): downloads for Windows, macOS and Linux |
+| Set it up on Windows | [The Windows notes](installing.md#windows): SmartScreen, pen tablets (Windows Ink, Mouse mode), screen scaling |
+| Make your first sculpt | [Your first sculpt in 10 minutes](first-sculpt.md): a mushroom house from the default sphere |
+| Find your way around | [The interface](interface.md): the menus **File, Edit, Sculpt, Paint, Mesh, View, Render, Help**, the shelves and the Tool panel; [Navigating the view](navigation.md) |
+| Learn the brushes | [Sculpting and brushes](sculpting.md) |
+| Switch from ZBrush | [Coming from ZBrush](coming-from-zbrush.md) (the ZBrush-style layout and keys) and the [Glossary](glossary.md) |
+| Switch from Blender | [Blender keys](shortcuts.md#blender-keys), and [Working with Blender](blender.md) for the bridge add-on |
+| Fix a problem | [Troubleshooting](troubleshooting.md) |
![The SculptForge window with its main regions labelled](images/interface-overview.jpg)
@@ -18,7 +28,7 @@ You can read it inside SculptForge (**Help > User Guide**, or <kbd>Shift</kbd>+<
2. [Your first sculpt in 10 minutes](first-sculpt.md)
3. [What's new](whats-new.md)
4. [Coming from ZBrush](coming-from-zbrush.md)
-5. [Installing SculptForge](installing.md)
+5. [Install SculptForge on Windows, macOS and Linux](installing.md)
6. [The interface](interface.md)
7. [Navigating the view](navigation.md)
@@ -70,7 +80,7 @@ You can read it inside SculptForge (**Help > User Guide**, or <kbd>Shift</kbd>+<
42. [Keyboard and mouse](shortcuts.md)
43. [Performance and big meshes](performance.md)
-44. [Troubleshooting and FAQ](troubleshooting.md)
+44. [Troubleshooting: tablets, display, crashes and FAQ](troubleshooting.md)
45. [Glossary](glossary.md)
## Getting help
diff --git a/docs/guide/installing.md b/docs/guide/installing.md
index 71e5d7d5..cada7c99 100644
--- a/docs/guide/installing.md
+++ b/docs/guide/installing.md
@@ -1,4 +1,4 @@
-# Installing SculptForge
+# Install SculptForge on Windows, macOS and Linux
This chapter covers what SculptForge needs, which package to download for your system, what to expect the
first time you open it, and how to build it from source.
@@ -98,6 +98,56 @@ set up. Only the runtime comes from Flathub: SculptForge itself is not published
To build the Flatpak yourself from the source, install `flatpak` and `flatpak-builder` and run
`packaging/flatpak/build.sh`; it writes `SculptForge-<version>-<arch>.flatpak`.
+## Windows
+
+Windows is where most SculptForge artists work. The notes below cover the first start, pen tablets and screen
+scaling.
+
+### SmartScreen
+
+The builds are not code-signed yet, so the first start may show "Windows protected your PC".
+
+1. Click **More info**.
+2. Click **Run anyway**.
+
+To confirm the file is the one we published, compare it with `SHA256SUMS.txt` on the release page.
+
+### Pen tablets: Windows Ink and Wintab
+
+SculptForge reads the pen through **Windows Ink**, the pen input built into Windows 10 and 11. When Windows Ink is
+off in the tablet driver, it takes the pressure from the driver's **Wintab** instead. Either way works; Windows Ink
+also gives the eraser end and tilt.
+
+- **Wacom**: Wacom Tablet Properties > **Mapping** > **Use Windows Ink**. You can set it for SculptForge only by
+ adding it as an application in Wacom Tablet Properties.
+- **Huion, XP-Pen, Gaomon, Ugee**: **Windows Ink** (sometimes "Windows Ink mode") in the driver's settings.
+- **Pen displays and Surface-type pens** use Windows Ink already.
+
+Check it in **Edit > Preferences > Tablet**: it shows "Pressure: on" once the pen has pressed, or "Pressure: not
+detected". A tablet plugged in while SculptForge runs works straight away. If pressure is missing, switch the
+driver's Windows Ink option and bring the pen back to the tablet.
+
+**Mouse mode.** Most drivers map the pen to the screen (pen mode): where the pen touches is where the cursor goes.
+If you set the driver to **Mouse** (relative) mode, the pen moves the cursor by how far it moves, like a mouse.
+Turn on **Edit > Preferences > Tablet > Mouse mode (relative)** to match it, or the cursor jumps when you put the
+pen down.
+
+Pen side buttons work as the driver sets them; a button set to **Right click** opens the
+[Quick Menu](sculpting.md#the-quick-menu). More in [Troubleshooting: pen tablets](troubleshooting.md#pen-tablets).
+
+### Screen scaling (DPI)
+
+SculptForge follows the **Scale** in Windows' **Settings > System > Display**, so text and buttons have the
+same size as in other apps at 125%, 150% or 200%. To make the interface larger or smaller than that, choose a
+size in **Edit > Preferences > Interface > UI scale** (**Automatic** follows Windows).
+
+### Where files go
+
+- Settings, brushes and the log: `%APPDATA%\SculptForge\SculptForge` (**Help > Open log folder** opens it).
+- Your library (projects, snapshots, alphas, Lit Spheres): `Documents\SculptForge`.
+
+See [Where settings live](troubleshooting.md#where-settings-live) for every file.
+
## Opening SculptForge for the first time
The builds are not code-signed yet, so your operating system may warn you the first time.
@@ -115,10 +165,7 @@ Privacy & Security** and click **Open Anyway** next to the message about SculptF
### Windows: SmartScreen
-Windows may show "Windows protected your PC".
-
-1. Click **More info**.
-2. Click **Run anyway**.
+Windows may show "Windows protected your PC". See [Windows](#windows) below.
### Linux
diff --git a/docs/guide/interface.md b/docs/guide/interface.md
index 1284a5c2..a1bde345 100644
--- a/docs/guide/interface.md
+++ b/docs/guide/interface.md
@@ -1,11 +1,11 @@
# The interface
-SculptForge's window has a canvas in the middle, shelves of the most-used controls around it, palettes that
-hold every function, and trays at the sides where palettes can stay open. It comes in two layouts: the
-**SculptForge layout** (the default since 0.10.7), with menus by task, and the **ZBrush-style layout**, with a bar
-of alphabetical palettes. Both hold the same palettes; see [Looks and layouts](#looks-and-layouts) to switch. This
+SculptForge's window has the 3D view (the canvas) in the middle, shelves of the most-used controls around it,
+menus along the top that hold every function, and trays at the sides where panels can stay open. It comes in two
+layouts: the **SculptForge layout** (the default), with menus by task, and the **ZBrush-style layout**, with a bar
+of alphabetical palettes. Both hold the same controls; see [Looks and layouts](#looks-and-layouts) to switch. This
chapter walks through each region, the pop-up pickers, the Library, the built-in help, and how to rearrange the
-interface and keep your changes. The pictures show the ZBrush-style layout.
+interface and keep your changes. The pictures show the default look and layout.
![The SculptForge window with its main regions labelled](images/interface-overview.jpg)
@@ -13,17 +13,20 @@ interface and keep your changes. The pictures show the ZBrush-style layout.
| Region | Where | What it holds |
|---|---|---|
-| Title strip | Top edge | Document name, scene statistics, status messages, Snapshot, layout presets, Menus, Search |
-| Palette bar | Under the title strip | The 16 palettes, which hold every function |
-| Top shelf | Above the canvas | Library, Sculpt/Paint, Add/Sub, Rgb, Draw Size, Intensity, symmetry, pressure |
-| Left shelf | Left of the canvas | Brush, Stroke, Alpha and Material tiles, the colour picker |
-| Canvas | Centre | The 3D view; strokes and navigation start only here |
+| Menu bar | Top edge | The menus **File, Edit, Sculpt, Paint, Mesh, View, Render, Help**; the status message; mode, brush, file name, triangles and frame rate; layout presets **1 2 3**; **Search** |
+| Top shelf | Under the menu bar | Sculpt/Paint, Draw/Move/Scale/Rotate, Add/Sub, Rgb, Draw Size, Intensity, Dynamic, symmetry |
+| Left shelf | Left of the canvas | Brush, Stroke, Alpha and Material tiles, the colour picker, Fill |
+| Canvas | Centre | The 3D view, with the Sculpt Timeline along its top; strokes and navigation start only here |
| Right shelf | Right of the canvas | Undo and Redo, Frame, Move, Zoom and Rotate, display toggles, Solo |
+| Right tray | Far right | The **Tool** panel: the active Part, Parts, Layers, Geometry, Masking and more |
| Bottom shelf | Below the canvas | Your quick brushes |
-| Trays | Far left and far right | Palettes you keep open; the right tray holds the Tool palette by default |
Press <kbd>Tab</kbd> to hide the shelves and trays for a bigger canvas, and again to bring them back. The
-palette bar stays, so every function is still one click away.
+menu bar stays, so every function is still one click away.
+
+The **ZBrush-style layout** has a title strip and a bar of 16 alphabetical palettes instead of the menu bar, and
+a two-row top shelf; the rest is the same. See [The title strip](#the-title-strip-zbrush-style-layout) and
+[Palettes](#menus-and-palettes).
## Looks and layouts
@@ -40,7 +43,8 @@ models, brushes or shortcuts.
the Tool palette, and Generate 3D), **View** (Display), **Render** (Materials, Gaussian Splats) and **Help**. Pin
a section to a tray as you would a palette. Brush Lab, Front and the pressure options are under **Sculpt**, the
Library and the console under **View > Display**, and <kbd>F3</kbd> finds everything.
-- **ZBrush-style**: the alphabetical palette bar and the two-row top shelf described in the rest of this chapter.
+- **ZBrush-style**: the alphabetical palette bar under a title strip, and a two-row top shelf (see [The title
+ strip](#the-title-strip-zbrush-style-layout) and [Top shelf](#top-shelf)).
Coming from ZBrush? The welcome shown at the first start has **Coming from ZBrush? Use the ZBrush-style layout**,
one click.
@@ -68,10 +72,27 @@ changes nothing. Either way, Edit > Preferences > Interface > Look changes it la
In scripts: `ui_look look=forge scheme=tokyo_night layout=sculptforge` (or `look=classic layout=zbrush`).
-## The title strip
+## The menu bar
From left to right:
+- **SculptForge** and the task menus **File, Edit, Sculpt, Paint, Mesh, View, Render, Help**. Click a menu to
+ open it: its sections are listed down the left (for example **Sculpt** has Brush, Draw & Tablet, Stroke,
+ Alpha and Symmetry & Gizmo) and the chosen one opens beside them. See [Menus and palettes](#menus-and-palettes).
+- **The status message**: the result of the last command or action. Errors show in red for a few seconds.
+- **Mode** (SCULPT, PAINT, MOVE...), the active **brush**, the **file name** (`*` after it means unsaved
+ changes), the **triangle** count of the scene and the **frame rate**. On a narrow window the least important
+ of these are left out.
+- **1**, **2**, **3**: the layout presets (see [Layout presets](#layout-presets)).
+- **Search** (<kbd>F3</kbd>): opens the [command palette](#the-command-palette).
+- **Minimize** and **Close** at the far right. Close asks to save changes first, as
+ <kbd>Ctrl</kbd>+<kbd>Q</kbd> does.
+
+## The title strip (ZBrush-style layout)
+
+In the ZBrush-style layout the top edge is a title strip instead, with the palette bar under it. From left to
+right:
+
- **SculptForge** and the **document name** ("Untitled" until you save). A `*` after the name means there are
unsaved changes; click the name to save (<kbd>Ctrl</kbd>+<kbd>S</kbd>).
- **Scene statistics**: vertices and triangles across all Parts, the active Part and its position
@@ -87,35 +108,44 @@ From left to right:
- **Minimize** and **Close** at the far right. Close asks to save changes first, as
<kbd>Ctrl</kbd>+<kbd>Q</kbd> does.
-## Palettes
+## Menus and palettes
-Every function in SculptForge lives in one of 16 palettes. Click a palette's name in the palette bar and it
-drops down under the name. Click another name to switch, or press <kbd>Esc</kbd> or click outside to close it.
+Every function in SculptForge lives in one of 16 palettes. In the SculptForge layout each palette is a section
+of one task menu (the table below); in the ZBrush-style layout the palettes sit side by side in the palette bar.
+Either way, click the name and the palette drops down under it. Click another name to switch, or press
+<kbd>Esc</kbd> or click outside to close it.
-![**Sculpt > Stroke** open as a drop-down from the palette bar](images/palette-dropdown.jpg)
+![The Sculpt menu open on its Stroke section](images/palette-dropdown.jpg)
-The palette bar lists **File** and **Edit** first and **Help** last, where other desktop applications put
-them, and the rest in alphabetical order. If you prefer ZBrush's strict A to Z order, turn on **Preferences >
-Interface > Palettes strictly A-Z (ZBrush order)**.
+Menu paths in this guide name what you click in the SculptForge layout: **Edit > Preferences > Input** is the
+**Edit** menu, its **Preferences** section, then the **Input** sub-palette. **File** and **Edit** have a section
+of the same name, which paths leave out (**File > Save**). Paths starting with **Tool** are in the Tool panel in
+the right tray, in both layouts (it is also **Mesh > Parts & Geometry**). In the ZBrush-style layout, drop the
+menu: **Edit > Preferences > Input** is **Input** in the palette named **Preferences**, and **Sculpt > Stroke**
+is the palette named **Stroke**.
-| Palette | What's in it |
-|---|---|
-| **File** | New Sphere, New Plane, Open, Open Recent, Save, Save As, autosave interval, Import and every export (OBJ, GLB, LOD chain, USD/USDZ, FBX for Unreal, Send to Unreal, splats), Send to ZBrush, Quit |
-| **Edit** | Undo and Redo (with the name of the step), Paste brush |
-| **Alpha** | The brush alphas: Round, Square, Noise and twelve patterns (Pores, Cracks, Scales...), images from your library, Load image, Invert loaded image |
-| **Brush** | AI Brush (Brush Lab), Community brushes, Paste brush, your custom brushes, Front faces only, Invert (Alt), the recipe editor for a custom brush, and every brush as a thumbnail grid with a filter |
-| **Color** | The Paint brush, RGB while sculpting, the paint colour and swatches, Fill, Fill masked, Cavity, Clear, Show vertex paint |
-| **Draw** | Draw Size, Intensity, RGB Intensity, Falloff, Sculpt/Paint, Add/Sub, Rgb, Front, and the tablet options (Pressure > strength, Pressure > size) with a pen readout |
-| **Generate** | Generate 3D (image or text to 3D), Relief, Inflate and Stamp from an image, and the AI brush provider settings |
-| **Material** | The Lit Sphere materials (Soft Clay, the default, first), your own (**Load Lit Sphere...**) and Studio, Base colour, Smooth / Flat shading for the scene and the active Part |
-| **Preferences** | Config, Interface, Input, Hotkeys, Display, Library, Tablet, Performance, Updates and Autosave sub-palettes (see [Customizing the interface](#customizing-the-interface)) |
-| **Render** | Wireframe, Show Mesh, Show Vertex Paint, Show Mask, Show Face Groups, Show Splats, Background, Frame, Fullscreen |
-| **Script** | Console, Run script file, Copy session as script, Clear console |
-| **Splats** | Gaussian splat tools: show, flip, turn, fit, clean floaters, Make sculptable, sculpt to splats, save, clear |
-| **Stroke** | The stroke types (Dots, Drag Stamp, Spray, Lazy Stroke) and their settings |
-| **Tool** | The active Part with Open, Save and Import, and the Part, Layers, Paint Layers, Geometry, Remesh, Deformation, Masking, Face Groups, Visibility, Export and Display sub-palettes |
-| **Transform** | Draw, Move, Scale and Rotate (the [Gizmo](gizmo.md) with its pivot, axes, options and numeric entry), Symmetry X, Y and Z, Frame, Solo, Wire |
-| **Help** | Controls, User Guide, What's New, Command palette, Website & documentation, Report a problem, Support SculptForge..., About SculptForge |
+In the ZBrush-style layout, the palette bar lists **File** and **Edit** first and **Help** last, where other
+desktop applications put them, and the rest in alphabetical order. If you prefer ZBrush's strict A to Z order,
+turn on **Edit > Preferences > Interface > Palettes strictly A-Z (ZBrush order)**.
+
+| Palette | In the SculptForge layout | What's in it |
+|---|---|---|
+| **File** | File | New Sphere, New Plane, Open, Open Recent, Save, Save As, autosave interval, Import and every export (OBJ, GLB, LOD chain, USD/USDZ, FBX for Unreal, Send to Unreal, splats), Send to ZBrush, Quit |
+| **Edit** | Edit | Undo and Redo (with the name of the step), Paste brush |
+| **Alpha** | Sculpt > Alpha | The brush alphas: Round, Square, Noise and twelve patterns (Pores, Cracks, Scales...), images from your library, Load image, Invert loaded image |
+| **Brush** | Sculpt > Brush | AI Brush (Brush Lab), Community brushes, Paste brush, your custom brushes, Front faces only, Invert (Alt), the recipe editor for a custom brush, and every brush as a thumbnail grid with a filter |
+| **Color** | Paint | The Paint brush, RGB while sculpting, the paint colour and swatches, Fill, Fill masked, Cavity, Clear, Show vertex paint |
+| **Draw** | Sculpt > Draw & Tablet | Draw Size, Intensity, RGB Intensity, Falloff, Sculpt/Paint, Add/Sub, Rgb, Front, and the tablet options (Pressure > strength, Pressure > size) with a pen readout |
+| **Generate** | Mesh > Generate 3D | Generate 3D (image or text to 3D), Relief, Inflate and Stamp from an image, and the AI brush provider settings |
+| **Material** | Render > Materials | The Lit Sphere materials (Soft Clay, the default, first), your own (**Load Lit Sphere...**) and Studio, Base colour, Smooth / Flat shading for the scene and the active Part |
+| **Preferences** | Edit > Preferences | Config, Interface, Input, Hotkeys, Display, Library, Tablet, Performance, Updates and Autosave sub-palettes (see [Customizing the interface](#customizing-the-interface)) |
+| **Render** | View | Wireframe, Show Mesh, Show Vertex Paint, Show Mask, Show Face Groups, Show Splats, Background, Frame, Fullscreen |
+| **Script** | File > Script | Console, Run script file, Copy session as script, Clear console |
+| **Splats** | Render > Gaussian Splats | Gaussian splat tools: show, flip, turn, fit, clean floaters, Make sculptable, sculpt to splats, save, clear |
+| **Stroke** | Sculpt > Stroke | The stroke types (Dots, Drag Stamp, Spray, Lazy Stroke) and their settings |
+| **Tool** | Mesh > Parts & Geometry, and the right tray | The active Part with Open, Save and Import, and the Part, Layers, Paint Layers, Geometry, Remesh, Deformation, Masking, Face Groups, Visibility, Export and Display sub-palettes |
+| **Transform** | Sculpt > Symmetry & Gizmo | Draw, Move, Scale and Rotate (the [Gizmo](gizmo.md) with its pivot, axes, options and numeric entry), Symmetry X, Y and Z, Frame, Solo, Wire |
+| **Help** | Help | Controls, User Guide, What's New, Command palette, Website & documentation, Report a problem, Support SculptForge..., About SculptForge |
### Sub-palettes
@@ -132,12 +162,13 @@ others, or turn off **Edit > Preferences > Interface > One sub-palette open**.
The trays are columns at the far left and far right of the window where palettes stay open while you work. The
right tray is open by default and holds the **Tool** palette; the left tray starts closed and empty.
-- **Put a palette in a tray**: open it from the palette bar and click the tray icon at the left of its header.
+- **Put a palette in a tray**: open it from its menu (or the palette bar) and click the tray icon at the left of its header.
It goes into the right tray; **Shift**+click the icon to put it in the left tray. You can also drag the icon
onto a tray.
-- **Take it out again**: click the tray icon in its header inside the tray. The palette returns to the bar.
+- **Take it out again**: click the tray icon in its header inside the tray. The palette returns to its menu.
- **Collapse it in place**: click its title (or the arrow at the right of the header).
-- **Find it**: a palette that is in a tray shows its name in orange in the palette bar. Clicking the name
+- **Find it**: a palette that is in a tray shows a tray icon beside its name in its menu (in the palette bar of
+ the ZBrush-style layout, its name in the accent colour). Clicking the name
scrolls the tray to the palette and flashes its header.
- **Open or close a tray**: click its divider, the thin strip with a grip between the tray and the shelves.
**Drag** the divider to make the tray wider or narrower (240 to 480 pixels).
@@ -161,25 +192,22 @@ interface](#customizing-the-interface) to add items.
### Top shelf
-First row:
-
-- **Library** (<kbd>,</kbd>): shows or hides the [Library](#the-library).
- **Sculpt** / **Paint** (<kbd>P</kbd>): brushes change the shape, or paint colour without sculpting.
+- **Draw**, **Move**, **Scale**, **Rotate** (<kbd>Q</kbd> <kbd>W</kbd> <kbd>E</kbd> <kbd>R</kbd>): sculpt, or
+ move, scale and rotate the Part with the [Gizmo](gizmo.md).
- **Add** / **Sub**: brushes add to or subtract from the surface. Holding <kbd>Alt</kbd> flips it for one
stroke.
- **Rgb**: sculpt brushes paint the colour at the same time.
- **Draw Size**: the brush radius in screen pixels (2 to 800).
- **Intensity**: how strongly each dab changes the surface (1 to 100). While <kbd>Shift</kbd> is held it shows
Smooth's own value.
+- **Dynamic**: [dynamic topology](dynamic-topology.md), with its **Detail** slider while it is on.
+- **X**, **Y**, **Z**: symmetry across each axis (<kbd>X</kbd> toggles X); **R** is radial symmetry.
-Second row:
-
-- **AI Brush**: opens Brush Lab (see [Brush Lab and sharing brushes](brush-lab.md)).
-- **Front**: front faces only, so brushes leave the far side of thin parts alone.
-- **X**, **Y**, **Z**: symmetry across each axis (<kbd>X</kbd> toggles X).
-- **Pressure > Strength** and **Pressure > Size**: what pen pressure controls.
-- **ActiveTris / TotalTris** at the right: the triangles you can see and sculpt (visible Parts, hidden
- parts left out) and the total in the scene.
+The ZBrush-style layout's top shelf has two rows: **Library** (<kbd>,</kbd>), Sculpt/Paint, Add/Sub, Rgb, Draw
+Size and Intensity on the first; **AI Brush**, **Front**, symmetry, **Pressure > Strength** and **Pressure >
+Size**, and the **ActiveTris / TotalTris** count on the second. In the SculptForge layout these are in the
+**Sculpt** menu (AI Brush, Front, pressure) and **View** menu (Library).
Draw Size and Intensity are sliders with the label inside, as in ZBrush: drag along them, or
<kbd>Ctrl</kbd>+click to type a value.
@@ -211,14 +239,14 @@ unmasked area with the main colour.
- **Solo**: shows only the active Part (available with two or more Parts).
- **Splats**: shows or hides a Gaussian splat capture (only shown while one is loaded).
-Options that are on are a lighter grey with a thin orange line; orange fill marks only the current tool or mode. See [Navigating the view](navigation.md) for the camera.
+Options that are on are highlighted; a filled button in the accent colour marks only the current tool or mode. See [Navigating the view](navigation.md) for the camera.
### Bottom shelf
A row of quick brushes: Standard, Clay, Clay Block, Sharp Crease, Move, Smooth, Inflate, Pinch, Flatten,
Crease, Trim, Tendril, Layer, Nudge and Paint. The small digit in a tile's corner is its shortcut
(<kbd>1</kbd> to <kbd>9</kbd> and <kbd>0</kbd> select the first ten built-in brushes, <kbd>P</kbd> is Paint).
-The active brush has an orange outline.
+The active brush is outlined in the accent colour.
![The bottom shelf of quick brushes](images/bottom-shelf.jpg)
@@ -368,7 +396,7 @@ The guide is built into SculptForge, so it works offline and always matches your
## The command palette
-Press <kbd>F3</kbd> (or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>, or click **Search** in the title strip)
+Press <kbd>F3</kbd> (or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>, or click **Search** at the top right)
to find any action or command by name and run it. It opens at the top centre of the canvas.
![The command palette searching for subdivide](images/command-palette.jpg)
@@ -454,10 +482,10 @@ tab) doesn't count as a layout change.
### Layout presets
-The **1**, **2** and **3** buttons in the title strip (also in **Edit > Preferences > Config**) switch between three
-layouts:
+The **1**, **2** and **3** buttons at the top right (also in **Edit > Preferences > Config**) switch between three
+arrangements of the current layout:
-1. **Standard**: the Tool palette in the right tray and shelves around the canvas.
+1. **Standard**: the Tool panel in the right tray and shelves around the canvas.
2. **Sculpt**: both trays closed, for the largest canvas.
3. **Wide**: Brush, Stroke and Alpha in the left tray, Tool and Material in the right tray.
@@ -478,13 +506,13 @@ Config keeps it.
| **Tooltip delay** | 0.5 s | How long to point at an icon-only button before its name appears |
| **One sub-palette open** | On | Opening a sub-palette closes the others in that palette |
| **Auto collapse left tray** / **right tray** | On / Off | Collapse other palettes in the tray when one wouldn't fit |
-| **Palettes strictly A-Z (ZBrush order)** | Off | Strict alphabetical palette bar instead of File and Edit first, Help last |
+| **Palettes strictly A-Z (ZBrush order)** | Off | ZBrush-style layout: strict alphabetical palette bar instead of File and Edit first, Help last |
| **Left-handed layout** | Off | Mirrors the shelves and trays: tools on the right, navigation on the left |
| **UI scale** | Automatic | Size of text and controls (100% to 200%); takes effect at the next start |
| **Camera notch** | Automatic | Keeps the interface below a laptop's camera notch in fullscreen (see below) |
**Language** changes the interface at once, without a restart; Store Config keeps it for the next start. In
-**Español** the palette bar, the palettes, the shelves, the Library, the command palette and the Ctrl-help titles
+**Español** the menus, the palettes, the shelves, the Library, the command palette and the Ctrl-help titles
are in Spanish, while the names of tools and brushes stay in English, as Spanish-speaking sculptors use them (Parts,
Quad Remesh, Forge Spheres, Library, Lit Sphere, Clay Block, Add). The command palette finds a command by its Spanish or its
English name. Anything not translated yet (most Ctrl-help descriptions, this guide) shows in English. Scripts and
@@ -524,11 +552,11 @@ choice for the next session, and each project keeps the background it was saved
![**Edit > Preferences** with the Config and Interface sub-palettes](images/preferences.jpg)
-### Fullscreen, the palette bar and the camera notch
+### Fullscreen, hiding panels and the camera notch
- <kbd>F11</kbd> (or **View > Fullscreen**) fills the screen with SculptForge; press it again to go back to
a window. `sculptforge --fullscreen` starts that way.
-- **Menus** in the title strip hides the palette bar; click it again to bring it back.
+- In the ZBrush-style layout, **Menus** in the title strip hides the palette bar; click it again to bring it back.
- <kbd>Tab</kbd> hides the shelves and trays.
- On MacBooks with a camera notch, SculptForge keeps the interface below the notch when it fills the screen
and fills the band beside the notch with the shell colour. **Automatic** asks macOS for the safe area (on
diff --git a/docs/guide/layers.md b/docs/guide/layers.md
index b4efb26b..e7e4bd52 100644
--- a/docs/guide/layers.md
+++ b/docs/guide/layers.md
@@ -35,7 +35,8 @@ From top to bottom:
(delete) and a **weight** slider from 0 to 1.
- A name field and **+ Add** at the bottom.
-The title strip shows the active layer (`Layer Smile`, or `Layer Base`).
+The Layers list highlights the active layer; in the ZBrush-style layout the title strip also shows it (`Layer Smile`,
+or `Layer Base`).
## Add a layer and sculpt into it
diff --git a/docs/guide/parts.md b/docs/guide/parts.md
index 326adbf2..7684d896 100644
--- a/docs/guide/parts.md
+++ b/docs/guide/parts.md
@@ -14,7 +14,8 @@ hiding, reordering, merging and splitting Parts, and how they travel through fil
Part, and switching Parts doesn't lose the history of the others.
- Adding, deleting, reordering, merging and splitting Parts are **not undoable**, as in ZBrush. Merges and
deletes ask for confirmation first.
-- The title strip shows the active Part and its place in the list, for example `Part Helmet (2/5)`.
+- The Parts list highlights the active Part. In the ZBrush-style layout the title strip also shows it and its place
+ in the list, for example `Part Helmet (2/5)`.
> **ZBrush:** Parts work the way you expect: one active Part, the rest dimmed, Alt+click in the viewport to
> switch. There is no folder grouping of Parts yet.
diff --git a/docs/guide/projects.md b/docs/guide/projects.md
index 1e9ce4a5..5493a63f 100644
--- a/docs/guide/projects.md
+++ b/docs/guide/projects.md
@@ -31,9 +31,9 @@ them is an export, not a save. See [Exporting](exporting.md).
- **File > Save** (<kbd>Ctrl</kbd>+<kbd>S</kbd>) saves to the current project. The first time, it asks for a file
name.
- **File > Save As...** (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd>) saves under a new name.
-- Clicking the document name in the title strip also saves.
+- In the ZBrush-style layout, clicking the document name in the title strip also saves.
-The title strip shows the document name with `*` after it while there are unsaved changes, and the window title
+The bar along the top shows the file name with `*` after it while there are unsaved changes, and the window title
starts with `*`. Any edit in any Part counts, as do splat edits and layer weight changes.
If you opened a model file (an OBJ, say) rather than a project, **Save** asks where to save a new `.sfproj`; the
@@ -115,7 +115,7 @@ The autosave also appears first in the Library **Snapshots** tab while it exists
## Snapshots
-**File > Save Snapshot** (also the **Snapshot** button in the title strip) saves a timestamped copy of the whole
+**File > Save Snapshot** (also the **Snapshot** button in the ZBrush-style layout's title strip) saves a timestamped copy of the whole
scene (ZBrush users: QuickSave). Your project file, its name and its unsaved state are not changed, so a snapshot
is safe to take before any risky step.
diff --git a/docs/guide/scripting.md b/docs/guide/scripting.md
index 5e4e5dcd..44aabc9d 100644
--- a/docs/guide/scripting.md
+++ b/docs/guide/scripting.md
@@ -65,7 +65,7 @@ The console buttons (also in **File > Script**):
## The command palette
-Press <kbd>F3</kbd> (or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>, or click **Search** in the title strip)
+Press <kbd>F3</kbd> (or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>, or click **Search** at the top right of the window)
to search every command, brush and setting by name. <kbd>Enter</kbd> runs the highlighted entry;
<kbd>Shift</kbd>+<kbd>Enter</kbd> opens it in the console so you can add parameters first. Commands that need
parameters always open in the console. With an empty search, the palette lists what you used recently. See
diff --git a/docs/guide/sculpting.md b/docs/guide/sculpting.md
index 54430f28..586a7428 100644
--- a/docs/guide/sculpting.md
+++ b/docs/guide/sculpting.md
@@ -88,7 +88,7 @@ like built-in ones. Their thumbnails carry a small sparkle when you put them on
You can choose a brush in several places:
-- **Bottom shelf**: click a tile. The active brush has an orange outline and the number key is shown in the
+- **Bottom shelf**: click a tile. The active brush is outlined in the accent colour and the number key is shown in the
corner of each tile.
- **Number keys**: <kbd>1</kbd> to <kbd>9</kbd> and <kbd>0</kbd> pick the first ten built-in brushes (see the
table above); <kbd>P</kbd> toggles the Paint brush.
@@ -107,7 +107,7 @@ the `Brushes` folder of your Library library that aren't loaded yet; picking one
The picker works the ZBrush way, by typing letters:
1. Press <kbd>B</kbd>.
-2. Type the first letter of the brush. Only brushes starting with that letter stay, and each shows an orange
+2. Type the first letter of the brush. Only brushes starting with that letter stay, and each shows a highlighted
key badge: the next letter that tells it apart from the others.
3. Press the letter on the badge to pick that brush. For example <kbd>B</kbd>, <kbd>S</kbd>, <kbd>T</kbd>
picks Standard, and with the brushes that ship, <kbd>B</kbd>, <kbd>C</kbd>, <kbd>L</kbd>
@@ -383,7 +383,7 @@ From a script: `brush_set_alpha name=square`, or `brush_set_alpha path=bark.png
### Alpha options
-Under the preview in the **Alpha** palette:
+Under the preview in **Sculpt > Alpha**:
| Option | What it does |
|---|---|
diff --git a/docs/guide/shortcuts.md b/docs/guide/shortcuts.md
index d9533eb9..3a930730 100644
--- a/docs/guide/shortcuts.md
+++ b/docs/guide/shortcuts.md
@@ -228,7 +228,7 @@ Some keys only mean something while a pop-up or panel has the keyboard.
| Key | Action |
|---|---|
| A letter | Keep the brushes whose names start with the letters typed so far |
-| The orange letter on a tile | Pick that brush (<kbd>B</kbd> <kbd>S</kbd> <kbd>T</kbd> = Standard) |
+| The highlighted letter on a tile | Pick that brush (<kbd>B</kbd> <kbd>S</kbd> <kbd>T</kbd> = Standard) |
| <kbd>Backspace</kbd> | Take back one letter |
| <kbd>Enter</kbd> | Pick the first match |
| <kbd>Esc</kbd> | Close |
diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md
index 63d8bf76..0735d8d1 100644
--- a/docs/guide/troubleshooting.md
+++ b/docs/guide/troubleshooting.md
@@ -1,9 +1,22 @@
-# Troubleshooting and FAQ
+# Troubleshooting: tablets, display, crashes and FAQ
This chapter collects fixes for common problems: start-up and graphics errors, tablets, AI service messages,
ComfyUI errors, the camera notch, first-launch warnings on macOS and Windows, where SculptForge keeps its
settings, how to reset the interface, and how to report a bug.
+Quick answers:
+
+| Problem | Fix |
+|---|---|
+| No pen pressure on Windows | Switch **Windows Ink** in the tablet driver and bring the pen back ([Pen tablets](#pen-tablets)) |
+| The cursor jumps when the pen touches down | **Edit > Preferences > Tablet > Mouse mode (relative)** |
+| "Windows protected your PC" | **More info**, then **Run anyway** ([First launch warnings](#first-launch-warnings-on-macos-and-windows)) |
+| Text and buttons too small or too large | **Edit > Preferences > Interface > UI scale** ([details](#text-and-buttons-are-too-small-or-too-large)) |
+| Menus or shelves look wrong after an update | **Edit > Preferences > Config > Restore Standard UI** ([Reset the interface](#reset-the-interface)) |
+| Sculpting feels slow | [The viewport is slow](#the-viewport-is-slow) |
+| Lost work after a crash | [Recovering work after a crash](#recovering-work-after-a-crash) |
+| Want the ZBrush layout back | **Edit > Preferences > Interface > Look > Layout > ZBrush-style** |
+
## SculptForge doesn't start
SculptForge draws with OpenGL 3.3 (core profile). Almost every GPU from the last decade supports it, but an
@@ -40,7 +53,7 @@ documentation** opens links to it).
## The viewport is slow
-- Check the triangle count in the title strip (**Tris**). Millions of triangles on a laptop GPU are heavy;
+- Check the triangle count in the bar along the top of the window (**Tris**). Millions of triangles on a laptop GPU are heavy;
**Tool > Geometry > Decimate** or a lower **Voxel Remesh** resolution brings it down. See
[Subdivide, Remesh, Decimate and LODs](geometry.md).
- Turn off **Wireframe** (<kbd>Shift</kbd>+<kbd>F</kbd>) on dense meshes.
@@ -76,7 +89,7 @@ If no pen is detected or pressure doesn't change:
- Install or update the tablet maker's driver.
- **Windows:** SculptForge reads pressure through Windows Ink, and through the driver's Wintab when Windows Ink is
off (Wacom Tablet Properties > Mapping > **Use Windows Ink**). If pressure is still missing, switch that option
- and bring the pen back to the tablet.
+ and bring the pen back to the tablet. See [Pen tablets on Windows](installing.md#pen-tablets-windows-ink-and-wintab).
- **Linux:** check that the system sees the pen as a tablet (for example in your desktop's tablet settings).
- If the cursor moves but strokes have no pressure, test in another application to see whether the driver
reports pressure at all.