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.

Merge docs/guide-refresh (0.10.9): guide paths name the menus (Edit > Preferences, Sculpt > Stroke)

islandmedd5e8ba9b1f4c
diff --cc docs/guide/brush-lab.md
index e7781d59,265adf4b..07ed3cb9
--- a/docs/guide/brush-lab.md
+++ b/docs/guide/brush-lab.md
@@@ -18,10 -18,9 +18,10 @@@ with <kbd>Alt</kbd>, <kbd>Shift</kbd>,
## Open Brush Lab
- Click **AI Brush** on the top shelf, or **AI Brush** at the top of the **Brush** palette. Brush Lab is a
+ Click **AI Brush** on the top shelf, or **AI Brush** at the top of **Sculpt > Brush**. Brush Lab is a
floating window; it opens at the top-left corner of the canvas the first time, and you can drag it anywhere.
-Click the button again, or the window's close box, to hide it.
+Click the button again, or the window's close box, to hide it. Not there? AI features are off: turn them on in
+**Preferences > AI** (see [Turning AI off](interface.md#turning-ai-off)).
## Design a brush
diff --cc docs/guide/coming-from-zbrush.md
index 5e71fec4,5a941a2d..89ba9c4c
--- a/docs/guide/coming-from-zbrush.md
+++ b/docs/guide/coming-from-zbrush.md
@@@ -6,10 -6,12 +6,12 @@@ of relearning. SculptForge has its own
**ZBrush-style** keys first (see [ZBrush-style keys](#zbrush-style-keys)) and your hands will feel at home.
New installs start in SculptForge's own layout, with menus by task. For the alphabetical palette bar and the
-two-row top shelf you know, click **Coming from ZBrush? Use the ZBrush-style layout** in the welcome, or pick
+two-row top shelf you know, pick **Coming from: ZBrush** (keys and layout) or the **ZBrush-style layout** card in the welcome, or pick
- **Preferences > Interface > Look > Layout > ZBrush-style** (see [Looks and layouts](interface.md#looks-and-layouts)).
- The palette paths in this guide (**Tool > Parts**) work in both: in the SculptForge layout the palettes are
- sections of the menus, and <kbd>F3</kbd> finds any of them.
+ **Edit > Preferences > Interface > Look > Layout > ZBrush-style** (see [Looks and layouts](interface.md#looks-and-layouts)).
+ Paths in this guide name the SculptForge layout's menus. In the ZBrush-style layout, leave out the menu:
+ **Edit > Preferences > Input** is the palette named **Preferences**, **Sculpt > Stroke** the palette named
+ **Stroke**; **Tool > Parts** is the same in both. See [Menus and palettes](interface.md#menus-and-palettes) for
+ every palette's menu, and <kbd>F3</kbd> finds any of them by name.
## ZBrush terms in SculptForge
@@@ -33,7 -35,7 +35,7 @@@ Features use SculptForge's own names. T
| Sculptris Pro | **Dynamic Topology** | **Dynamic** on the top shelf. See [Dynamic topology](dynamic-topology.md) |
| QuickSave | **Snapshot** | **File > Save Snapshot**, the Library's **Snapshots** tab. See [Projects](projects.md#snapshots) |
| Transpose, Gizmo 3D, Transpose All | **Gizmo**, **All Parts** | <kbd>W</kbd> <kbd>E</kbd> <kbd>R</kbd>. See [Gizmo](gizmo.md) |
- | LazyMouse | **Steady Stroke** (every stroke type) | Stroke picker, <kbd>L</kbd> |
-| LazyMouse | **Lazy Stroke** | **Sculpt > Stroke**, <kbd>L</kbd> |
++| LazyMouse | **Steady Stroke** (every stroke type) | **Sculpt > Stroke**, <kbd>L</kbd> |
| PolyFrame (PolyF) | **Wireframe** (**Wire** on the shelf) | Right shelf, <kbd>Shift</kbd>+<kbd>F</kbd> |
| QuickMenu | **Quick Menu** | <kbd>Space</kbd> or a right click |
| DamStandard | **Sharp Crease** brush | <kbd>B</kbd> <kbd>D</kbd> <kbd>S</kbd>. See [Sculpting](sculpting.md) |
diff --cc docs/guide/glossary.md
index cde0fad3,d8eafedd..2f833864
--- a/docs/guide/glossary.md
+++ b/docs/guide/glossary.md
@@@ -33,10 -33,10 +33,10 @@@ for what is planned
| Groups By Normals | **Tool > Face Groups > By normals** with an angle (`polygroup_auto_by_normals`) |
| Bake, Multi Map Exporter (normal / displacement / AO maps) | **Tool > Bake** (`bake`): tangent and object-space normal, displacement, AO, cavity and colour maps from a high-poly Part onto a low-poly's UVs. See [Baking](baking.md) |
| Layers (sculpt layers) | **Tool > Layers**: sculpt layers with weights, exported as blend shapes. See [Layers](layers.md) |
-| LazyMouse | **Lazy Stroke** stroke type (**Sculpt > Stroke**) |
+| LazyMouse | **Steady Stroke** (<kbd>L</kbd>, every stroke type) and the **Lazy Stroke** stroke type |
| LightBox | **Library**, <kbd>,</kbd> (comma) |
| Live Boolean | Not yet |
- | Local symmetry, radial symmetry | **Transform > Symmetry**: **R** (radial symmetry, Radial Count 2-64 around X, Y or Z, combined with the X / Y / Z mirrors) and **Local** (about the active Part's centre). See [Sculpting](sculpting.md#radial-symmetry) |
+ | Local symmetry, radial symmetry | **Sculpt > Symmetry & Gizmo > Symmetry**: **R** (radial symmetry, Radial Count 2-64 around X, Y or Z, combined with the X / Y / Z mirrors) and **Local** (about the active Part's centre). See [Sculpting](sculpting.md#radial-symmetry) |
| Mask by Cavity | **Tool > Masking > By cavity** (`mask_by_cavity`) |
| Masking (Ctrl) | Hold <kbd>Ctrl</kbd> to paint the mask, <kbd>Ctrl</kbd>+<kbd>Alt</kbd> to erase. See [Masking](masking.md) |
| MaskLasso, MaskRect | **Tool > Masking**: pick the shape, then <kbd>Ctrl</kbd>+drag (add <kbd>Alt</kbd> to unmask). See [Masking](masking.md) |
@@@ -60,9 -60,9 +60,9 @@@
| SelectLasso, SelectRect | **Tool > Visibility**: pick the shape, then <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+drag (add <kbd>Alt</kbd> to hide). See [Face Groups](face-groups.md) |
| Solo | **Solo** on the right shelf or in **Tool > Parts** |
| Spotlight | Not yet |
- | Preferences > Performance, Preferences > Mem | **Preferences > Performance**: Antialiasing, Fast Navigation, Multithreading, the last stroke's cost and memory. See [Performance](performance.md) |
- | Store Config | **Store Config**, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (**Preferences > Config**) |
-| Preferences > Performance, Preferences > Mem | **Edit > Preferences > Performance**: Antialiasing, Fast Navigation, Multithreading, the last stroke's cost and memory. See [Performance](performance.md) |
++| Edit > Preferences > Performance, Edit > Preferences > Mem | **Edit > Preferences > Performance**: Antialiasing, Fast Navigation, Multithreading, the last stroke's cost and memory. See [Performance](performance.md) |
+ | Store Config | **Store Config**, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (**Edit > Preferences > Config**) |
-| Stroke (Dots, DragRect, DragDot, Spray) | **Stroke** types Dots, Drag Stamp, Slide Stamp, Spray, Lazy Stroke (<kbd>L</kbd> toggles Lazy Stroke) |
+| Stroke (Dots, DragRect, DragDot, Spray) | **Stroke** types Dots, Drag Stamp, Slide Stamp, Spray, Lazy Stroke (<kbd>L</kbd> toggles Steady Stroke) |
| SubTool | **Part**: same idea, <kbd>Alt</kbd>+click to select. See [Parts](parts.md) |
| Texture Map, New From Polypaint | **Tool > Texture Map**: **New Texture** (1K-8K) and paint straight into it, or **Vertex Paint > Texture**. See [Texture painting](texture-painting.md) |
| Texture palette | Not yet as a palette of texture images. **Tool > Texture Map > Import Texture** loads an image onto the UVs |
diff --cc docs/guide/interface.md
index 524a62d6,46fb8881..abb01939
--- a/docs/guide/interface.md
+++ b/docs/guide/interface.md
@@@ -40,9 -43,10 +43,10 @@@ 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.
+ Coming from ZBrush? In the welcome shown at the first start, pick the **ZBrush-style layout** card or **Coming
+ from: ZBrush** (which also sets the ZBrush-style keys).
Switching the layout swaps the shelves for that layout's standard ones; the trays and what is in them stay.
@@@ -76,26 -67,12 +80,26 @@@ ZBrush-style layout again right after.
[Store Config](#store-config-and-friends) (Store Config keeps them in your UI configuration too).
**Updating from an older version** keeps the look and layout you had. A card, **SculptForge has a new look**,
-shows once: **Try it** switches to Forge Terminal with Tokyo Night and the SculptForge layout; **Keep my layout**
+shows once: **Try it** switches to Forge Terminal with the Neutral colours and the SculptForge layout; **Keep my layout**
- changes nothing. Either way, Preferences > Interface > Look changes it later.
+ changes nothing. Either way, Edit > Preferences > Interface > Look changes it later.
-In scripts: `ui_look look=forge scheme=tokyo_night layout=sculptforge` (or `look=classic layout=zbrush`).
+In scripts: `ui_look look=forge scheme=neutral outlines=subtle layout=sculptforge` (or `look=classic layout=zbrush`).
+
+## Turning AI off
+
+Your art is never uploaded or used for training. AI features run only when you use them and can be turned off.
+
+**Preferences > AI > Enable AI features** turns off everything AI: **AI Brush** (Brush Lab, where you describe a
+brush in words) and **Generate 3D** (image or text to a model) leave the shelves, menus and the command palette,
+their commands leave scripts, `sculptforge-cli` and the MCP tool list, and SculptForge makes no AI network calls.
+The offline image tools (**Relief**, **Inflate**, **Stamp**) and the MCP server stay. The first-run welcome asks
+the same question. The choice is saved at once; turn it back on the same way, or search the command palette for
+"Enable AI".
+
+Studios can turn it off for everyone with the environment variable `SF_AI=off` (or start with `--no-ai`); the
+setting is then locked. See [Studios](studios.md#environment-variables).
- ## The title strip
+ ## The menu bar
From left to right:
@@@ -502,12 -503,12 +530,12 @@@ Config keeps it
| **Popup Info (Ctrl+hover help)** | On | Ctrl-hover help boxes |
| **Popup Info opacity** | 0.97 | How solid the help box is |
| **Tooltip delay** | 0.5 s | How long to point at an icon-only button before its name appears |
+| **Reduce motion** | Off | Hover and focus highlights change colour only: no easing, and tiles don't lift |
| **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 |
+| **UI scale** | Automatic | Size of text and controls (100% to 200%), applied at once; Automatic follows the monitor (see below) |
| **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
@@@ -517,28 -518,7 +545,28 @@@ Quad Remesh, Forge Spheres, Library, Li
English name. Anything not translated yet (most Ctrl-help descriptions, this guide) shows in English. Scripts and
`sculptforge-cli` commands are the same in every language.
+**UI scale** also applies at once: text, buttons, shelves and trays resize on the next frame; Store Config keeps it.
+**Automatic** uses the scale of the monitor the window is on (Windows: **Settings > Display > Scale**; macOS and
+Wayland: the display's scaling; X11: the desktop's font DPI). Drag the window to a monitor at another scale, or
+change the system setting, and the interface follows. A chosen size (100% to 200%) stays the same on every monitor.
+
- **Preferences > Cursor**:
++**Edit > Preferences > Cursor**:
+
+| Setting | Default | What it does |
+|---|---|---|
+| **Viewport cursor** | Crosshair | The pointer over the 3D view: a crosshair, or the arrow (#73). The crosshair stays while the view turns, pans or zooms. Panels, menus and popups always show the arrow |
+| **Cursor follows surface** | On | The brush ring lies on the model: a true circle at the brush's real size, in the plane of the surface (averaged over the brush, so bumps don't bend it), with a short line along the surface's direction. Symmetry and radial copies show as dots where their dabs land. Off: a flat ring on the screen |
+| **Hide ring while stroking** | Off | While a stroke runs, only the dot where the brush touches (and the symmetry dots) shows, not the ring |
+
- **Preferences > Hints**: **Show hints in the viewport** (on) and one box per hint (Strokes start off the model,
++**Edit > Preferences > Hints**: **Show hints in the viewport** (on) and one box per hint (Strokes start off the model,
+Previewing an LOD, Face landmark steps). Each hint over the 3D view also has its own **Don't show again**; **Show
+all hints again** brings them all back. Store Config keeps them.
+
+**Scrolling panels with a pen**: on small screens a palette or tray that doesn't fit scrolls with the mouse wheel,
+and also with a **left-drag on empty space** in it (between and beside the controls) or a **middle-drag anywhere**
+on it, as you would scroll a list with a finger (#100).
+
- **Preferences > Input** sets the key **Style** (the first start sets it from your **Coming from** answer):
+ **Edit > Preferences > Input** sets the key **Style** (the first start sets it from your **Coming from** answer):
**SculptForge** (the default for new installs): <kbd>1</kbd> to <kbd>9</kbd> and <kbd>0</kbd> pick the first ten
brushes, <kbd>I</kbd> opens Intensity like <kbd>U</kbd>, and <kbd>Ctrl</kbd>+drag on the background zooms when
nothing is masked; **ZBrush-style**: ZBrush's keys, with the number keys free (<kbd>9</kbd> is Save Snapshot),
diff --cc docs/guide/sculpting.md
index e6de6da8,befd0f81..aadab568
--- a/docs/guide/sculpting.md
+++ b/docs/guide/sculpting.md
@@@ -149,13 -149,10 +149,13 @@@ With an [alpha](#alphas), Falloff work
the whole alpha shows, hard to its edges (a Square alpha stamps the full square); at 0 the falloff softens it and
rounds a square's corners; at +100 only a soft point in the middle is left.
-Over the model, the rings lie on the surface, as in SculptGL: they turn with the surface under the pointer, bend
-over its bumps and curves, and show the brush's real size there, with a short line pointing out of the surface.
-With symmetry on, a fainter ring shows where the mirrored brush lands. Off the model the rings are flat circles.
-**Edit > Preferences > Input > Cursor follows surface** (on by default) switches back to flat rings everywhere.
+Over the model, the rings lie on the surface: true circles in the plane of the surface under the pointer, at the
+brush's real size there, with a short line pointing out of the surface. The plane follows the form averaged over
+the whole brush, so the rings stay round and steady over fine bumps and detail. With symmetry on (mirror or
+radial), a dot shows where each copy of the brush lands. Off the model the rings are flat circles.
- **Preferences > Cursor**: **Cursor follows surface** (on by default) switches back to flat rings everywhere, and
++**Edit > Preferences > Cursor**: **Cursor follows surface** (on by default) switches back to flat rings everywhere, and
+**Hide ring while stroking** (off by default) shows only the dot while a stroke runs. The crosshair pointer stays
+while you turn the view.
The <kbd>S</kbd>, <kbd>U</kbd>, <kbd>I</kbd> and <kbd>O</kbd> pop-ups take the mouse or the keyboard: drag the
slider and release to close it, or type a number and press <kbd>Enter</kbd> (a minus first for a negative Falloff). <kbd>Esc</kbd> closes the pop-up without typing anything new.
@@@ -269,12 -266,9 +269,12 @@@ click an item, or click in the middle o
|---|---|---|
| <kbd>T</kbd> | **Brushes** | Standard, Clay Block, Move, Sharp Crease, Inflate, Pinch, Flatten, Tendril |
| <kbd>Y</kbd> | **Masking** | Invert Mask, Mask Lasso, Clear Mask, Mask Rectangle, Mask All, Mask Pen, View Mask, Group Masked |
+| <kbd>J</kbd> | **Strokes** | Dots, Drag Stamp, Slide Stamp, Spray, Lazy Stroke (see [Strokes](#strokes)) |
-Both keys are free in every input style. Make your own in **Edit > Preferences > Input > Radial Menus** (up to 8 menus of
-8 items each):
+All three keys are free in every input style. Installs that stored their radial menus before 0.10.9 get the
- Strokes menu from **Restore default menus** in Preferences > Input > Radial Menus.
++Strokes menu from **Restore default menus** in Edit > Preferences > Input > Radial Menus.
+
- Make your own in **Preferences > Input > Radial Menus** (up to 8 menus of 8 items each):
++Make your own in **Edit > Preferences > Input > Radial Menus** (up to 8 menus of 8 items each):
- **+** adds a menu and opens a search for its first item. An item can be anything the command palette
(<kbd>F3</kbd>) finds: a brush, a tool, a command or a toggle.
@@@ -323,12 -317,12 +323,12 @@@ shelf, which opens the stroke picker, o
| **Drag Stamp** | Click and drag one stamp: the drag length sets its size and its direction the rotation. Great with alphas. | None |
| **Slide Stamp** | Click and drag one stamp of the brush's Draw Size: it slides over the surface under the cursor and lands where you let go. Great for VDMs. | None |
| **Spray** | Scattered dabs of random size, strength and rotation, for organic texture. | **Scatter** (0 to 2, default 1): how far dabs land from the cursor, as a fraction of the brush size. |
-| **Lazy Stroke** | The brush trails the cursor on a string, for smooth, steady lines. | **Lazy radius** (1 to 300 px, default 40): longer is steadier. |
+| **Lazy Stroke** | Dots with **Steady Stroke** on: the brush trails the cursor on a string, for smooth, steady lines. | **Steady radius** (1 to 300 px, default 40): longer is steadier. |
-The setting slider appears under the stroke tiles when **Spray** or **Lazy Stroke** is selected. With Lazy Stroke,
-the viewport draws the string between the cursor and the brush point.
+**Scatter** appears under the stroke tiles when **Spray** is selected. **Steady Stroke** works with every stroke
+type; see [Precision work](#precision-work).
- **Continuous**, under the stroke tiles in the stroke picker and in the **Stroke** palette, keeps the brush working
+ **Continuous**, under the stroke tiles in the stroke picker and in **Sculpt > Stroke**, keeps the brush working
while you hold it still on the model (30 dabs a second), with any stroke type.
Notes:
@@@ -685,11 -632,10 +685,11 @@@ also have a **Pressure curve** setting
and **Full pressure at** yourself), applied before each brush's own curve;
- the eraser end (default **Invert**, like holding <kbd>Alt</kbd>) and the side buttons (default:
lower button right-click to rotate the view, upper button **Invert**, third button **Pan view**). A side button
- can open a [radial menu](#radial-menus) instead (Preferences > Input > Radial Menus).
+ can open a [radial menu](#radial-menus) instead (Edit > Preferences > Input > Radial Menus).
-- **Mouse mode (relative)**, for a tablet whose driver is set to mouse mode: the pen moves the cursor by how far
- it moves, and putting it down elsewhere on the tablet leaves the cursor where it was. The brush follows the
- system cursor the driver moves, so brush, arrow and clicks always agree (#72).
+- **Mouse mode (relative)**: the pen moves the cursor by how far it moves, like a mouse, and putting it down
+ elsewhere on the tablet leaves the cursor where it was, with the driver in pen mode or in its own mouse mode.
+ While the pen is in range the arrow is drawn at the brush (the system's is hidden), so brush, arrow and clicks
+ always agree (#72).
**Store Config** (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>) keeps these settings. Setup notes for Windows
Ink, macOS and Linux are in
diff --cc docs/guide/troubleshooting.md
index 6c2e78b6,776c10a9..15e33bf8
--- a/docs/guide/troubleshooting.md
+++ b/docs/guide/troubleshooting.md
@@@ -84,13 -97,7 +97,13 @@@ If no pen is detected or pressure doesn
quick click), a triple-click with the mouse or a click in the Parts list; the status bar names it and how. A
tablet's ExpressKey set to Alt counts as the keyboard's Alt.
- **The cursor jumps back when you put the pen down elsewhere:** the tablet driver is set to mouse (relative)
- mode. Turn on **Preferences > Tablet > Mouse mode (relative)**. It also makes the pen relative with the driver
- mode. Turn on **Edit > Preferences > Tablet > Mouse mode (relative)**.
++ mode. Turn on **Edit > Preferences > Tablet > Mouse mode (relative)**. It also makes the pen relative with the driver
+ in pen mode; the arrow is drawn at the brush while the pen is in range.
+- **The pen picks a brush, then stops clicking menus or the canvas until you use the mouse** (Huion, display
+ tablets, Wacom; 0.10.8 and earlier): update to 0.10.9 or later. If it still happens, tell us the tablet, its
+ driver version and whether Windows Ink is on.
+- **With two screens, the app slows down when the pointer is on the other screen:** fixed in 0.10.9; SculptForge
+ now rests only when its window loses focus.
## AI services
@@@ -154,11 -161,8 +167,11 @@@ window
### Text and buttons are too small or too large
- **Preferences > Interface > UI scale** sets the size (Automatic, 100% to 200%) and applies it at once. Press
-**Edit > Preferences > Interface > UI scale** sets the size (Automatic, 100% to 200%). It takes effect the next time
-SculptForge starts, and only if you press **Store Config** (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>).
++**Edit > Preferences > Interface > UI scale** sets the size (Automatic, 100% to 200%) and applies it at once. Press
+**Store Config** (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>) to keep it for the next start. **Automatic** uses
+the scale of the monitor the window is on: on Windows that is **Settings > Display > Scale**, per monitor, and the
+interface follows when you drag the window to another monitor. On Linux under X11 it comes from the desktop's
+font DPI (Xft.dpi); if Automatic looks wrong there, pick a size.
### My layout or shortcuts are gone after a restart