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: menu paths name the SculptForge layout's task menus

islandmeddcf2638c5f18
diff --git a/CMakeLists.txt b/CMakeLists.txt
index de49b574..3219823f 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -636,6 +636,8 @@ if(SCULPTFORGE_BUILD_TESTS)
add_test(NAME upstream_watch COMMAND ${Python3_EXECUTABLE} -I ${CMAKE_CURRENT_SOURCE_DIR}/tests/upstream/test_upstream_watch.py)
add_test(NAME guide_site COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/tools/guide/build_site.py --check
--out ${CMAKE_CURRENT_BINARY_DIR}/guide-site)
+ # Menu paths in the guide name the SculptForge layout's task menus (Edit > Preferences, not Preferences).
+ add_test(NAME guide_menu_paths COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/tools/guide/menu_paths.py --check)
endif()
# The phone link's relay (services/link-worker, a Cloudflare Worker) under plain Node, when Node 20+ is installed.
diff --git a/docs/guide/blender.md b/docs/guide/blender.md
index 4b82e8ed..58d3b0b1 100644
--- a/docs/guide/blender.md
+++ b/docs/guide/blender.md
@@ -136,7 +136,7 @@ and <kbd>Space</kbd> no longer plays the animation in Sculpt Mode.
SculptForge's VDM brushes and Blender's use the same maps (see
[Vector displacement brushes](sculpting.md#vector-displacement-brushes)):
-- **From Blender**: a map baked with Blender's *VDM Brush Baker* loads with **Brush > Vector Displacement > Load
+- **From Blender**: a map baked with Blender's *VDM Brush Baker* loads with **Sculpt > Brush > Vector Displacement > Load
VDM...** as it is.
- **To Blender**: **Export EXR...** writes the VDM brush's map. In Blender, in Sculpt Mode with a Draw brush:
in the brush's **Texture** panel add a new image texture and open the EXR (set its Color Space to
diff --git a/docs/guide/brush-lab.md b/docs/guide/brush-lab.md
index 84f2c9b2..43913310 100644
--- a/docs/guide/brush-lab.md
+++ b/docs/guide/brush-lab.md
@@ -75,7 +75,7 @@ The name field at the top of the editor renames the brush when you press <kbd>En
## Choose an AI provider
Brush Lab works out of the box with no account or key. Open the **AI provider** section of Brush Lab (also in
-**Generate > AI brush provider**) to choose another service.
+**Mesh > Generate 3D > AI brush provider**) to choose another service.
| Provider | What you need | Notes |
|---|---|---|
@@ -119,7 +119,7 @@ The library is a folder of `.sfbrush` files in the SculptForge settings folder:
| macOS | `~/Library/Application Support/SculptForge/SculptForge/brushes` |
| Windows | `%APPDATA%\SculptForge\SculptForge\brushes` |
-![The Custom brushes list in the Brush palette, with its right-click menu](images/brush-library.jpg)
+![The Custom brushes list in **Sculpt > Brush**, with its right-click menu](images/brush-library.jpg)
### The Custom brushes list
@@ -156,7 +156,7 @@ brushes.
A brush code is the whole recipe in one line of text, starting with `sfbrush1:`. Paste it into a chat, an
email, an issue or a forum post.
-- **Copy**: right-click a custom brush (in **Brush > Custom brushes** or the brush picker) and choose
+- **Copy**: right-click a custom brush (in **Sculpt > Brush > Custom brushes** or the brush picker) and choose
**Copy brush code**.
- **Paste**: copy a code, then press <kbd>Ctrl</kbd>+<kbd>V</kbd> over the viewport, click **Paste brush** in
Brush Lab, or choose **Edit > Paste brush**. The brush is installed in your library and becomes active.
diff --git a/docs/guide/coming-from-zbrush.md b/docs/guide/coming-from-zbrush.md
index a5a7f26a..424fc46d 100644
--- a/docs/guide/coming-from-zbrush.md
+++ b/docs/guide/coming-from-zbrush.md
@@ -7,7 +7,7 @@ of relearning. SculptForge has its own keymap and offers ZBrush-style, Blender a
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
-**Preferences > Interface > Look > Layout > ZBrush-style** (see [Looks and layouts](interface.md#looks-and-layouts)).
+**Edit > 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.
@@ -19,21 +19,21 @@ Features use SculptForge's own names. The ideas are the ones you know; here is w
|---|---|---|
| SubTools | **Parts** | **Tool > Parts**; <kbd>Alt</kbd>+click one in the viewport. See [Parts](parts.md) |
| ZSpheres | **Forge Spheres** | **Tool > Forge Spheres**. See [Forge Spheres](forge-spheres.md) |
-| Polypaint | **Vertex Paint** | The Paint brush (<kbd>P</kbd>), **Rgb**, the Color palette. See [Vertex Paint and materials](vertex-paint.md) |
+| Polypaint | **Vertex Paint** | The Paint brush (<kbd>P</kbd>), **Rgb**, the **Paint** menu. See [Vertex Paint and materials](vertex-paint.md) |
| Polygroups | **Face Groups** | **Tool > Face Groups**. See [Face Groups and visibility](face-groups.md) |
| LightBox | **Library** | <kbd>,</kbd> (comma). See [The interface](interface.md#the-library) |
| GoZ | **Send to ZBrush** (GoZ-compatible) | **File > Send to ZBrush**. See [Exporting](exporting.md#exchange-models-with-zbrush-send-to-zbrush) |
-| MatCap | **Lit Sphere** | The Material palette, <kbd>M</kbd>. See [Materials](vertex-paint.md#materials-lit-spheres) |
+| MatCap | **Lit Sphere** | **Render > Materials**, <kbd>M</kbd>. See [Materials](vertex-paint.md#materials-lit-spheres) |
| Zadd / Zsub | **Add** / **Sub** | Top shelf; <kbd>Alt</kbd> flips for one stroke |
| Z Intensity | **Intensity** | Top shelf, <kbd>U</kbd> |
-| Focal Shift | **Falloff** | Draw palette, <kbd>O</kbd> |
+| Focal Shift | **Falloff** | **Sculpt > Draw & Tablet**, <kbd>O</kbd> |
| DynaMesh | **Voxel Remesh** | **Tool > Remesh**. See [Geometry](geometry.md#voxel-remesh) |
| ZRemesher, ZRemesher Guides | **Quad Remesh**, **Quad Remesh Guides** | **Tool > Geometry > Quad Remesh**. See [Quad retopology](retopology.md) |
| ProjectAll, ZProject | **Project All**, **Project** | **Tool > Parts > Project**. See [Quad retopology](retopology.md#project-all) |
| 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 | **Lazy Stroke** | Stroke palette, <kbd>L</kbd> |
+| LazyMouse | **Lazy Stroke** | **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) |
@@ -42,12 +42,12 @@ Features use SculptForge's own names. The ideas are the ones you know; here is w
| KelvinSnake | **Elastic Tendril** brush | Brush picker (KelvinGrab, KelvinTwist and KelvinScale keep their names) |
| Trim Dynamic | **Trim** brush | Brush picker |
| hPolish | **Hard Polish** | Not built in yet; a [Brush Lab](brush-lab.md) recipe gets close |
-| DragRect, DragDot | **Drag Stamp**, **Slide Stamp** strokes | Stroke palette |
+| DragRect, DragDot | **Drag Stamp**, **Slide Stamp** strokes | **Sculpt > Stroke** |
| MaskPen, MaskLasso, MaskRect | **Mask Pen**, **Mask Lasso**, **Mask Rectangle** | **Tool > Masking**. See [Masking](masking.md) |
| SelectRect, SelectLasso | **Select Rectangle**, **Select Lasso** | **Tool > Visibility** |
| FiberMesh, LightCap | Not yet | |
| ZScript, ZPlugin | Script commands and the Python module | See [Scripting](scripting.md) |
-| Decimation Master, UV Master, Projection Master | **Decimate**, the **UV Editor** (and **Auto UV**), **Generate > Stamp** | See [Geometry](geometry.md#decimate), [UV Editor](uv-editor.md) and [Texture painting](texture-painting.md) |
+| Decimation Master, UV Master, Projection Master | **Decimate**, the **UV Editor** (and **Auto UV**), **Mesh > Generate 3D > Stamp** | See [Geometry](geometry.md#decimate), [UV Editor](uv-editor.md) and [Texture painting](texture-painting.md) |
The command palette (<kbd>F3</kbd>) finds every feature by its ZBrush name too: type `SubTool`, `ZSphere`,
`Polypaint` or `MatCap` and it shows the SculptForge command, as in "Forge Spheres (ZBrush users: ZSpheres)". The
@@ -60,7 +60,7 @@ affiliated with or endorsed by Maxon.
New installs start with the **SculptForge** keys. The first time SculptForge starts it asks what you are
**Coming from**: pick **ZBrush** and it turns on the ZBrush-style keys for you. To switch at any time, open
-**Preferences > Input** and choose **ZBrush-style** under **Style**, then press **Store Config**
+**Edit > Preferences > Input** and choose **ZBrush-style** under **Style**, then press **Store Config**
(<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>) to keep it. If you used an earlier version, your saved choice is
kept.
@@ -73,7 +73,7 @@ What the ZBrush-style keys change:
| <kbd>Ctrl</kbd>+drag on the background with nothing masked | Draws a mask rectangle | Zooms |
| Zoom drags (<kbd>Ctrl</kbd>+right-drag, <kbd>Alt</kbd> then release) | Up zooms out | Up zooms in |
-Everything else in this chapter works in both styles. **Preferences > Input > Rotation** chooses free rotation
+Everything else in this chapter works in both styles. **Edit > Preferences > Input > Rotation** chooses free rotation
(as in ZBrush) or a turntable that keeps the model upright, as in Blender or Maya. Press **Store Config** to keep
either. See [Keyboard and mouse](shortcuts.md#zbrush-style-keys) for the full list.
@@ -186,7 +186,7 @@ The SculptForge column is with the ZBrush-style keys on.
| Search every command | | <kbd>F3</kbd> (ZBrush names work too) |
Every shortcut is in [Keyboard and mouse](shortcuts.md), generated from the app itself, and can be changed with
-<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+click or **Preferences > Hotkeys**.
+<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+click or **Edit > Preferences > Hotkeys**.
## See also
diff --git a/docs/guide/dynamic-topology.md b/docs/guide/dynamic-topology.md
index f38b47ea..0afdb1d9 100644
--- a/docs/guide/dynamic-topology.md
+++ b/docs/guide/dynamic-topology.md
@@ -11,9 +11,9 @@ remeshing first.
| Control | Where | What it does |
|---|---|---|
-| **Dynamic** | Top shelf, Draw palette | Turns dynamic topology on or off (ZBrush's Sculptris Pro button) |
-| **Detail** | Top shelf (while Dynamic is on), Draw palette | How small the triangles get: 0 coarse, 100 fine (default 50) |
-| **Constant detail** | Draw palette | Off: the size follows the brush. On: one size for the whole mesh |
+| **Dynamic** | Top shelf, **Sculpt > Draw & Tablet** | Turns dynamic topology on or off (ZBrush's Sculptris Pro button) |
+| **Detail** | Top shelf (while Dynamic is on), **Sculpt > Draw & Tablet** | How small the triangles get: 0 coarse, 100 fine (default 50) |
+| **Constant detail** | **Sculpt > Draw & Tablet** | Off: the size follows the brush. On: one size for the whole mesh |
Then sculpt as usual. Every brush works with it except **Move** (it drags the surface without remeshing), the
mask and paint brushes, and the stamping strokes **Drag Stamp** and **Slide Stamp** (so VDM stamps don't remesh either). **Smooth** remeshes towards larger triangles, so smoothing
@@ -39,7 +39,7 @@ and fine ones around the eyes.
## Smooth remesh
Smoothing (<kbd>Shift</kbd>) with Dynamic on also simplifies by default: it remeshes toward triangles twice the
-size, so the smoothed area gets coarser, as in Sculptris Pro. **Smooth remesh** under **Draw > Dynamic topology**
+size, so the smoothed area gets coarser, as in Sculptris Pro. **Smooth remesh** under **Sculpt > Draw & Tablet > Dynamic topology**
sets how much (from the discussions):
- **Smooth only** (0): Shift only smooths; the triangles stay as they are.
diff --git a/docs/guide/fill-layers.md b/docs/guide/fill-layers.md
index e8560546..30e94030 100644
--- a/docs/guide/fill-layers.md
+++ b/docs/guide/fill-layers.md
@@ -9,7 +9,7 @@ along it a moment later. **Material Recipes** are ready-made stacks of Fill laye
![Painted Edges on a sculpted sphere: the paint has chipped away along the creases](images/fill-painted-edges.jpg)
Fill layers live in **Tool > Paint Layers** next to your paint layers, on a Part with a texture
-([Texture painting](texture-painting.md)). Turn on **Material > Viewport Shading > PBR** to see the metal, the
+([Texture painting](texture-painting.md)). Turn on **Render > Materials > Viewport Shading > PBR** to see the metal, the
roughness and the bumps as they will look in a game engine ([Material painting](pbr-painting.md#the-pbr-viewport)).
## Lay a Material Recipe
diff --git a/docs/guide/generate-3d.md b/docs/guide/generate-3d.md
index 5df4f2b4..4a820aa0 100644
--- a/docs/guide/generate-3d.md
+++ b/docs/guide/generate-3d.md
@@ -106,7 +106,7 @@ This runs each model author's own public demo on Hugging Face's shared ZeroGPU h
If you never picked a model, SculptForge uses the default, so updates that change it reach you; a model you pick
(and save) is kept. If you pick TRELLIS.2 without a token, Hunyuan3D 2.1 runs instead and the status line says
-"TRELLIS.2 needs a free Hugging Face token (Preferences > AI); used Hunyuan3D 2.1 instead."
+"TRELLIS.2 needs a free Hugging Face token (Edit > Preferences > AI); used Hunyuan3D 2.1 instead."
The Hunyuan3D models' licence doesn't cover use in the European Union, the United Kingdom or South Korea. The
first time a Hunyuan3D model runs, a notice says so, and it stays in the **Model** picker's tooltip. See
@@ -114,7 +114,7 @@ first time a Hunyuan3D model runs, a notice says so, and it stays in the **Model
GPU time is rationed per person per day, there can be a queue at busy times, and a demo can be paused or
changed by its owner. To raise the allowance, create a free token with read access at
-huggingface.co/settings/tokens and paste it into **HF token** or **Preferences > AI** (or set the `HF_TOKEN`
+huggingface.co/settings/tokens and paste it into **HF token** or **Edit > Preferences > AI** (or set the `HF_TOKEN`
environment variable).
When the allowance runs out you see "Hugging Face's free GPU time is used up for now"; add a token, wait for
it to refill, or pick another model.
diff --git a/docs/guide/glossary.md b/docs/guide/glossary.md
index cca35d53..6b51dba7 100644
--- a/docs/guide/glossary.md
+++ b/docs/guide/glossary.md
@@ -11,7 +11,7 @@ for what is planned.
| ZBrush | SculptForge |
|---|---|
-| Alpha | **Alpha**: built-in round, square and noise, or any grayscale image. Left shelf, Alpha palette. See [Sculpting](sculpting.md) |
+| Alpha | **Alpha**: built-in round, square and noise, or any grayscale image. Left shelf, **Sculpt > Alpha**. See [Sculpting](sculpting.md) |
| Auto Groups | **Tool > Face Groups > By pieces** (`polygroup_by_connectivity`) |
| BPR render | Not yet as a renderer. Headless renders and turntables with `sculptforge --render` ([Scripting](scripting.md)) |
| Brush pop-up (B) | **Brush picker**, <kbd>B</kbd>, then type letters (B S T = Standard) |
@@ -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 (Stroke palette) |
+| LazyMouse | **Lazy Stroke** stroke type (**Sculpt > Stroke**) |
| 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) |
@@ -50,18 +50,18 @@ for what is planned.
| Polypaint | **Vertex Paint**: Paint brush (<kbd>P</kbd>), Rgb, fills, cavity paint. See [Vertex Paint](vertex-paint.md) |
| 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. **Generate > Stamp** projects an image onto the model from the view |
+| 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) |
| 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 the Draw palette and the Quick Menu |
+| 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) |
| Reconstruct Subdiv | **Tool > Geometry > Reconstruct Subdiv** (`subdiv_reconstruct`) |
| SDiv, Lower Res / Higher Res (Shift+D / D) | **Tool > Geometry**: the **SDiv** slider, **Lower Res** <kbd>Shift</kbd>+<kbd>D</kbd>, **Higher Res** <kbd>D</kbd> (`subdiv_level`). See [Subdivision levels](subdivision-levels.md) |
| 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) |
+| 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) |
| 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) |
@@ -69,7 +69,7 @@ for what is planned.
| Transpose, Gizmo 3D (Move W, Scale E, Rotate R) | **Gizmo**: same keys, arrows, rings and boxes; masked parts stay, Falloff softens the joint. See [Gizmo](gizmo.md) |
| Transpose All | **All Parts** in the Gizmo panel. See [Gizmo](gizmo.md#all-parts) |
| UV Master (Unwrap), UV editing | The **UV Editor** (<kbd>Alt</kbd>+<kbd>U</kbd>): seams on the model, Least Stretch, Conformal, By Face Groups, Planar and Unfold unwraps, UDIM packing, texel density, trim sheets (`uv_unwrap`, `uv_pack`...). **Tool > Texture Map > Auto UV** (`uv_auto`) is the one-click unwrap. See [UV Editor](uv-editor.md) |
-| VDM brush, 3D alpha, Create VDM brush from the VDM plane | The **VDM** brush and **Brush > Vector Displacement**: built-in maps, **Load VDM...** (EXR), **New VDM Plane**, **Create VDM**, **Export EXR...**. See [Vector displacement brushes](sculpting.md#vector-displacement-brushes) |
+| VDM brush, 3D alpha, Create VDM brush from the VDM plane | The **VDM** brush and **Sculpt > Brush > Vector Displacement**: built-in maps, **Load VDM...** (EXR), **New VDM Plane**, **Create VDM**, **Export EXR...**. See [Vector displacement brushes](sculpting.md#vector-displacement-brushes) |
| Zadd / Zsub | **Add** / **Sub** on the top shelf; <kbd>Alt</kbd> flips for one stroke |
| ZPlugin | No in-app plugin system yet. Automate with the Python module, `sculptforge-cli` and MCP ([Scripting](scripting.md)) |
| ZRemesher | **Tool > Geometry > Quad Remesh** (`qremesh`): Target Polygons, Half / Same / Double, Adaptive Size, Keep Groups, Use Vertex Paint, symmetry. No curve guides yet. See [Quad retopology](retopology.md) |
@@ -118,8 +118,8 @@ for what is planned.
| UDIM tile | One unit square of UV space, numbered 1001 (u and v between 0 and 1), 1002 to its right, ten per row: a Part's islands can spread over several, each its own texture. See [UV Editor](uv-editor.md#packing-and-udim-tiles) |
| Texel density | Texels of the texture per unit of surface length: equal density makes detail look the same size everywhere. See [UV Editor](uv-editor.md#texel-density) |
| Trim sheet | A texture of horizontal strips that repeat left to right; islands are laid into a strip. See [UV Editor](uv-editor.md#trim-sheets) |
-| Antialiasing (AA) | Smoothing the 3D view's edges with several samples per pixel (Off, 2x, 4x, 8x in **Preferences > Performance**). See [Performance](performance.md) |
-| BVH | Bounding volume hierarchy: the structure SculptForge uses to find the surface under the cursor and the vertices under a brush. Its update time is shown per dab in **Preferences > Performance** |
+| Antialiasing (AA) | Smoothing the 3D view's edges with several samples per pixel (Off, 2x, 4x, 8x in **Edit > Preferences > Performance**). See [Performance](performance.md) |
+| BVH | Bounding volume hierarchy: the structure SculptForge uses to find the surface under the cursor and the vertices under a brush. Its update time is shown per dab in **Edit > Preferences > Performance** |
| Dab | One step of a brush along a stroke. Its cost per dab decides whether a stroke keeps up with the display (under 16 ms at 60 Hz). See [Performance](performance.md) |
| Fast Navigation | Drawing scenes of 10 million triangles or more without antialiasing while the view moves, so it keeps up. See [Performance](performance.md) |
| Multithreading | Brushes, normal and BVH updates and saving spread over every processor core; same results either way. See [Performance](performance.md) |
diff --git a/docs/guide/installing.md b/docs/guide/installing.md
index 7bfabc19..71e5d7d5 100644
--- a/docs/guide/installing.md
+++ b/docs/guide/installing.md
@@ -141,21 +141,21 @@ SDL_VIDEO_DRIVER=x11 sculptforge
Pen tablets work on both. On Wayland, pressure, tilt, the eraser end and side buttons come through the
desktop's tablet protocol (tablet-v2), so the tablet must be set up in your desktop's settings rather than
-through X11 tools such as `xsetwacom`. If pressure doesn't respond, check **Preferences > Tablet** for the
+through X11 tools such as `xsetwacom`. If pressure doesn't respond, check **Edit > Preferences > Tablet** for the
live pressure reading.
## What you see at start-up
SculptForge opens a 1600 x 960 window with a sphere ready to sculpt and the **Library** open along the top of
the canvas on its **Project** tab, so you can reopen recent work with a double-click. Press <kbd>,</kbd>
-(comma) to close it, or turn off **Preferences > Library > Show at startup**. The first start also creates
+(comma) to close it, or turn off **Edit > Preferences > Library > Show at startup**. The first start also creates
your library folder (**Documents/SculptForge**, with Projects, Tools, Brushes, Alphas, MatCaps, Images, Splats
and QuickSave (snapshots) sub-folders), which the Library shows as **User**.
The first start also asks what you are **Coming from**: **ZBrush**, **Blender**, **Maya** or **New to sculpting**.
Your answer picks the key style: **ZBrush** turns on the ZBrush-style keys, **Blender** and **Maya** their own
styles, and **New to sculpting** keeps the SculptForge keys (the default). Change it any time in
-**Preferences > Input > Style** (see [Keyboard and mouse](shortcuts.md)); if you are updating from an earlier
+**Edit > Preferences > Input > Style** (see [Keyboard and mouse](shortcuts.md)); if you are updating from an earlier
version, your saved style is kept and the question isn't asked.
You can open a file directly from the command line, too: `sculptforge model.obj` (or a `.glb`, `.sfproj`,
@@ -169,7 +169,7 @@ The next chapter, [The interface](interface.md), explains what everything on scr
SculptForge doesn't install updates by itself, but it tells you when there is one. Once a day at start-up it
downloads a small file from its website that names the newest version; if yours is older, a banner at the top
of the 3D view says what's new, with **What's new**, **Download**, **Later** and **Skip this version**. Nothing
-about you or your computer is sent. **Help > Check for updates** asks right away, and **Preferences > Updates**
+about you or your computer is sent. **Help > Check for updates** asks right away, and **Edit > Preferences > Updates**
turns the daily check off. Builds from a package manager (such as the AUR package) leave updates to the package
manager and don't check.
diff --git a/docs/guide/interface.md b/docs/guide/interface.md
index b2d5d8e9..f5e1e7b8 100644
--- a/docs/guide/interface.md
+++ b/docs/guide/interface.md
@@ -27,7 +27,7 @@ palette bar stays, so every function is still one click away.
## Looks and layouts
-**Preferences > Interface > Look** sets how the interface looks and how it is laid out. Neither changes your
+**Edit > Preferences > Interface > Look** sets how the interface looks and how it is laid out. Neither changes your
models, brushes or shortcuts.
**Layout**:
@@ -64,7 +64,7 @@ ZBrush-style layout again right after. The look and layout are remembered for th
**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**
-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`).
@@ -92,7 +92,7 @@ From left to right:
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.
-![The Stroke palette open as a drop-down from the palette bar](images/palette-dropdown.jpg)
+![**Sculpt > Stroke** open as a drop-down from the palette bar](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 >
@@ -122,7 +122,7 @@ Interface > Palettes strictly A-Z (ZBrush order)**.
Large palettes are divided into **sub-palettes**: headers you click to open or close. The Tool palette is the
main example (Part, Layers, Geometry and so on). By default opening one sub-palette closes the others in
the same palette, which keeps the palette short. **Shift**+click a header to open it without closing the
-others, or turn off **Preferences > Interface > One sub-palette open**.
+others, or turn off **Edit > Preferences > Interface > One sub-palette open**.
> **ZBrush:** as in ZBrush, Parts (ZBrush's SubTool), Layers, Masking, Face Groups (Polygroups) and Visibility are sub-palettes of the Tool
> palette rather than palettes of their own. SculptForge's Remesh sub-palette is where ZBrush's DynaMesh would be.
@@ -142,12 +142,12 @@ right tray is open by default and holds the **Tool** palette; the left tray star
- **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).
-![The Stroke palette kept in the right tray above the Tool palette](images/palette-tray.jpg)
+![**Sculpt > Stroke** kept in the right tray above the Tool palette](images/palette-tray.jpg)
-When a tray holds several palettes, **Preferences > Interface > Auto collapse left tray** (on by default) and
+When a tray holds several palettes, **Edit > Preferences > Interface > Auto collapse left tray** (on by default) and
**Auto collapse right tray** (off by default) collapse the other palettes when the one you open would not fit.
-When you open a Gaussian splat capture, the Splats palette moves into the right tray by itself.
+When you open a Gaussian splat capture, **Render > Gaussian Splats** moves into the right tray by itself.
> **Note:** on a window narrower than 1280 pixels (at 100% UI scale) the right tray folds away and palettes
> open as drop-downs only. The left-shelf tiles get smaller and the bottom shelf scrolls sideways with the
@@ -227,7 +227,7 @@ The active brush has an orange outline.
sparkle in the corner.
- **Remove a brush**: right-click its tile and choose **Remove from shelf**.
- **Bigger or smaller tiles**: right-click any brush on the shelf and choose **Tile size**: Small, Medium (the
- default) or Large. The same setting is in **Preferences > Interface > Shelf tiles**. Small leaves the most
+ default) or Large. The same setting is in **Edit > Preferences > Interface > Shelf tiles**. Small leaves the most
room for the model on a laptop screen.
## Pop-up pickers
@@ -318,7 +318,7 @@ Working with the strip:
At the root of the Tool and Image tabs is a **Built-in** folder (the models and images that ship with
SculptForge, such as the demo lion head), and the Project, Tool, Brush, Alpha, Image and Splats tabs have a
**User** folder, your library folder (**Documents/SculptForge** by default). To use a different library folder,
-choose it in **Preferences > Library > Library folder**.
+choose it in **Edit > Preferences > Library > Library folder**.
> **ZBrush:** the Library works like ZBrush's LightBox: comma toggles it, double-click loads, and Built-in and User
> folders play the part of ZBrush's Maxon and User folders.
@@ -338,7 +338,7 @@ the command's usage line and each parameter with its type and description. This
console, `sculptforge-cli` and AI agents use.
Without <kbd>Ctrl</kbd>, icon-only buttons and labels that don't fit show their name after a short delay
-(**Preferences > Interface > Tooltip delay**). Turn Ctrl-hover help off with **Preferences > Interface > Popup
+(**Edit > Preferences > Interface > Tooltip delay**). Turn Ctrl-hover help off with **Edit > Preferences > Interface > Popup
Info (Ctrl+hover help)**, and make the box more or less see-through with **Popup Info opacity**.
### The Controls sheet
@@ -410,7 +410,7 @@ do what. As in ZBrush, **changes last until you quit** unless you store them wit
### Move, add and remove shelf items
-1. Open **Preferences > Config** and turn on **Enable Customize**. The shelves get a dashed orange outline and
+1. Open **Edit > Preferences > Config** and turn on **Enable Customize**. The shelves get a dashed orange outline and
the status line reads "Customize: Ctrl+Alt+drag to move or remove items".
2. Hold <kbd>Ctrl</kbd>+<kbd>Alt</kbd> and drag any button, slider or tile:
- onto a shelf to put it there (an orange line shows where it will go), which is how you **add** buttons
@@ -426,7 +426,7 @@ Right-clicking a shelf item and choosing **Remove from shelf** works without Cus
- Hold <kbd>Ctrl</kbd>+<kbd>Alt</kbd> and **click** any button (with Customize off), then press the key you
want. <kbd>Esc</kbd> cancels and <kbd>Backspace</kbd> removes the button's shortcut.
-- Or open **Preferences > Hotkeys**, find the action (there's a filter), click its key button and press the
+- Or open **Edit > Preferences > Hotkeys**, find the action (there's a filter), click its key button and press the
new key. Keys you changed show in orange. **Default shortcuts** undoes every change.
- Or double-click a row in the Controls window (<kbd>F1</kbd>).
@@ -435,7 +435,7 @@ which action lost it.
### Store Config and friends
-All in **Preferences > Config**:
+All in **Edit > Preferences > Config**:
| Item | What it does |
|---|---|
@@ -454,7 +454,7 @@ tab) doesn't count as a layout change.
### Layout presets
-The **1**, **2** and **3** buttons in the title strip (also in **Preferences > Config**) switch between three
+The **1**, **2** and **3** buttons in the title strip (also in **Edit > Preferences > Config**) switch between three
layouts:
1. **Standard**: the Tool palette in the right tray and shelves around the canvas.
@@ -466,7 +466,7 @@ Config keeps it.
### Interface preferences
-**Preferences > Interface**:
+**Edit > Preferences > Interface**:
| Setting | Default | What it does |
|---|---|---|
@@ -490,7 +490,7 @@ Quad Remesh, Forge Spheres, Library, Lit Sphere, Clay Block, Add). The command p
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.
-**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),
@@ -509,7 +509,7 @@ left-drag rotates, right- or middle-drag pans and <kbd>Ctrl</kbd>+drag zooms (se
### The background
-**Preferences > Display** (and the **Render** palette) sets the view's **Background**: **Gradient**, the
+**Edit > Preferences > Display** (and the **Render** palette) sets the view's **Background**: **Gradient**, the
charcoal radial gradient (the default), or **Flat Colour**, one solid colour without the gradient. Click the
**Background colour** swatch to pick the colour; picking one switches to Flat Colour. **Store Config** keeps the
choice for the next session, and each project keeps the background it was saved with. From a script:
@@ -518,15 +518,15 @@ choice for the next session, and each project keeps the background it was saved
> **ZBrush:** like turning the gradient off in the Document palette (**Range** 0) and choosing the **Back**
> colour.
-**Preferences > Library** has **Show at startup** (on by default), the number of **Rows**, **Placement**
+**Edit > Preferences > Library** has **Show at startup** (on by default), the number of **Rows**, **Placement**
(along the top of the canvas, or at the bottom above the bottom shelf) and the **Library folder**.
-**Preferences > Autosave** sets how often a recovery copy is saved (see [Projects, autosave and snapshots](projects.md)).
+**Edit > Preferences > Autosave** sets how often a recovery copy is saved (see [Projects, autosave and snapshots](projects.md)).
-![The Preferences palette with the Config and Interface sub-palettes](images/preferences.jpg)
+![**Edit > Preferences** with the Config and Interface sub-palettes](images/preferences.jpg)
### Fullscreen, the palette bar and the camera notch
-- <kbd>F11</kbd> (or **Render > Fullscreen**) fills the screen with SculptForge; press it again to go back to
+- <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.
- <kbd>Tab</kbd> hides the shelves and trays.
diff --git a/docs/guide/navigation.md b/docs/guide/navigation.md
index 082f67ab..cadf953b 100644
--- a/docs/guide/navigation.md
+++ b/docs/guide/navigation.md
@@ -9,7 +9,7 @@ The camera orbits around a target point. By default rotation is **free**, as in
model about the screen's own axes, so it follows the cursor and can roll right over the top. Hold
<kbd>Shift</kbd> while rotating to snap to the nearest front, back, side, top or bottom view; let go of
<kbd>Shift</kbd> and the drag carries on from where the cursor is. If you prefer the model to stay upright, as
-in Blender or Maya, set **Preferences > Interface > Rotation** to **Turntable**: sideways drags then turn the
+in Blender or Maya, set **Edit > Preferences > Interface > Rotation** to **Turntable**: sideways drags then turn the
model around its vertical axis and up-down drags tilt it, stopping just short of looking straight down or up.
Panning moves the target; zooming moves the camera closer to it or further away. The view is a perspective
@@ -17,12 +17,12 @@ view with a 35 degree field of view, or orthographic (<kbd>Numpad 5</kbd>): no f
shrink with depth. The front, side and top views (<kbd>Numpad 1</kbd>, <kbd>3</kbd>, <kbd>7</kbd>) switch to
orthographic until you rotate again, as in Blender.
-The X / Y / Z gizmo in the top left of the canvas (**Draw > Camera > Axes**) shows the world axes as the camera
+The X / Y / Z gizmo in the top left of the canvas (**Sculpt > Draw & Tablet > Camera > Axes**) shows the world axes as the camera
sees them. Click an end to look from that side, as in Blender: **X** the right view, **Y** the top, **Z** the front,
and the plain dot at the other end of each axis the left, bottom or back view. These are orthographic like the
numpad views. The end under the pointer gets a ring.
-**Draw > Camera > Gizmo size** makes the axes **Small**, **Medium** (the default) or **Large**; they grow with the
+**Sculpt > Draw & Tablet > Camera > Gizmo size** makes the axes **Small**, **Medium** (the default) or **Large**; they grow with the
UI scale too, and clicking an end works at every size. **View Figure** (beside **Axes**, off until you turn it on)
adds a small shaded head in the corner that turns with the camera, so you can tell front from back at a glance.
Click it to look from the nearest side: the front, back, left, right, top or bottom view, orthographic like the
@@ -37,10 +37,10 @@ camera.
> navigation. As in ZBrush, dragging up (forward) zooms out and dragging down zooms in, and when you rotate or pan
> the model follows the cursor. The right-shelf Move, Zoom and Rotate buttons work as in ZBrush.
-> **Blender:** with **Preferences > Input > Style** on **Blender**, middle-drag rotates, <kbd>Shift</kbd>+middle-drag
+> **Blender:** with **Edit > Preferences > Input > Style** on **Blender**, middle-drag rotates, <kbd>Shift</kbd>+middle-drag
> pans and <kbd>Ctrl</kbd>+middle-drag zooms. With a pen or a trackpad, <kbd>Alt</kbd>+left-drag beside the model
> does the same (add <kbd>Shift</kbd> to pan, anywhere; <kbd>Ctrl</kbd> to zoom); on the model it masks, as in
-> Blender 5.1 and later. Turn on **Preferences > Input > Emulate 3 Button Mouse** to make <kbd>Alt</kbd>+left-drag
+> Blender 5.1 and later. Turn on **Edit > Preferences > Input > Emulate 3 Button Mouse** to make <kbd>Alt</kbd>+left-drag
> turn the view everywhere, as that Blender preference does. The numpad views, <kbd>Numpad .</kbd> and <kbd>Home</kbd> frame as in Blender. See
> [Blender keys](shortcuts.md#blender-keys).
@@ -59,10 +59,10 @@ camera.
| Turn in 15 degree steps | <kbd>Numpad 4</kbd> / <kbd>Numpad 6</kbd> (around), <kbd>Numpad 8</kbd> / <kbd>Numpad 2</kbd> (over); <kbd>Numpad 9</kbd>: the other side |
| Frame the active Part | <kbd>Numpad .</kbd> |
| Frame one Part | <kbd>Shift</kbd>+<kbd>Alt</kbd>+click it, or triple-click another Part (it becomes the active Part) |
-| Sculpt from the background | Turn on **Preferences > Input > Start strokes off the model**, **View > Lock camera**, or press <kbd>Shift</kbd>+<kbd>L</kbd>: a left-drag that starts beside the model sculpts once it reaches the surface |
-| Move the camera with Space held | Turn on **Preferences > Input > Hold Space and drag to move the camera**, then hold <kbd>Space</kbd>: left-drag rotates, right- or middle-drag pans, <kbd>Ctrl</kbd>+drag zooms, anywhere on the canvas (on the model too) |
+| Sculpt from the background | Turn on **Edit > Preferences > Input > Start strokes off the model**, **View > Lock camera**, or press <kbd>Shift</kbd>+<kbd>L</kbd>: a left-drag that starts beside the model sculpts once it reaches the surface |
+| Move the camera with Space held | Turn on **Edit > Preferences > Input > Hold Space and drag to move the camera**, then hold <kbd>Space</kbd>: left-drag rotates, right- or middle-drag pans, <kbd>Ctrl</kbd>+drag zooms, anywhere on the canvas (on the model too) |
-Zoom drags: drag up to come closer, down to back away. With the ZBrush-style keys (**Preferences > Input**)
+Zoom drags: drag up to come closer, down to back away. With the ZBrush-style keys (**Edit > Preferences > Input**)
they go the ZBrush way: drag up to zoom out, down to zoom in.
**Hold Space and drag to move the camera** is off by default, because in ZBrush <kbd>Space</kbd> opens the
@@ -114,7 +114,7 @@ directly as a USB device, without 3Dconnexion's driver or SDK, so this is **expe
with simulated input only, not yet with a real SpaceMouse. Tell us how it works with yours
([GitHub issue #6](https://github.com/islandmed/SculptForge/issues/6)).
-Plug it in and it works: **Preferences > Input** shows its name under **SpaceMouse (experimental)**, with live
+Plug it in and it works: **Edit > Preferences > Input** shows its name under **SpaceMouse (experimental)**, with live
bars for its six axes. The model moves the way you move the cap, and turns about the same point the mouse
orbits around (the camera's target: **Frame** sets it to the scene's centre, and panning moves it).
@@ -134,7 +134,7 @@ machine as on a fast one. It works in every input style (SculptForge, ZBrush-sty
held: the stroke keeps going, sculpting wherever the pen points on the turned model. Many people stop moving the
pen while they turn the view, and that works best, but you don't have to.
-**Preferences > Input > SpaceMouse:**
+**Edit > Preferences > Input > SpaceMouse:**
- **Use SpaceMouse**: off ignores it completely, buttons too.
- **Speed**: how fast the view moves for the same push.
@@ -188,7 +188,7 @@ These live on the right shelf and in the **Render** palette:
- **Mask**: darkens masked areas.
- **Paint**: shows vertex paint colours (off shows the plain material).
- **Solo**: shows only the active Part, to get at parts hidden behind others.
-- **Show Mesh** (Render palette): hides the sculpt, for example to look at a splat capture on its own.
+- **Show Mesh** (**View** menu): hides the sculpt, for example to look at a splat capture on its own.
**Fullscreen** (<kbd>F11</kbd>) and hiding the shelves (<kbd>Tab</kbd>) give the canvas the most room. See
[The interface](interface.md).
diff --git a/docs/guide/packs-and-macros.md b/docs/guide/packs-and-macros.md
index d08c3dff..290cb495 100644
--- a/docs/guide/packs-and-macros.md
+++ b/docs/guide/packs-and-macros.md
@@ -31,7 +31,7 @@ example **Clay (Member pack)**.
| Alphas | The Alpha picker (a **Packs** section) and **Library > Alpha**, as **Name (Pack)**. |
| Lit Spheres | **Material** and **Library > Material**, as **Name (Pack)**. |
| Material Recipes | The **Material Recipe** list under **Tool > Paint Layers > Fill**, as **Name (Pack)**. |
-| Keymaps | **Library > Packs > Details > Apply keymap**, and **Preferences > Input > Pack keymaps**. |
+| Keymaps | **Library > Packs > Details > Apply keymap**, and **Edit > Preferences > Input > Pack keymaps**. |
| Pie menus | **Library > Packs > Details > Add pie menu** (it becomes one of your radial menus). |
| Macros | <kbd>F3</kbd>, the key editor and the pie menus, as **Name (Pack)**. |
@@ -100,9 +100,9 @@ values it needs. **Save** writes it to your macros folder; **Run** runs it.
Every saved macro (yours and those of enabled packs) is an action:
- <kbd>F3</kbd>: type its name and press <kbd>Enter</kbd>.
-- **Preferences > Hotkeys**: find it with the filter and give it a key, like any other action (see
+- **Edit > Preferences > Hotkeys**: find it with the filter and give it a key, like any other action (see
[Assign shortcuts](interface.md#assign-shortcuts)).
-- **Preferences > Input > Radial Menus**: put it in a pie menu slot.
+- **Edit > Preferences > Input > Radial Menus**: put it in a pie menu slot.
- **Library > Packs**: **Run** next to your macros, or in a pack's **Details**.
The first time a macro runs, SculptForge shows its whole command list and asks. Click **Run** to go on; you are
diff --git a/docs/guide/pbr-painting.md b/docs/guide/pbr-painting.md
index e7c32b37..5df8b8a2 100644
--- a/docs/guide/pbr-painting.md
+++ b/docs/guide/pbr-painting.md
@@ -31,13 +31,13 @@ what was painted in it; **Undo** brings it back.
2. Open **Tool > Texture Map**. Under **Material Channels**, tick the channels you want (for a typical game asset:
Roughness, Metallic and Normal; add Height to paint relief, Ambient Occlusion to paint dirt into crevices).
3. **Channel memory** below the ticks shows what the painted tiles use; the same number, for every Part, is in
- **Preferences > Performance** under Memory.
+ **Edit > Preferences > Performance** under Memory.
## Paint a material
Open the **Color** palette. With a material texture, a **Material** section appears under the swatches:
-![Color > Material: material swatches, and per channel a tick, value swatches and a slider; Material Channels in Tool > Texture Map](images/pbr-brush-material.jpg)
+![Paint > Material: material swatches, and per channel a tick, value swatches and a slider; Material Channels in Tool > Texture Map](images/pbr-brush-material.jpg)
- **Material swatches** set the colour, roughness and metallic at once (bare metal, gold, copper, rust, gloss
@@ -71,7 +71,7 @@ Merge down and Flatten keep the look of every channel. Duplicate copies a layer
## The PBR viewport
-**Material > Viewport Shading** switches the view between **Lit Sphere** (the default, made for reading forms
+**Render > Materials > Viewport Shading** switches the view between **Lit Sphere** (the default, made for reading forms
while sculpting) and **PBR**, which lights the material channels the way game engines and renderers do: rough
surfaces spread the light, metals reflect the environment in their own colour, painted height and normals catch
the light, emissive glows.
@@ -137,6 +137,6 @@ material channels is still saved as format 6, so older versions keep opening it.
- One texture per Part (UDIM tiles bake as files, [Baking](baking.md), but paint goes into one texture).
- Memory: colour, roughness, metallic, height and AO on Base plus three layers, each with a few big strokes,
take about 370 MB at 4K and 1.5 GB at 8K (most of it the colour layers); a layer painted everywhere adds about
- 200 MB of channels at 4K and 800 MB at 8K. Preferences > Performance shows the numbers for your scene. Paint at
+ 200 MB of channels at 4K and 800 MB at 8K. Edit > Preferences > Performance shows the numbers for your scene. Paint at
4K unless you need 8K.
- Export Maps takes a few seconds at 4K and about ten at 8K (PNG compression).
diff --git a/docs/guide/performance.md b/docs/guide/performance.md
index 47777c06..e457097b 100644
--- a/docs/guide/performance.md
+++ b/docs/guide/performance.md
@@ -3,10 +3,10 @@
SculptForge is built to sculpt tens of millions of polygons. Brushes, normal updates and the picking structure
run on every core of your processor, a stroke sends the graphics card only the part of the mesh it changed, and
undo stores only the vertices a stroke touched, so it stays quick however big the model is. This chapter
-explains what to expect, the settings in **Preferences > Performance**, and how to get the most out of a big
+explains what to expect, the settings in **Edit > Preferences > Performance**, and how to get the most out of a big
sculpt.
-![Preferences > Performance after a stroke: antialiasing, Fast Navigation, multithreading, what the stroke cost per dab, and memory](images/performance-panel.jpg)
+![Edit > Preferences > Performance after a stroke: antialiasing, Fast Navigation, multithreading, what the stroke cost per dab, and memory](images/performance-panel.jpg)
## What to expect
@@ -30,7 +30,7 @@ change to the graphics card is about a third.
[Performance figures](https://github.com/islandmed/SculptForge/blob/main/docs/performance.md) has the full
measurements, and how to run the same benchmark on your own machine.
-## Preferences > Performance
+## Edit > Preferences > Performance
Open **Preferences** and click **Performance**.
@@ -63,7 +63,7 @@ There are two main profiles and a safe mode:
On a laptop running on battery, whatever its profile, SculptForge sends less data to the graphics card per
frame and aims for 60 frames a second, and the status bar says so; plugged in again, it goes back.
-At the top of **Preferences > Performance**:
+At the top of **Edit > Preferences > Performance**:
| Control | What it does |
|---|---|
@@ -76,7 +76,7 @@ At the top of **Preferences > Performance**:
From a shell, `sculptforge --calibrate` measures and prints the result as JSON.
-Like the other preferences, these last until you quit; **Preferences > Config > Store Config** keeps them. Every
+Like the other preferences, these last until you quit; **Edit > Preferences > Config > Store Config** keeps them. Every
setting is also in the <kbd>F3</kbd> command palette (type "antialiasing", "fast navigation" or
"multithreading").
diff --git a/docs/guide/phone-capture.md b/docs/guide/phone-capture.md
index 7a8b8c0a..0a568ee8 100644
--- a/docs/guide/phone-capture.md
+++ b/docs/guide/phone-capture.md
@@ -65,7 +65,7 @@ it into a Gaussian splat that sharpens in the viewport while it trains. See [Gau
## One photo to 3D
Tap **One photo to 3D** and take a photo (or choose one). One object, the whole of it in the picture, on a plain
-background works best. SculptForge loads it into **Generate > Image to 3D** and starts generating with the service
+background works best. SculptForge loads it into **Mesh > Generate 3D > Image to 3D** and starts generating with the service
chosen there (free Hugging Face models by default). Turn off **Generate from a photo at once** in the window to
check the photo first and press **Generate** yourself. See [Image and text to 3D](generate-3d.md).
diff --git a/docs/guide/projects.md b/docs/guide/projects.md
index 275ef65f..1e9ce4a5 100644
--- a/docs/guide/projects.md
+++ b/docs/guide/projects.md
@@ -97,7 +97,7 @@ Dropping an image or a `.sfbrush` file never asks, because it doesn't replace th
While the scene has unsaved changes, SculptForge writes a recovery copy every few minutes (every 5 minutes by
default; it waits until you finish a stroke). Change the interval, or turn it off with 0, in
-**Preferences > Autosave** or with the **Autosave (min)** slider in the File palette (0 to 60 minutes).
+**Edit > Preferences > Autosave** or with the **Autosave (min)** slider in the File palette (0 to 60 minutes).
The recovery copy is `autosave.sfproj` in the SculptForge settings folder (see
[Troubleshooting](troubleshooting.md) for where that is on your system). It is deleted once your work is saved or
@@ -125,7 +125,7 @@ is safe to take before any risky step.
- They appear in the Library **Snapshots** tab, newest first, labelled with their date and time. Double-click one
to open it. The tab also has a **Save now** button.
-With the ZBrush-style keys (**Preferences > Input**) <kbd>9</kbd> takes a snapshot; otherwise it has no default
+With the ZBrush-style keys (**Edit > Preferences > Input**) <kbd>9</kbd> takes a snapshot; otherwise it has no default
shortcut. To give it one, hold <kbd>Ctrl</kbd>+<kbd>Alt</kbd>, click the **Snapshot**
button and press a key (see [The interface](interface.md)).
@@ -145,7 +145,7 @@ on first use with these sub-folders:
| `Splats` | Splats | Gaussian splat captures |
| `QuickSave` | Snapshots | Snapshots |
-Change it in **Preferences > Library > Library folder**, then Store Config (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>)
+Change it in **Edit > Preferences > Library > Library folder**, then Store Config (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>)
to keep the setting.
Press <kbd>,</kbd> (comma) to show the Library. The tabs that matter for projects:
diff --git a/docs/guide/scan-to-sculptable.md b/docs/guide/scan-to-sculptable.md
index 048cba96..79b7101b 100644
--- a/docs/guide/scan-to-sculptable.md
+++ b/docs/guide/scan-to-sculptable.md
@@ -20,14 +20,14 @@ A progress bar and **Cancel** show while it works. When it's done:
- a new Part named after the capture holds the sculptable mesh, and is active;
- a hidden **"<name> Scan"** Part keeps the dense voxel surface it was made from (turn off **Keep scan** if you
don't want it);
-- the splats are hidden, not deleted (**Show** in the Splats palette brings them back);
+- the splats are hidden, not deleted (**Show** in **Render > Gaussian Splats** brings them back);
- an untouched starting sphere is hidden too.
-No capture at hand? **Try a test head** in the Splats palette (shown while no splats are loaded) loads a built-in
+No capture at hand? **Try a test head** in **Render > Gaussian Splats** (shown while no splats are loaded) loads a built-in
one: a stylised head as 200,000 coloured splats with a few floaters and the hidden inside splats real captures
have. `splat_test_capture kind=object` loads a mug with a thin handle instead.
-![The From scan section of the Splats palette](images/make-sculptable-panel.jpg)
+![The From scan section of **Render > Gaussian Splats**](images/make-sculptable-panel.jpg)
## The options
diff --git a/docs/guide/scan-to-splat.md b/docs/guide/scan-to-splat.md
index 9ba4fca7..43cfc853 100644
--- a/docs/guide/scan-to-splat.md
+++ b/docs/guide/scan-to-splat.md
@@ -65,7 +65,7 @@ The panel over the viewport shows the step, the quality so far, how long it has
- **Cancel** ends training and saves nothing.
You can orbit, pan and zoom while it trains. While the splat trains, the sculpt is hidden so the splat isn't
-inside it; tick **Show mesh** in the Splats palette to bring it back.
+inside it; tick **Show mesh** in **Render > Gaussian Splats** to bring it back.
## Presets
@@ -87,7 +87,7 @@ A copy goes into the **Splats** tab of the Library, so you can open it again lat
the result holds the frames, the camera positions and the logs (`brush.log`, `colmap.log`); you can delete it.
The splat comes in centred and upright: SculptForge uses the camera positions to put the object at the middle of
-the scene with the cameras' "up" pointing up. Use **Flip**, **Turn 90** and **Fit** in the Splats palette if it
+the scene with the cameras' "up" pointing up. Use **Flip**, **Turn 90** and **Fit** in **Render > Gaussian Splats** if it
still needs a turn. Then:
- [Make it sculptable](scan-to-sculptable.md).
diff --git a/docs/guide/scripting.md b/docs/guide/scripting.md
index 8d3ee146..2206d199 100644
--- a/docs/guide/scripting.md
+++ b/docs/guide/scripting.md
@@ -35,7 +35,7 @@ Scripts stop at the first command that fails.
## The console
-Press the backtick key (left of <kbd>1</kbd>), or choose **Script > Console**, to open the console strip above
+Press the backtick key (left of <kbd>1</kbd>), or choose **File > Script > Console**, to open the console strip above
the bottom shelf. Drag its top edge to resize it.
![The console showing commands run from the interface and typed by hand](images/console.jpg)
diff --git a/docs/guide/sculpting.md b/docs/guide/sculpting.md
index 24649f85..feecce6e 100644
--- a/docs/guide/sculpting.md
+++ b/docs/guide/sculpting.md
@@ -69,7 +69,7 @@ Notes on particular brushes:
Besides the built-in brushes, SculptForge ships seven custom brushes. They are *recipes*: data that you can
open and change in [Brush Lab](brush-lab.md). They appear in the **Custom** section of the brush picker and
-in **Brush > Custom brushes**.
+in **Sculpt > Brush > Custom brushes**.
| Brush | What it does |
|---|---|
@@ -93,7 +93,7 @@ You can choose a brush in several places:
- **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.
- **Brush tile** at the top of the left shelf: click it to open the brush picker beside it.
-- **Brush palette**: the same grid of thumbnails, with a filter field, plus your custom brush list.
+- **Sculpt > Brush**: the same grid of thumbnails, with a filter field, plus your custom brush list.
- **Command palette** (<kbd>F3</kbd>): type the brush name and press <kbd>Enter</kbd>.
### The brush picker
@@ -152,7 +152,7 @@ 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.
-**Preferences > Input > Cursor follows surface** (on by default) switches back to flat rings everywhere.
+**Edit > Preferences > Input > Cursor follows surface** (on by default) switches back to flat rings everywhere.
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.
@@ -164,11 +164,11 @@ and [alpha](#alphas). That includes custom and Community brushes. Set up a small
Clay brush, and each one comes back the way you left it when you switch between them. A brush you haven't used
yet in the session starts from the values you have now, so nothing jumps.
-- **Brush > Save Brush Settings** keeps the current brush's values for every new session (in
+- **Sculpt > Brush > Save Brush Settings** keeps the current brush's values for every new session (in
`brush-settings.json`, in SculptForge's user data folder).
-- **Brush > Reset Brush to Default** puts the current brush back to the values SculptForge ships with and
+- **Sculpt > Brush > Reset Brush to Default** puts the current brush back to the values SculptForge ships with and
forgets what you saved for it.
-- **Preferences > Input > Share size and intensity across brushes** (off by default) keeps Draw Size and
+- **Edit > Preferences > Input > Share size and intensity across brushes** (off by default) keeps Draw Size and
Intensity the same for every brush, as before 0.10.8. Falloff, RGB Intensity, the stroke and the alpha still
follow each brush.
@@ -194,7 +194,7 @@ On a micro level (see [Micro levels](micro-levels.md)) Smooth is always the plai
(after Quad Remesh, or an imported quad model) Smooth follows the quads' own edges, never their diagonals, so the
quads keep their shape (#69).
-![The Draw palette](images/draw-palette.jpg)
+![**Sculpt > Draw & Tablet**](images/draw-palette.jpg)
## Sculpt, Paint, Add, Sub, Rgb and Front
@@ -241,7 +241,7 @@ Move, Tendril, Elastic Tendril and KelvinGrab normally move the surface across t
you start the stroke (<kbd>Ctrl</kbd> in the Blender and Maya styles, where that key inverts) and the surface moves
along the average normal under the brush where you pressed instead (from the discussions): drag out and it pulls
straight out of the surface, drag back and it pushes straight in, however the view is turned. When the normal
-points right at you, drag up to pull it out. **Preferences > Input > Along the normal** can make it **Always**
+points right at you, drag up to pull it out. **Edit > Preferences > Input > Along the normal** can make it **Always**
(no key needed, handy with a pen) or **Never**.
## The Quick Menu
@@ -253,8 +253,8 @@ keep it open until you click elsewhere or press <kbd>Esc</kbd>. Clicking a tile
A right click on the canvas opens it too, as in ZBrush: press the right button and let go without moving, beside
the model or on it, and the Quick Menu stays open at the cursor. A right drag still turns the view (and pans or
-zooms with <kbd>Alt</kbd> or <kbd>Ctrl</kbd>), and a pen button set to **Right click** (Preferences > Tablet)
-works the same way. Turn it off with **Preferences > Input > Right click opens the Quick Menu**.
+zooms with <kbd>Alt</kbd> or <kbd>Ctrl</kbd>), and a pen button set to **Right click** (Edit > Preferences > Tablet)
+works the same way. Turn it off with **Edit > Preferences > Input > Right click opens the Quick Menu**.
## Radial menus
@@ -267,17 +267,17 @@ click an item, or click in the middle or press <kbd>Esc</kbd> to close it. Two m
| <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 |
-Both keys are free in every input style. Make your own in **Preferences > Input > Radial Menus** (up to 8 menus of
+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):
- **+** 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.
- Click an item to give it your own **label** and **icon**, or **Change action**. The arrows reorder items (the
first points up, the rest go clockwise); the cross removes one.
-- **Key** sets the key that opens the menu (it is an ordinary shortcut, so **Preferences > Hotkeys** lists it
+- **Key** sets the key that opens the menu (it is an ordinary shortcut, so **Edit > Preferences > Hotkeys** lists it
too). The button next to it can also open the menu while held: the middle, right, back or forward mouse button,
or one of the pen's side buttons. That button then stops doing what it did before (a pen button's
- Preferences > Tablet mapping, the middle button's pan, the right button's turn). A mouse button opens the menu
+ Edit > Preferences > Tablet mapping, the middle button's pan, the right button's turn). A mouse button opens the menu
only with no modifier key held (#74): <kbd>Alt</kbd>+middle still pans, <kbd>Alt</kbd>+right still zooms in the
Maya style, and <kbd>Shift</kbd>+right-drag still turns the view, so a menu on the right button never leaves you
without a way to turn it (the panel says how).
@@ -407,7 +407,7 @@ click: a horn, an ear, a cluster of scales, a nostril. An alpha can only push th
displacement map (VDM) moves every point of the stamp in any direction, so the shape can lean over, curl and
overhang, as nothing made with a height ever can.
-![Horns, an ear curl, scales and two nostrils, one stamp each, and Brush > Vector Displacement](images/vdm-brushes.jpg)
+![Horns, an ear curl, scales and two nostrils, one stamp each, and Sculpt > Brush > Vector Displacement](images/vdm-brushes.jpg)
### Stamp a VDM
@@ -436,7 +436,7 @@ overhang, as nothing made with a height ever can.
### Make your own VDM
-1. In **Brush > Vector Displacement**, click **New VDM Plane**. A flat 2 x 2 grid appears as a new Part,
+1. In **Sculpt > Brush > Vector Displacement**, click **New VDM Plane**. A flat 2 x 2 grid appears as a new Part,
seen from the top, with its border masked (so the stamp blends into any surface); the other Parts are
hidden. **Plane Res** sets how many quads it has (256 by default).
2. Sculpt the shape with any brush: overhangs are welcome (Move, Tendril, Inflate). Divide the plane for finer
@@ -505,7 +505,7 @@ radius, and the material around it reacts the way real material does.
- **Elastic Tendril** pulls horns, tentacles and spikes out along the stroke like Tendril, but its pull narrows as it
travels, so shapes taper to a tip by themselves.
-Their settings are in **Brush > Kelvinlet & Capture**:
+Their settings are in **Sculpt > Brush > Kelvinlet & Capture**:
- **Squash** (0-100) is how the material keeps its volume (its Poisson's ratio). At 0 it's rubbery: pulling it
just stretches it. At 100 it's incompressible clay: pressing in makes the surface bulge up around your thumb and
@@ -527,7 +527,7 @@ layers, and each stroke is one undo step. They don't remesh with dynamic topolog
## Capture an alpha or a VDM from the model
Any detail you have sculpted can become a brush in two seconds: **Capture from view**
-(<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>C</kbd>, or the button in **Brush > Kelvinlet & Capture**).
+(<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>C</kbd>, or the button in **Sculpt > Brush > Kelvinlet & Capture**).
![A horn captured from the sphere (the window: its height alpha and VDM) and cloned along a stroke below it](images/capture-from-view.jpg)
@@ -545,7 +545,7 @@ Any detail you have sculpted can become a brush in two seconds: **Capture from v
4. Use it: **Use as Alpha** (it shapes every brush), **Use as VDM** (the VDM brush stamps it with Drag Stamp),
**Detail Clone** (paint copies along strokes) or **Save to Library**: the alpha goes to your Library
**Alphas** folder as a PNG and the VDM to your brush library, both with thumbnails (the VDM also shows in the
- Library **Brush** tab, the alpha picker and Brush > Vector Displacement).
+ Library **Brush** tab, the alpha picker and Sculpt > Brush > Vector Displacement).
The square is captured along your view, so look at the detail straight on. The capture takes about a tenth of a
second for a small detail and a second or so for a large patch of a 20-million-triangle model.
@@ -580,7 +580,7 @@ the other side, the model is off-centre: turn on **Local** (below).
### Radial symmetry
Radial symmetry repeats every stroke around an axis, for wheels, flowers, columns, crowns and other round
-ornaments. Turn it on with **R** on the top shelf or in **Transform > Symmetry**, then set:
+ornaments. Turn it on with **R** on the top shelf or in **Sculpt > Symmetry & Gizmo > Symmetry**, then set:
- **Radial Count**: how many copies, evenly spaced around the axis (2 to 64; 8 to start with).
- **X axis**, **Y axis** or **Z axis**: the axis the copies turn around (Y, up, by default).
@@ -593,7 +593,7 @@ one lands.
### Local symmetry
-**Local** (next to **R** in **Transform > Symmetry**) puts the mirror planes and the radial axis through the
+**Local** (next to **R** in **Sculpt > Symmetry & Gizmo > Symmetry**) puts the mirror planes and the radial axis through the
middle of the active Part (the centre of its bounding box) instead of the world origin. Use it for a Part that
isn't centred on the origin, such as a button on a jacket or a wheel on a car. The centre follows the Part: it is
worked out again when you switch Parts or after an edit.
@@ -613,7 +613,7 @@ SculptForge reads pen pressure from graphics tablets and pen displays through th
receives pen input, the **Draw** palette shows **Pen pressure** with the current value; before that it says
**No pen detected**.
-Two toggles decide what pressure does. They are on the top shelf and in **Draw > Tablet**:
+Two toggles decide what pressure does. They are on the top shelf and in **Sculpt > Draw & Tablet > Tablet**:
| Toggle | Default | Effect |
|---|---|---|
@@ -625,14 +625,14 @@ also have a **Pressure curve** setting that makes them respond to a light or a f
[Brush Lab](brush-lab.md)). If the pen moves the cursor but pressure does nothing, see
[Troubleshooting](troubleshooting.md).
-**Preferences > Tablet** checks and tunes the pen:
+**Edit > Preferences > Tablet** checks and tunes the pen:
- a pressure meter and a draw-test area, to see what the tablet reports at a light touch and a full press;
- a pressure curve for all brushes (Soft, Linear or Firm, or set **Curve**, **Minimum**, **Maximum**, **Threshold**
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).
@@ -651,7 +651,7 @@ Move, Smooth, Inflate, Pinch, Flatten, Crease, Trim, Tendril, Layer, Nudge and P
- **Add a brush**: click the **+** tile at the end of the shelf and pick a brush, built-in or custom. Or
right-click any tile in the brush picker and choose **Add to bottom shelf**.
- **Remove a brush**: right-click its tile and choose **Remove from shelf**.
-- **Reorder**: turn on **Preferences > Config > Enable Customize**, then <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+drag a
+- **Reorder**: turn on **Edit > Preferences > Config > Enable Customize**, then <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+drag a
tile to a new place.
- **Change a brush's key**: <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+click its tile, then press the new key.
diff --git a/docs/guide/shortcuts.md b/docs/guide/shortcuts.md
index d06173a3..d9533eb9 100644
--- a/docs/guide/shortcuts.md
+++ b/docs/guide/shortcuts.md
@@ -3,7 +3,7 @@
This chapter is the reference for every default keyboard shortcut and mouse gesture in SculptForge. Inside the
app, <kbd>F1</kbd> opens the same list as the Controls window, showing your own keys if you've changed any.
-SculptForge has four key styles, chosen in **Preferences > Input > Style** (and by the **Coming from** question the
+SculptForge has four key styles, chosen in **Edit > Preferences > Input > Style** (and by the **Coming from** question the
first time SculptForge starts): **SculptForge** (the default for new installs), **ZBrush-style**, **Blender** and
**Maya**. The main table shows the SculptForge style; the sections after it list what the
[ZBrush-style](#zbrush-style-keys) and [Blender](#blender-keys) styles change. If you used an earlier version,
@@ -12,7 +12,7 @@ your saved style is kept.
## Changing shortcuts
Every key below can be reassigned: hold <kbd>Ctrl</kbd>+<kbd>Alt</kbd> and click a button, then press the new
-key, or use **Preferences > Hotkeys**. Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (Store Config) to
+key, or use **Edit > Preferences > Hotkeys**. Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (Store Config) to
keep your changes. See [Customizing the interface](interface.md#customizing-the-interface).
On macOS, <kbd>Cmd</kbd> works wherever a shortcut says <kbd>Ctrl</kbd>. Single-letter shortcuts don't fire
@@ -106,8 +106,8 @@ generated from SculptForge's action registry, the same source as the Controls wi
| Action | Keys | What it does |
|---|---|---|
| Load UI... | <kbd>Ctrl</kbd>+<kbd>L</kbd> | Load a layout file someone shared (or you saved with Save UI). |
-| Radial menu 1: Brushes | <kbd>T</kbd> | Hold the key, flick toward an item and let go to run it; or tap the key and click one. Edit it in Preferences > Input > Radial Menus. |
-| Radial menu 2: Masking | <kbd>Y</kbd> | Hold the key, flick toward an item and let go to run it; or tap the key and click one. Edit it in Preferences > Input > Radial Menus. |
+| Radial menu 1: Brushes | <kbd>T</kbd> | Hold the key, flick toward an item and let go to run it; or tap the key and click one. Edit it in Edit > Preferences > Input > Radial Menus. |
+| Radial menu 2: Masking | <kbd>Y</kbd> | Hold the key, flick toward an item and let go to run it; or tap the key and click one. Edit it in Edit > Preferences > Input > Radial Menus. |
| Save UI... | <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> | Save the layout, shortcuts and interface preferences to a file you can share. |
| Shelves | <kbd>Tab</kbd> | Hide or show the shelves and trays around the canvas. |
| Store Config | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> | Keep the current layout, shortcuts and interface preferences for future sessions. Like ZBrush, SculptForge never saves them on its own. |
@@ -181,7 +181,7 @@ generated from SculptForge's action registry, the same source as the Controls wi
| Action | Keys | What it does |
|---|---|---|
-| Lock camera | <kbd>Shift</kbd>+<kbd>L</kbd> | Lock the camera for left-drags: a drag that starts on the background sculpts once it reaches the model instead of turning the view (Preferences > Input > Start strokes off the model, #62). The status bar shows CAMERA LOCKED while it is on. Right-drag or Alt+drag still move the view. Shift+L turns it on and off. |
+| Lock camera | <kbd>Shift</kbd>+<kbd>L</kbd> | Lock the camera for left-drags: a drag that starts on the background sculpts once it reaches the model instead of turning the view (Edit > Preferences > Input > Start strokes off the model, #62). The status bar shows CAMERA LOCKED while it is on. Right-drag or Alt+drag still move the view. Shift+L turns it on and off. |
<!-- END GENERATED: shortcuts -->
@@ -190,7 +190,7 @@ generated from SculptForge's action registry, the same source as the Controls wi
| Action | Gesture |
|---|---|
| Sculpt | Left-drag on the model |
-| Sculpt from beside the model | Turn on **Preferences > Input > Start strokes off the model** (or press <kbd>Shift</kbd>+<kbd>L</kbd>), then left-drag from the background onto the model; the view then turns with a right-drag (see [Navigation](navigation.md#mouse-and-pen)) |
+| Sculpt from beside the model | Turn on **Edit > Preferences > Input > Start strokes off the model** (or press <kbd>Shift</kbd>+<kbd>L</kbd>), then left-drag from the background onto the model; the view then turns with a right-drag (see [Navigation](navigation.md#mouse-and-pen)) |
| Invert the brush (subtract) | Hold <kbd>Alt</kbd> while sculpting |
| Smooth | Hold <kbd>Shift</kbd> while sculpting (works with any brush, and with Paint) |
| Straight line | Press <kbd>Shift</kbd> after a stroke has started (45 degree steps) |
@@ -268,7 +268,7 @@ Some keys only mean something while a pop-up or panel has the keyboard.
## ZBrush-style keys
-With **Preferences > Input > Style** on **ZBrush-style** (also at the top of the Controls window, <kbd>F1</kbd>,
+With **Edit > Preferences > Input > Style** on **ZBrush-style** (also at the top of the Controls window, <kbd>F1</kbd>,
or **ZBrush** in the first-start **Coming from** question), the keys and gestures work as in ZBrush. Store Config
(<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>) keeps the choice. Compared with the table above, these change:
@@ -286,7 +286,7 @@ these ZBrush-style keys and changes only the view controls (<kbd>Alt</kbd>+left,
## Maya keys
-With **Preferences > Input > Style** on **Maya** (#32), the view works as in Maya, on the model or beside it, as
+With **Edit > Preferences > Input > Style** on **Maya** (#32), the view works as in Maya, on the model or beside it, as
long as <kbd>Alt</kbd> is the only key held:
| To | Maya style |
@@ -299,19 +299,19 @@ long as <kbd>Alt</kbd> is the only key held:
| Smooth | Hold <kbd>Shift</kbd> while sculpting |
| Visibility gestures | <kbd>Ctrl</kbd>+<kbd>Shift</kbd>, as in the other styles |
-Maya's default dolly follows a sideways drag, so that is the default here too. **Preferences > Input > Zoom
+Maya's default dolly follows a sideways drag, so that is the default here too. **Edit > Preferences > Input > Zoom
drag** switches it to **Up and down** (drag up to zoom in) if you set Maya up that way. **Invert zoom**, in every
style, turns zoom drags around (the mouse wheel stays as it is).
## Blender keys
-With **Preferences > Input > Style** on **Blender** (also at the top of the Controls window, <kbd>F1</kbd>), the
+With **Edit > Preferences > Input > Style** on **Blender** (also at the top of the Controls window, <kbd>F1</kbd>), the
view and the sculpt keys work as in Blender 4.2 and later, Sculpt Mode (with 5.1's Alt mask). Compared with the table above, these
change in the Blender style:
| To | Blender style |
|---|---|
-| Rotate | Middle-drag, or <kbd>Alt</kbd>+left-drag beside the model (everywhere with **Preferences > Input > Emulate 3 Button Mouse**, for pens and trackpads), or left-drag beside the model |
+| Rotate | Middle-drag, or <kbd>Alt</kbd>+left-drag beside the model (everywhere with **Edit > Preferences > Input > Emulate 3 Button Mouse**, for pens and trackpads), or left-drag beside the model |
| Pan | <kbd>Shift</kbd>+middle-drag, or <kbd>Alt</kbd>+<kbd>Shift</kbd>+left-drag |
| Zoom | Mouse wheel, <kbd>Ctrl</kbd>+middle-drag (up: closer), <kbd>Alt</kbd>+<kbd>Ctrl</kbd>+left-drag, <kbd>Numpad Plus</kbd> / <kbd>Numpad Minus</kbd> |
| Invert the brush (subtract) | Hold <kbd>Ctrl</kbd> while sculpting |
@@ -333,17 +333,17 @@ change in the Blender style:
| Wireframe | <kbd>Shift</kbd>+<kbd>Z</kbd> |
Choosing the Blender style also sets **Rotation** to **Turntable**, as Blender orbits; change it back under
-**Preferences > Input** if you like. Blender's face sets are SculptForge's face groups, and its brushes map to the
+**Edit > Preferences > Input** if you like. Blender's face sets are SculptForge's face groups, and its brushes map to the
nearest SculptForge brush. **Symmetry X**, **Paint** and the material picker have no key in the Blender style
(they are on the shelves); give them one with <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+click. Laptops without a numpad:
-turn on **Preferences > Input > Emulate Numpad** and the number row works as the numpad.
+turn on **Edit > Preferences > Input > Emulate Numpad** and the number row works as the numpad.
The numpad views (<kbd>Numpad 1</kbd>, <kbd>3</kbd>, <kbd>7</kbd>, <kbd>5</kbd> ...) work in every style.
### Your own Blender keymap
If you changed Blender's keys, export them in Blender (**Edit > Preferences > Keymap**, the **Export...** button
-next to the keymap name) and in SculptForge choose **Import Blender keymap...** under **Preferences > Input** or
+next to the keymap name) and in SculptForge choose **Import Blender keymap...** under **Edit > Preferences > Input** or
at the top of the Controls window. SculptForge switches to the Blender style and takes, from the file's 3D View
and Sculpt keymaps, the keys of every action it has an equivalent for: the views, the brushes above, the radius
and strength, the mask, hiding, subdivision levels, undo and redo. Mouse buttons and keys for things
diff --git a/docs/guide/splats.md b/docs/guide/splats.md
index b26951fc..d6a81066 100644
--- a/docs/guide/splats.md
+++ b/docs/guide/splats.md
@@ -5,7 +5,7 @@ Postshot, Scaniverse and KIRI. SculptForge uses them three ways: as a reference
for a sculptable, animation-ready mesh with its colours, and as an output when you turn a sculpt into splats. This chapter covers all
three.
-![A splat capture loaded next to the sculpt, with the Splats palette in the right tray](images/splats.jpg)
+![A splat capture loaded next to the sculpt, with **Render > Gaussian Splats** in the right tray](images/splats.jpg)
To make a splat yourself from a phone video or photos, see [Scan an object into a splat](scan-to-splat.md).
diff --git a/docs/guide/studios.md b/docs/guide/studios.md
index 6f6d9643..268b1ae9 100644
--- a/docs/guide/studios.md
+++ b/docs/guide/studios.md
@@ -184,7 +184,7 @@ for anything else.
Send, in one email or a message in your team channel:
-- **What to bake in:** your exported keymap and layout (**Preferences > Interface**), brush presets and packs
+- **What to bake in:** your exported keymap and layout (**Edit > Preferences > Interface**), brush presets and packs
(`.sfbrush`, `.sfpack`), shelf setup, and the pipeline defaults you want (export format and preset, units
and scale, up axis, naming pattern, texture packing, ZBrush Bridge folder).
- **References for custom content:** images or scans you own, with a line on what each item should do.
diff --git a/docs/guide/texture-painting.md b/docs/guide/texture-painting.md
index 9ea4e04c..7f52f236 100644
--- a/docs/guide/texture-painting.md
+++ b/docs/guide/texture-painting.md
@@ -14,7 +14,7 @@ symmetry, mask and paint layers with blend modes.
## Start in one click
Press <kbd>P</kbd> for the Paint brush (or turn on **Rgb**). While the Part has no texture, **New Texture**
-appears on the top shelf and in the Color palette. Click it: if the model has no UVs, SculptForge runs **Auto
+appears on the top shelf and in the **Paint** menu. Click it: if the model has no UVs, SculptForge runs **Auto
UV** first (in the background; the status bar shows its progress), then gives it a white texture (2K, or the size
chosen in Tool > Texture Map) and switches painting to **Texture**. Paint away. The steps below do the same thing
by hand, with more choices.
@@ -49,7 +49,7 @@ The model shows both: the vertex paint multiplied by the texture, over the mater
the mesh's polygons, it is going into the vertices: check that **Texture** is lit, and that the Part carries no
old vertex paint (Tool > Paint Layers, or **Vertex Paint > Texture** to move it into the texture). Texture paint itself
is as sharp as the texture: a hard alpha gives the same texels on a two-triangle plane as on a dense mesh. Each Part keeps its own
-choice, saved in the project. **Show texture** (Texture Map, or the Color palette) hides the texture in the
+choice, saved in the project. **Show texture** (Texture Map, or the **Paint** menu) hides the texture in the
viewport without deleting it.
## How texture painting works
diff --git a/docs/guide/timeline.md b/docs/guide/timeline.md
index 0acfa8a1..d6c02580 100644
--- a/docs/guide/timeline.md
+++ b/docs/guide/timeline.md
@@ -1,7 +1,7 @@
# Sculpt Timeline and timelapse
Every stroke and operation you make is a step on the **Sculpt Timeline**, the strip along the top of the
-canvas (or its bottom: **Preferences > Interface > Timeline position**). Drag its scrubber to see the model at any point of the session, click a step to go back there, and keep
+canvas (or its bottom: **Edit > Preferences > Interface > Timeline position**). Drag its scrubber to see the model at any point of the session, click a step to go back there, and keep
sculpting from it: the steps you had made after it are not thrown away as with a plain undo, they stay as a
branch you can switch back to. You can change how strongly a past stroke shows without redoing the strokes
after it, and render the whole history as a turntable timelapse video.
diff --git a/docs/guide/troubleshooting.md b/docs/guide/troubleshooting.md
index 2110aac2..865f7937 100644
--- a/docs/guide/troubleshooting.md
+++ b/docs/guide/troubleshooting.md
@@ -49,7 +49,7 @@ documentation** opens links to it).
**Show** in the **Splats** palette while you sculpt.
- On laptops with two GPUs, make sure SculptForge runs on the dedicated one (in the GPU maker's control panel
or the operating system's graphics settings).
-- **Preferences > Performance**: lower **Antialiasing** (or turn it off), keep **Fast Navigation** on, and look
+- **Edit > Preferences > Performance**: lower **Antialiasing** (or turn it off), keep **Fast Navigation** on, and look
at **Last stroke** to see whether brushes or the graphics card take the time. Step down a
[subdivision level](subdivision-levels.md) for big changes. See [Performance and big meshes](performance.md).
- A Part missing from the view with "Not enough GPU memory" in the status bar didn't fit on the graphics
@@ -67,7 +67,7 @@ and similar tablets, and pen displays, work without settings.
3. A custom brush can also set its own pressure response (**pressureCurve** in its recipe, see
[Brush Lab and sharing brushes](brush-lab.md)).
-**Preferences > Input** and **Preferences > Tablet** show "Pressure: on" once the pen has pressed, or
+**Edit > Preferences > Input** and **Edit > Preferences > Tablet** show "Pressure: on" once the pen has pressed, or
"Pressure: not detected". Without pressure the pen still draws, at full strength. A tablet plugged in while
SculptForge runs works straight away; the status bar says "Tablet connected" (also through Wacom Bridge).
@@ -84,7 +84,7 @@ If no pen is detected or pressure doesn't change:
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)**.
+ mode. Turn on **Edit > Preferences > Tablet > Mouse mode (relative)**.
## AI services
@@ -142,13 +142,13 @@ See [Image and text to 3D](generate-3d.md#comfyui-your-own-server) for setup.
On MacBooks with a camera notch, SculptForge keeps the interface below the notch when it fills the screen. If
the title strip or palette bar is still covered, or a plain band appears where you don't want one, change
-**Preferences > Interface > Camera notch**: **Automatic** (asks the system on macOS, recognises notched
+**Edit > Preferences > Interface > Camera notch**: **Automatic** (asks the system on macOS, recognises notched
MacBook displays on Linux), **Always reserve**, or **Off**. <kbd>F11</kbd> switches between fullscreen and a
window.
### Text and buttons are too small or too large
-**Preferences > Interface > UI scale** sets the size (Automatic, 100% to 200%). It takes effect the next time
+**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>).
### My layout or shortcuts are gone after a restart
@@ -159,7 +159,7 @@ preferences. See [The interface](interface.md).
### Reset the interface
-- **Preferences > Config > Restore Standard UI** returns to the built-in layout and default shortcuts. Press
+- **Edit > Preferences > Config > Restore Standard UI** returns to the built-in layout and default shortcuts. Press
**Store Config** afterwards to make it stick.
- **Restore Custom UI** goes back to what the last Store Config saved.
- To start completely fresh, quit SculptForge and delete `ui.json` (layout, shortcuts, interface preferences)
@@ -169,7 +169,7 @@ preferences. See [The interface](interface.md).
Shortcuts don't fire while you type in a text field: click the canvas first. Check the key in **Help >
Controls** (<kbd>F1</kbd>), which shows every shortcut as currently assigned; a key you reassigned shows in
-orange in **Preferences > Hotkeys**, where **Default shortcuts** undoes every change.
+orange in **Edit > Preferences > Hotkeys**, where **Default shortcuts** undoes every change.
## Where settings live
@@ -197,10 +197,10 @@ SculptForge keeps its settings in one folder per user:
| `thumbs/` | Cached Library and picker thumbnails (safe to delete) |
Your **library folder** (projects, tools, alphas, images, splats and QuickSaves shown in the Library) is
-separate: `Documents/SculptForge` by default, changeable in **Preferences > Library > Library folder**.
+separate: `Documents/SculptForge` by default, changeable in **Edit > Preferences > Library > Library folder**.
> **Tip:** To move settings to another computer, copy `ui.json`, `ai.json` and the `brushes` folder. For a
-> shared layout, use **Preferences > Config > Save UI...** and **Load UI...** instead.
+> shared layout, use **Edit > Preferences > Config > Save UI...** and **Load UI...** instead.
## The log file
@@ -221,7 +221,7 @@ no models and no keys, only command names and messages, which may include file n
## Recovering work after a crash
-SculptForge autosaves unsaved work every 5 minutes by default (**Preferences > Autosave**, 0 turns it off).
+SculptForge autosaves unsaved work every 5 minutes by default (**Edit > Preferences > Autosave**, 0 turns it off).
After a crash, the next start asks "SculptForge did not close normally last time. Restore the autosaved
work?". **Restore** opens it as unsaved work (save it under a name); **Discard** deletes it. See
[Projects, autosave and snapshots](projects.md). The dialog also points to the crashed session's
diff --git a/docs/guide/vertex-paint.md b/docs/guide/vertex-paint.md
index 940277b4..80048328 100644
--- a/docs/guide/vertex-paint.md
+++ b/docs/guide/vertex-paint.md
@@ -34,14 +34,14 @@ While the Paint brush is active:
Press <kbd>P</kbd> again, or click **Sculpt** on the top shelf, to go back to sculpting.
-![Vertex Paint on a sculpt with the Color palette open](images/polypaint.jpg)
+![Vertex Paint on a sculpt with the **Paint** menu open](images/polypaint.jpg)
> **ZBrush:** **Paint** is ZBrush's Rgb on with Zadd off. **Sculpt** with **Rgb** on is Rgb with Zadd: the brush
> sculpts and paints at once.
## Paint while sculpting
-Turn on **Rgb** on the top shelf (or **RGB while sculpting** in the Color palette). Every sculpt brush then also
+Turn on **Rgb** on the top shelf (or **RGB while sculpting** in the **Paint** menu). Every sculpt brush then also
paints the current colour along its stroke. The Smooth brush and <kbd>Shift</kbd>-smoothing never paint.
## Choose a colour
@@ -55,7 +55,7 @@ paints the current colour along its stroke. The Smooth brush and <kbd>Shift</kbd
## Fill, cavity paint and clear
-The Color palette has four buttons:
+The **Paint** menu has four buttons:
| Button | What it does |
|---|---|
@@ -90,7 +90,7 @@ Overlay layer, then change or hide it later without repainting the rest. Every P
on an Overlay or Soft Light layer changes nothing, white on Multiply changes nothing, black on Screen changes
nothing.
- The Paint brush, **Rgb** while sculpting, **Fill**, **Fill masked** and **Cavity** all write into the
- **active** layer (highlighted in the list; the Color palette shows "Painting on: ..."). They respect the mask and
+ **active** layer (highlighted in the list; the **Paint** menu shows "Painting on: ..."). They respect the mask and
hidden faces on every layer.
- With the Paint brush on a layer, <kbd>Alt</kbd> **erases** the layer's paint (on Base it paints back towards
white, as before).
@@ -127,7 +127,7 @@ and opacity, a lock and an eye.
lowest layer). **Flatten** bakes every visible layer into Base and removes the layers; hidden layers are
discarded.
- **Clear layer** makes the active layer transparent again (Base: white). **Fill layer** fills it with the current
- colour, like **Fill** in the Color palette.
+ colour, like **Fill** in the **Paint** menu.
Hold <kbd>Ctrl</kbd> over any control for its description. Every action is undoable with <kbd>Ctrl</kbd>+<kbd>Z</kbd>.
@@ -168,7 +168,7 @@ Materials change only how the model is shaded in the viewport. They aren't expor
| Chrome | Mirror-like metal, good for checking surface flow |
| White | Neutral off-white for judging forms |
| Bronze | Polished bronze |
-| Studio | Softer clay shading with studio lighting (the default in earlier versions). Its colour is **Base colour** in the Material palette |
+| Studio | Softer clay shading with studio lighting (the default in earlier versions). Its colour is **Base colour** in **Render > Materials** |
To choose one:
@@ -191,11 +191,11 @@ A Lit Sphere is a picture of a lit sphere (Sloan and others, 2001): the view col
surface faces the same way. Any lit-sphere image made for ZBrush, Blender or Nomad works: a square PNG, JPG or EXR
with the sphere filling it (a non-square image is cropped to its centre; big ones are scaled to 1024 pixels).
-- **Material > Load Lit Sphere...** picks an image. It joins the material list under its file name, the view uses
+- **Render > Materials > Load Lit Sphere...** picks an image. It joins the material list under its file name, the view uses
it, and a copy goes into the **MatCaps** folder of your library (**Documents/SculptForge/MatCaps**, or the
- folder set in **Preferences > Library**), so it is there next time.
+ folder set in **Edit > Preferences > Library**), so it is there next time.
- Or put images into that **MatCaps** folder yourself: they show up the next time you open the material picker,
- the Material palette or the Library's Material tab, no restart needed. Studios can share a read-only folder by
+ **Render > Materials** or the Library's Material tab, no restart needed. Studios can share a read-only folder by
listing it in the `SCULPTFORGE_MATCAP_PATH` environment variable (separated by `:`, `;` on Windows); those load
when SculptForge starts.
- To remove one, right-click it in the material picker or palette and choose **Remove**. An image from your
@@ -203,9 +203,9 @@ with the sphere filling it (a non-square image is cropped to its centre; big one
only hidden until you restart, and the message says where its file is so you can delete it yourself.
Built-in materials can't be removed.
-![A Lit Sphere loaded from an image (Gold) in the Material palette](images/custom-matcaps.jpg)
+![A Lit Sphere loaded from an image (Gold) in **Render > Materials**](images/custom-matcaps.jpg)
-Your Lit Spheres appear in the material picker (<kbd>M</kbd>), the Material palette and the Library, after the
+Your Lit Spheres appear in the material picker (<kbd>M</kbd>), **Render > Materials** and the Library, after the
built-in ones. A project that uses one carries a copy of the image, so it opens with the same look on another
computer (or after you delete the file). Loading an image with the same name again replaces it. EXR images are
read as linear light, so very bright highlights clip to white.
@@ -228,7 +228,7 @@ Shading works with every material, vertex paint, textures and the mask. Like the
exports are unaffected. Projects save the scene's shading and each Part's own; projects from before open with
your preferred shading. The scene's shading you choose is also the preference for the next session once you
**Store Config** (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>). Smooth and Flat have no default shortcut, so no
-ZBrush key changes meaning; assign one under **Preferences > Hotkeys** if you switch often.
+ZBrush key changes meaning; assign one under **Edit > Preferences > Hotkeys** if you switch often.
> **Not yet:** loading your own Lit Sphere images, and physically based materials or BPR-style renders.
diff --git a/docs/guide/welcome.md b/docs/guide/welcome.md
index 478dee8b..a6adf4af 100644
--- a/docs/guide/welcome.md
+++ b/docs/guide/welcome.md
@@ -9,7 +9,7 @@ SculptForge is a focused sculpting tool with the brushes, symmetry, masking and
already know, built around a ZBrush-style interface: shelves around a canvas, alphabetical palettes that hold
every function, a Library of thumbnails and pop-up pickers. It runs natively on Windows, macOS and Linux,
starts in a moment, works offline and costs nothing. ZBrush's keys and gestures are one choice away: answer
-**ZBrush** when the first start asks what you are coming from, or pick **ZBrush-style** in **Preferences > Input**.
+**ZBrush** when the first start asks what you are coming from, or pick **ZBrush-style** in **Edit > Preferences > Input**.
See [Coming from ZBrush](coming-from-zbrush.md). There is no account, no subscription, no licence server
and no telemetry.
@@ -22,7 +22,7 @@ a week early (every release stays free for everyone; bug-fix and security releas
day): **Help > Support SculptForge...** opens [sculptforge.app/support.html](https://sculptforge.app/support.html) in your browser, where you can become a
member. That is all it does: the app has no payment code, no account and no licence check. Supporters are thanked
by name in **Help > About**. While SculptForge starts (the first time, after an update, and at most once a week
-otherwise) a card shows the memberships; **I'm already a supporter** hides it for good and **Preferences > Support**
+otherwise) a card shows the memberships; **I'm already a supporter** hides it for good and **Edit > Preferences > Support**
turns it off. After about ten hours of sculpting, SculptForge also shows one small note about this along the bottom
of the canvas, once, and never again after you close it.
@@ -77,7 +77,7 @@ palettes have the names you expect (Alpha, Brush, Stroke, Tool, Transform...), t
Parts (ZBrush's SubTool), Masking and Face Groups (Polygroups) sub-palettes, <kbd>B</kbd> opens the brush pop-up with the same letter keys
(B, S, T picks Standard), <kbd>,</kbd> opens the Library and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd>
stores your interface, and <kbd>S</kbd> <kbd>U</kbd> <kbd>I</kbd> <kbd>O</kbd>, <kbd>Space</kbd>, <kbd>Ctrl</kbd>+<kbd>W</kbd>
-and the mask keys do what your hands expect with the ZBrush-style keys on (**Preferences > Input**).
+and the mask keys do what your hands expect with the ZBrush-style keys on (**Edit > Preferences > Input**).
[Coming from ZBrush](coming-from-zbrush.md) lists SculptForge's names for ZBrush terms, what is the same,
what differs and every shortcut side by side; the [Glossary](glossary.md) maps ZBrush terms to SculptForge ones.
diff --git a/tools/guide/README.md b/tools/guide/README.md
index 2ceba929..c088bde7 100644
--- a/tools/guide/README.md
+++ b/tools/guide/README.md
@@ -30,3 +30,10 @@ python3 tools/guide/build_site.py --check
Crop rectangles for each image are in `make_images.py`; if the UI layout changes, look at the preview sheet and
adjust them. Re-run cmake after adding or removing guide files so the app embeds them.
+
+## Menu paths
+
+The guide names the default **SculptForge layout**'s menus: **Edit > Preferences > Input**, **Sculpt > Stroke**,
+**Render > Materials**. **Tool > ...** paths stay, since the Tool palette is in the right tray in both layouts.
+`python3 tools/guide/menu_paths.py` rewrites ZBrush-style palette paths (**Preferences > Input**) in every
+chapter; ctest `guide_menu_paths` fails while any are left.
diff --git a/tools/guide/menu_paths.py b/tools/guide/menu_paths.py
new file mode 100644
index 00000000..3a3bb1af
--- /dev/null
+++ b/tools/guide/menu_paths.py
@@ -0,0 +1,92 @@
+#!/usr/bin/env python3
+# SculptForge - open source digital sculpting
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""Rewrite ZBrush-style palette paths in the guide to the SculptForge layout's task menus.
+
+"Preferences > Input" becomes "Edit > Preferences > Input", "Material > Load Lit Sphere..." becomes
+"Render > Materials > Load Lit Sphere...", and so on (src/app/Palettes.cpp, taskMenus). Tool paths stay: the Tool
+palette is in the right tray in both layouts. Run it after merging a chapter written with the old paths:
+
+ python3 tools/guide/menu_paths.py # rewrite docs/guide/*.md in place
+ python3 tools/guide/menu_paths.py --check # exit 1 if any old path is left (ctest guide_menu_paths)
+"""
+import argparse
+import pathlib
+import re
+import sys
+
+GUIDE = pathlib.Path(__file__).resolve().parents[2] / "docs" / "guide"
+
+# Palette -> its place in the task menus. A menu with one section (Paint, View, Help) has no section name.
+MENUS = {
+ "Preferences": "Edit > Preferences",
+ "Brush": "Sculpt > Brush",
+ "Draw": "Sculpt > Draw & Tablet",
+ "Stroke": "Sculpt > Stroke",
+ "Alpha": "Sculpt > Alpha",
+ "Transform": "Sculpt > Symmetry & Gizmo",
+ "Color": "Paint",
+ "Generate": "Mesh > Generate 3D",
+ "Render": "View",
+ "Material": "Render > Materials",
+ "Splats": "Render > Gaussian Splats",
+ "Script": "File > Script",
+}
+# Pages that keep the old names on purpose: release history, and the chapter that explains both layouts.
+SKIP = {"whats-new.md"}
+
+# "Preferences > X" anywhere (bold, tables, plain text), but not when already behind a menu ("Edit > Preferences"),
+# the new Render menu, Blender's own "Preferences > Add-ons", or ZBrush's "Preferences > Mem".
+NAMES = "|".join(n + "(?! > (?:Materials|Gaussian Splats))" if n == "Render" else n for n in MENUS) # new Render menu
+PATH = re.compile(r"(?<!> )\b(" + NAMES + r") > (?=[A-Z0-9+])(?!Add-ons|Mem\b)")
+# "the Color palette", "**Brush palette**": the menu (and section) that holds it.
+PHRASE = re.compile(r"(\*\*)?\b([Tt]he )?(" + "|".join(MENUS) + r") palette\b(\*\*)?")
+
+
+def phrase(m: re.Match) -> str:
+ where = MENUS[m.group(3)]
+ if ">" in where:
+ return "**" + where + "**" # "in the Draw palette" -> "in **Sculpt > Draw & Tablet**"
+ return (m.group(2) or "") + "**" + where + "** menu"
+
+
+def convert(text: str) -> str:
+ out = []
+ for line in text.split("\n"):
+ if line.startswith("| ") and line.count("|") > 2:
+ # Tables: leave the first cell (other apps' names in the glossary and the ZBrush chapter).
+ first, rest = line[2:].split("|", 1)
+ line = "| " + first + "|" + PHRASE.sub(phrase, PATH.sub(lambda m: MENUS[m.group(1)] + " > ", rest))
+ else:
+ line = PHRASE.sub(phrase, PATH.sub(lambda m: MENUS[m.group(1)] + " > ", line))
+ out.append(line) # one pass each: a rewritten "Render > Materials" is not read again as "Render >"
+ return "\n".join(out)
+
+
+def main() -> int:
+ ap = argparse.ArgumentParser()
+ ap.add_argument("--check", action="store_true", help="report old paths and exit 1, change nothing")
+ args = ap.parse_args()
+ stale = 0
+ for md in sorted(GUIDE.glob("*.md")):
+ if md.name in SKIP:
+ continue
+ text = md.read_text(encoding="latin-1")
+ new = convert(text)
+ if new == text:
+ continue
+ if args.check:
+ for n, (a, b) in enumerate(zip(text.split("\n"), new.split("\n")), 1):
+ if a != b:
+ print(f"{md.name}:{n}: {a.strip()[:100]}")
+ stale += 1
+ else:
+ md.write_text(new, encoding="latin-1")
+ if args.check and stale:
+ print(f"{stale} line(s) use ZBrush-style palette paths; run tools/guide/menu_paths.py", file=sys.stderr)
+ return 1
+ return 0
+
+
+if __name__ == "__main__":
+ sys.exit(main())