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 feature images in the default look: bake, Blender menu, capture from view, fill layers, gizmo, PBR, performance, texture painting, timeline, UV Editor, VDM, facial shapes

islandmed9e2cb5515796
diff --git a/docs/guide/images/bake-mesh-maps.jpg b/docs/guide/images/bake-mesh-maps.jpg
index 3315fc5d..3195c88b 100644
Binary files a/docs/guide/images/bake-mesh-maps.jpg and b/docs/guide/images/bake-mesh-maps.jpg differ
diff --git a/docs/guide/images/bake.jpg b/docs/guide/images/bake.jpg
index 139199bc..70b16bf1 100644
Binary files a/docs/guide/images/bake.jpg and b/docs/guide/images/bake.jpg differ
diff --git a/docs/guide/images/blender-menu.jpg b/docs/guide/images/blender-menu.jpg
index bb1e64d3..0b469b5e 100644
Binary files a/docs/guide/images/blender-menu.jpg and b/docs/guide/images/blender-menu.jpg differ
diff --git a/docs/guide/images/capture-from-view.jpg b/docs/guide/images/capture-from-view.jpg
index 6f881966..d7926e5f 100644
Binary files a/docs/guide/images/capture-from-view.jpg and b/docs/guide/images/capture-from-view.jpg differ
diff --git a/docs/guide/images/facial-shapes-panel.jpg b/docs/guide/images/facial-shapes-panel.jpg
index 90d5abb7..e54fbb2b 100644
Binary files a/docs/guide/images/facial-shapes-panel.jpg and b/docs/guide/images/facial-shapes-panel.jpg differ
diff --git a/docs/guide/images/fill-layer-panel.jpg b/docs/guide/images/fill-layer-panel.jpg
index 40baf06f..869d5cdc 100644
Binary files a/docs/guide/images/fill-layer-panel.jpg and b/docs/guide/images/fill-layer-panel.jpg differ
diff --git a/docs/guide/images/gizmo-pose.jpg b/docs/guide/images/gizmo-pose.jpg
index b14591fb..07a1aa11 100644
Binary files a/docs/guide/images/gizmo-pose.jpg and b/docs/guide/images/gizmo-pose.jpg differ
diff --git a/docs/guide/images/pbr-brush-material.jpg b/docs/guide/images/pbr-brush-material.jpg
index 231047a0..536e6d93 100644
Binary files a/docs/guide/images/pbr-brush-material.jpg and b/docs/guide/images/pbr-brush-material.jpg differ
diff --git a/docs/guide/images/pbr-environment.jpg b/docs/guide/images/pbr-environment.jpg
index bca61f20..c07cb7dd 100644
Binary files a/docs/guide/images/pbr-environment.jpg and b/docs/guide/images/pbr-environment.jpg differ
diff --git a/docs/guide/images/pbr-solo-roughness.jpg b/docs/guide/images/pbr-solo-roughness.jpg
index 82599615..65946eae 100644
Binary files a/docs/guide/images/pbr-solo-roughness.jpg and b/docs/guide/images/pbr-solo-roughness.jpg differ
diff --git a/docs/guide/images/pbr-viewport.jpg b/docs/guide/images/pbr-viewport.jpg
index 691a2bf6..a89b1465 100644
Binary files a/docs/guide/images/pbr-viewport.jpg and b/docs/guide/images/pbr-viewport.jpg differ
diff --git a/docs/guide/images/performance-panel.jpg b/docs/guide/images/performance-panel.jpg
index 43a8de80..19b54b2f 100644
Binary files a/docs/guide/images/performance-panel.jpg and b/docs/guide/images/performance-panel.jpg differ
diff --git a/docs/guide/images/texture-painting.jpg b/docs/guide/images/texture-painting.jpg
index 2e5c7f04..6df5ff70 100644
Binary files a/docs/guide/images/texture-painting.jpg and b/docs/guide/images/texture-painting.jpg differ
diff --git a/docs/guide/images/timeline-strip.jpg b/docs/guide/images/timeline-strip.jpg
index f5687c9b..29504690 100644
Binary files a/docs/guide/images/timeline-strip.jpg and b/docs/guide/images/timeline-strip.jpg differ
diff --git a/docs/guide/images/uv-editor-seams.jpg b/docs/guide/images/uv-editor-seams.jpg
index 271bc5d1..39f7d118 100644
Binary files a/docs/guide/images/uv-editor-seams.jpg and b/docs/guide/images/uv-editor-seams.jpg differ
diff --git a/docs/guide/images/uv-editor-stretch.jpg b/docs/guide/images/uv-editor-stretch.jpg
index 8abccd77..1bba4d93 100644
Binary files a/docs/guide/images/uv-editor-stretch.jpg and b/docs/guide/images/uv-editor-stretch.jpg differ
diff --git a/docs/guide/images/uv-editor-trim.jpg b/docs/guide/images/uv-editor-trim.jpg
index 2b3a5f62..321e32cd 100644
Binary files a/docs/guide/images/uv-editor-trim.jpg and b/docs/guide/images/uv-editor-trim.jpg differ
diff --git a/docs/guide/images/uv-editor-udim.jpg b/docs/guide/images/uv-editor-udim.jpg
index 13d0998e..6ee287f9 100644
Binary files a/docs/guide/images/uv-editor-udim.jpg and b/docs/guide/images/uv-editor-udim.jpg differ
diff --git a/docs/guide/images/uv-editor.jpg b/docs/guide/images/uv-editor.jpg
index 712c9b17..614f39ff 100644
Binary files a/docs/guide/images/uv-editor.jpg and b/docs/guide/images/uv-editor.jpg differ
diff --git a/docs/guide/images/vdm-brushes.jpg b/docs/guide/images/vdm-brushes.jpg
index fae01512..b0ad6293 100644
Binary files a/docs/guide/images/vdm-brushes.jpg and b/docs/guide/images/vdm-brushes.jpg differ
diff --git a/tools/guide/README.md b/tools/guide/README.md
index c088bde7..52680a7c 100644
--- a/tools/guide/README.md
+++ b/tools/guide/README.md
@@ -37,3 +37,13 @@ The guide names the default **SculptForge layout**'s menus: **Edit > Preferences
**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.
+
+## Feature panels
+
+Bake, fill layers, PBR, the UV Editor, Performance and other feature images come from the feature UI tests, run in
+the default look (tests written for the Classic look run from a converted copy):
+
+```sh
+python3 tools/guide/feature_shots.py --app build/sculptforge --out build/guide-features
+python3 tools/guide/make_images.py build/guide-shots --features build/guide-features
+```
diff --git a/tools/guide/feature_shots.py b/tools/guide/feature_shots.py
new file mode 100644
index 00000000..b249613f
--- /dev/null
+++ b/tools/guide/feature_shots.py
@@ -0,0 +1,68 @@
+#!/usr/bin/env python3
+# SculptForge - open source digital sculpting
+# SPDX-License-Identifier: GPL-3.0-or-later
+"""Screenshots of feature panels for the user guide, taken by running feature UI tests in the default look.
+
+ python3 tools/guide/feature_shots.py --app build/sculptforge --out build/guide-features
+ python3 tools/guide/make_images.py build/guide-shots --features build/guide-features
+
+Tests written for the Classic look and the ZBrush-style palette bar run from a converted copy: the look line becomes
+the default look and each palette click opens its task menu and section instead. Shots land in <out>/<test>/.
+"""
+import argparse
+import os
+import pathlib
+import re
+import subprocess
+import sys
+
+ROOT = pathlib.Path(__file__).resolve().parents[2]
+TESTS = ["bake", "fill_layers", "texture_paint", "uv_editor", "face_shapes", "gizmo", "pbr_viewport", "pbr_channels",
+ "performance", "timeline", "vdm", "kelvinlet_capture", "blender_bridge"]
+DEFAULT_LOOK = "run ui_look look=forge scheme=tokyo_night layout=sculptforge"
+# Palette -> (task menu, section) in the SculptForge layout (src/app/Palettes.cpp, taskMenus).
+MENUS = {
+ "file": ("File##menu.file", "File##section.file"), "script": ("File##menu.file", "Script##section.script"),
+ "edit": ("Edit##menu.edit", "Edit##section.edit"), "preferences": ("Edit##menu.edit", "Preferences##section.preferences"),
+ "brush": ("Sculpt##menu.sculpt", "Brush##section.brush"), "draw": ("Sculpt##menu.sculpt", "Draw & Tablet##section.draw"),
+ "stroke": ("Sculpt##menu.sculpt", "Stroke##section.stroke"), "alpha": ("Sculpt##menu.sculpt", "Alpha##section.alpha"),
+ "transform": ("Sculpt##menu.sculpt", "Symmetry & Gizmo##section.transform"), "color": ("Paint##menu.paint", None),
+ "tool": ("Mesh##menu.mesh", "Parts & Geometry##section.tool"), "generate": ("Mesh##menu.mesh", "Generate 3D##section.generate"),
+ "render": ("View##menu.view", None), "material": ("Render##menu.render", "Materials##section.material"),
+ "splats": ("Render##menu.render", "Gaussian Splats##section.splats"), "help": ("Help##menu.help", None),
+}
+
+
+def convert(text: str) -> str:
+ text = re.sub(r"^run ui_look .*$", DEFAULT_LOOK, text, flags=re.M)
+
+ def menu(m):
+ top, section = MENUS[m.group(1)]
+ return f'click "{top}"' + (f'\nclick "{section}"' if section else "")
+
+ return re.sub(r'click "[^"#]*##palette\.([a-z]+)"', menu, text)
+
+
+def main() -> int:
+ ap = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
+ ap.add_argument("--app", default="build/sculptforge")
+ ap.add_argument("--out", type=pathlib.Path, default=pathlib.Path("build/guide-features"))
+ args = ap.parse_args()
+ env = dict(os.environ, SDL_APP_ID=os.environ.get("SDL_APP_ID", "sculptforge-agent"))
+ for name in TESTS:
+ src = ROOT / "tests" / "ui" / f"{name}.sfui"
+ tmp = src.with_name(f"_guide_{name}.sfui") # beside the original, so its relative paths still resolve
+ tmp.write_text(convert(src.read_text(encoding="utf-8")), encoding="utf-8")
+ try:
+ r = subprocess.run([args.app, "--ui-test", str(tmp), "--ui-out", str(args.out / name)], env=env,
+ capture_output=True, text=True, timeout=900)
+ finally:
+ tmp.unlink()
+ fails = [line for line in r.stdout.splitlines() if line.startswith("FAIL")]
+ # A failed check late in a test still leaves the shots before it; make_images.py says if one is missing.
+ print(f"{name}: {'ok' if r.returncode == 0 else fails[0] if fails else f'exit {r.returncode}'}")
+ return 0
+
+
+if __name__ == "__main__":
+ sys.exit(main())
diff --git a/tools/guide/make_images.py b/tools/guide/make_images.py
index 9eede239..4393cd0c 100644
--- a/tools/guide/make_images.py
+++ b/tools/guide/make_images.py
@@ -71,6 +71,30 @@ WHATS_NEW = {
}
WN_SIZE = (600, 340)
+# Feature panels from tools/guide/feature_shots.py (one folder per UI test): name -> ("test/shot", crop, max width).
+FEATURE_CROPS = {
+ "bake": ("bake/high-and-baked-low", (0, 0, 1600, 960), MAX_WIDTH),
+ "bake-mesh-maps": ("bake/bake-palette", (1280, 280, 1600, 720), 320),
+ "blender-menu": ("blender_bridge/menu", (130, 0, 1010, 580), 880),
+ "capture-from-view": ("kelvinlet_capture/capture_window", (440, 140, 1200, 640), 760),
+ "fill-layer-panel": ("fill_layers/fill-layer-panel", (1280, 60, 1600, 960), 320),
+ "gizmo-pose": ("gizmo/posing-mid-drag", (110, 200, 1000, 860), 890),
+ "pbr-viewport": ("pbr_viewport/pbr-photo-studio", (0, 0, 1600, 960), MAX_WIDTH),
+ "pbr-environment": ("pbr_viewport/pbr-outdoor-background", (100, 85, 1215, 870), 960),
+ "pbr-brush-material": ("pbr_channels/brush-material", (280, 20, 640, 960), 360),
+ "pbr-solo-roughness": ("pbr_channels/solo-roughness", (300, 85, 1600, 870), 960),
+ "performance-panel": ("performance/performance-panel", (180, 20, 715, 800), 535),
+ "texture-painting": ("texture_paint/stroke", (0, 0, 1600, 960), MAX_WIDTH),
+ "timeline-strip": ("timeline/strokes", (100, 85, 1215, 640), 960),
+ "uv-editor": ("uv_editor/unwrapped", (100, 85, 1215, 870), 960),
+ "uv-editor-seams": ("uv_editor/seam-tool", (100, 85, 1215, 870), 960),
+ "uv-editor-stretch": ("uv_editor/stretch", (100, 85, 1215, 870), 960),
+ "uv-editor-trim": ("uv_editor/trim", (100, 85, 1215, 870), 960),
+ "uv-editor-udim": ("uv_editor/udim", (100, 85, 1215, 870), 960),
+ "vdm-brushes": ("vdm/stamped", (300, 40, 1600, 960), 960),
+ "facial-shapes-panel": ("face_shapes/head-neutral", (300, 40, 1600, 960), 960),
+}
+
# The labelled overview: region name and box in window pixels (the SculptForge layout).
REGIONS = [
("Menu bar", (0, 0, 1600, 40)),
@@ -261,6 +285,7 @@ def main() -> int:
ap = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
ap.add_argument("shots", type=pathlib.Path, help="folder with the screenshots (--ui-out of shots.sfui)")
ap.add_argument("--preview", type=pathlib.Path, help="also write a contact sheet of every image here")
+ ap.add_argument("--features", type=pathlib.Path, help="also crop the feature panels from tools/guide/feature_shots.py's --out")
ap.add_argument("--only", action="append", help="make only this image (repeatable), e.g. --only qremesh-guides")
ap.add_argument("--first-sculpt", action="store_true",
help="the shots are tests/ui/first_sculpt.sfui's: make images/first-sculpt/*.jpg")
@@ -295,6 +320,14 @@ def main() -> int:
print(f"missing screenshot {src}", file=sys.stderr)
return 1
made.append(save(Image.open(src).convert("RGB").crop(box), name, width))
+ for name, (shot, box, width) in FEATURE_CROPS.items() if args.features else ():
+ if not wanted(name):
+ continue
+ src = args.features / f"{shot}.png"
+ if not src.exists():
+ print(f"missing screenshot {src}", file=sys.stderr)
+ return 1
+ made.append(save(Image.open(src).convert("RGB").crop(box), name, width))
for p in made:
print(f"{p.relative_to(ROOT)} {p.stat().st_size // 1024} KB")
if args.preview: