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.
C++ 3d3d-sculptingcppdear-imguidigital-sculptingfbxgame-developmentgaussian-splattinggltfimage-to-3dmcpopenglopenusdsculptingtext-to-3dunreal-engine
Materials: a Sculpt MatCap made for reading strokes, now the default
islandmedfa021aac1128
diff --git a/docs/guide/glossary.md b/docs/guide/glossary.mdindex 957c3973..9d3143d1 100644--- a/docs/guide/glossary.md+++ b/docs/guide/glossary.md@@ -34,7 +34,7 @@ for what is planned.| 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) || Mask Lasso, Select Lasso | Not yet. Rectangle hide works: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+drag |-| MatCap | **Material**: Studio plus six MatCaps (<kbd>M</kbd>). Custom MatCap images not yet. See [Polypaint](polypaint.md) |+| MatCap | **Material**: seven MatCaps, Sculpt the default, plus Studio (<kbd>M</kbd>). Custom MatCap images not yet. See [Polypaint](polypaint.md) || Morph target | A [sculpt layer](layers.md); exported as glTF morph targets and FBX/USD blend shapes || Mrgb, M (material channel) | Not yet: there is no per-vertex material channel || Polyframe (PolyF, Shift+F) | **PolyF** on the right shelf, <kbd>W</kbd> or <kbd>Shift</kbd>+<kbd>F</kbd> |diff --git a/docs/guide/images/interface-overview.jpg b/docs/guide/images/interface-overview.jpgindex 2bfcad0c..d187d8b9 100644Binary files a/docs/guide/images/interface-overview.jpg and b/docs/guide/images/interface-overview.jpg differdiff --git a/docs/guide/images/masking.jpg b/docs/guide/images/masking.jpgindex 69d48b54..aa0a37f4 100644Binary files a/docs/guide/images/masking.jpg and b/docs/guide/images/masking.jpg differdiff --git a/docs/guide/images/material-picker.jpg b/docs/guide/images/material-picker.jpgindex a932c596..3cb0f4dd 100644Binary files a/docs/guide/images/material-picker.jpg and b/docs/guide/images/material-picker.jpg differdiff --git a/docs/guide/images/polygroups.jpg b/docs/guide/images/polygroups.jpgindex b852b330..47ffa6a4 100644Binary files a/docs/guide/images/polygroups.jpg and b/docs/guide/images/polygroups.jpg differdiff --git a/docs/guide/images/polypaint.jpg b/docs/guide/images/polypaint.jpgindex 4e7151f5..3833eca7 100644Binary files a/docs/guide/images/polypaint.jpg and b/docs/guide/images/polypaint.jpg differdiff --git a/docs/guide/images/remesh.jpg b/docs/guide/images/remesh.jpgindex ac159fff..09721327 100644Binary files a/docs/guide/images/remesh.jpg and b/docs/guide/images/remesh.jpg differdiff --git a/docs/guide/images/sculpt-lion.jpg b/docs/guide/images/sculpt-lion.jpgindex 11458243..5512941b 100644Binary files a/docs/guide/images/sculpt-lion.jpg and b/docs/guide/images/sculpt-lion.jpg differdiff --git a/docs/guide/images/subtools.jpg b/docs/guide/images/subtools.jpgindex 511172e2..031ee2ae 100644Binary files a/docs/guide/images/subtools.jpg and b/docs/guide/images/subtools.jpg differdiff --git a/docs/guide/interface.md b/docs/guide/interface.mdindex e0c10a71..7d2a56d9 100644--- a/docs/guide/interface.md+++ b/docs/guide/interface.md@@ -62,7 +62,7 @@ Interface > Palettes strictly A-Z (ZBrush order)**.| **Color** | The Paint brush, RGB while sculpting, the paint colour and swatches, Fill, Fill masked, Cavity, Clear, Show polypaint || **Draw** | Draw Size, Strength, Sculpt/Paint, Zadd/Zsub, Rgb, Front, and the tablet options (Pressure > strength, Pressure > size) with a pen readout || **Generate** | Generate 3D (image or text to 3D), Relief, Inflate and Stamp from an image, and the AI brush provider settings |-| **Material** | Studio and the six MatCap materials, Base colour |+| **Material** | The seven MatCap materials (Sculpt, the default, first) and Studio, Base colour || **Preferences** | Config, Interface, Hotkeys, LightBox and Autosave sub-palettes (see [Customizing the interface](#customizing-the-interface)) || **Render** | Wireframe, Show Mesh, Show Polypaint, Show Mask, Show Polygroups, Show Splats, Frame, Fullscreen || **Script** | Console, Run script file, Copy session as script, Clear console |@@ -214,7 +214,7 @@ brushes](brush-lab.md)).radius for LazyMouse. See [Sculpting and brushes](sculpting.md).- **Alpha** (click the Alpha tile): Round, Square and Noise, the image alpha you loaded, images in yourlibrary's Alphas folder, **Load image...** and **Invert loaded image**.-- **Material** (<kbd>M</kbd>, or click the Material tile): Studio and the MatCaps. Point at a material to+- **Material** (<kbd>M</kbd>, or click the Material tile): the MatCaps and Studio. Point at a material topreview it on the model; click to keep it. Closing the picker without clicking puts the old material back.See [Polypaint and materials](polypaint.md).@@ -239,7 +239,7 @@ start-up (see [Preferences](#interface-preferences)).| **Tool** | Sphere, Plane and Cube, and model files in your library | Open (replaces the scene) || **Brush** | Every brush: built-in, custom and `.sfbrush` files | Select or load the brush || **Alpha** | Round, Square, Noise and images in your Alphas folder | Use as the brush alpha |-| **Material** | Studio and the MatCaps | Use the material |+| **Material** | The MatCaps and Studio | Use the material || **Image** | Reference images in your library | A menu: Generate 3D, relief, inflate, project onto the model, use as alpha || **Splats** | Gaussian splat captures (`.ply`, `.splat`) | Open the capture as a reference || **QuickSave** | The autosave and your QuickSaves, newest first | Open it |diff --git a/docs/guide/polypaint.md b/docs/guide/polypaint.mdindex 8eb29a6b..46b2f218 100644--- a/docs/guide/polypaint.md+++ b/docs/guide/polypaint.md@@ -73,13 +73,14 @@ Materials change only how the model is shaded in the viewport. They aren't expor| Material | Look ||---|---|-| Studio | The default clay shading with soft studio lighting. Its colour is **Base colour** in the Material palette |+| Sculpt | The default, made for sculpting: neutral warm clay under a strong key light from the upper left, a crisp highlight and deep cavity shading, so small strokes and undulations stay readable || Red Wax | Glossy deep red wax, the classic sculpting look || Clay | Matte grey-brown clay || Skin | Warm, soft skin tones || 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 |To choose one:@@ -88,10 +89,13 @@ To choose one:previous material back.- Open the **Material** palette, or the **Material** tab of the LightBox.-+-Polypaint multiplies the material, and cavity shading stays on with every material. The material is saved with-the project.+Polypaint multiplies the material, and cavity shading stays on with every material (strongest with Sculpt). The+material is saved with the project: projects saved with Studio open with Studio.++> **Tip:** **Sculpt** is the material to judge strokes with. The prettier ones (Skin, Red Wax) soften small+> detail; switch to them for presenting.> **Not yet:** loading your own MatCap images, and physically based materials or BPR-style renders.@@ -103,7 +107,7 @@ the project.| `paint_fill area=unmasked` | Fill; `area` is `unmasked` (default), `masked` or `all`; `strength` 0-1 || `paint_from_cavity color=#202020 strength=0.7 smoothing=2` | Cavity paint (defaults: dark brown, 0.7, 2 blur passes) || `paint_clear` | Remove all polypaint |-| `set_material name=Chrome` | Viewport material: `studio` or a MatCap name (desktop app only) |+| `set_material name=Chrome` | Viewport material: a MatCap name (`Sculpt` is the default) or `studio` (desktop app only) |```textset_color color="#d9b38c"; paint_fill; paint_from_cavity strength=0.5diff --git a/docs/guide/scripting.md b/docs/guide/scripting.mdindex b0f77a3c..ed9fa7b8 100644--- a/docs/guide/scripting.md+++ b/docs/guide/scripting.md@@ -118,7 +118,7 @@ the ones you will use most:| Edit | `undo`, `redo` | |A few commands exist only inside the app, because they change the view rather than the model: `set_material`-(`name=` Studio or a MatCap) and `new_cube`.+(`name=` a MatCap such as Sculpt, or Studio) and `new_cube`.## sculptforge-clidiff --git a/docs/guide/welcome.md b/docs/guide/welcome.mdindex 61977953..b57d97af 100644--- a/docs/guide/welcome.md+++ b/docs/guide/welcome.md@@ -26,7 +26,7 @@ the GPL covers the program, not your models.polygroup. See [Masking](masking.md) and [Polygroups and visibility](polygroups.md).- **Keep separate meshes** as SubTools (body, eyes, teeth, armour), each with its own undo history. See[SubTools](subtools.md).-- **Paint colour** on the surface (polypaint) and look at the model through six MatCap materials. See+- **Paint colour** on the surface (polypaint) and look at the model through seven MatCap materials. See[Polypaint and materials](polypaint.md).- **Sculpt layers** that double as blend shapes (morph targets), with live weights. See [Sculpt layers andblend shapes](layers.md).diff --git a/src/app/LightBox.cpp b/src/app/LightBox.cppindex 69b5fe71..b4049644 100644--- a/src/app/LightBox.cpp+++ b/src/app/LightBox.cpp@@ -239,7 +239,8 @@ void LightBox::rootEntries(App& app, std::vector<AssetEntry>& out) {break;}case LibraryTab::Material:- for (int i = -1; i < matcapCount(); ++i) {+ for (int k = 0; k <= matcapCount(); ++k) { // the MatCaps (Sculpt first), then Studio+ const int i = k < matcapCount() ? k : -1;AssetEntry e;e.kind = AssetKind::Material;e.index = i;diff --git a/src/app/PanelPolypaint.cpp b/src/app/PanelPolypaint.cppindex 2accc61c..1bbb2d8b 100644--- a/src/app/PanelPolypaint.cpp+++ b/src/app/PanelPolypaint.cpp@@ -18,11 +18,13 @@ namespace sf {void App::registerPaintUiCommands() {// A view setting, so it lives with the app (scripts: --script "set_material name=Chrome").- std::string names = "studio";- for (int i = 0; i < matcapCount(); ++i) names += std::string(", ") + matcapName(i);+ std::string names;+ for (int i = 0; i < matcapCount(); ++i) names += std::string(matcapName(i)) + ", ";+ names += "studio";commands_.add({"set_material",- "Viewport material: studio (default clay lighting) or a built-in MatCap. Polypaint multiplies "- "the matcap; cavity shading stays on.",+ "Viewport material: a built-in MatCap (Sculpt, the default, is made for reading strokes) or "+ "studio (soft clay lighting in the Base colour). Polypaint multiplies the matcap; cavity "+ "shading stays on.",{{"name", ParamSpec::Type::String, "One of: " + names + ".", true}},[this, names](Document&, const Args& a) -> CommandResult {const std::string name = argString(a, "name");diff --git a/src/app/PanelProject.cpp b/src/app/PanelProject.cppindex 8a2be719..06bc51a9 100644--- a/src/app/PanelProject.cpp+++ b/src/app/PanelProject.cpp@@ -234,11 +234,10 @@ void App::applyProjectSettings() {readBool(r, "show_mesh", renderSettings_.showMesh);readBool(r, "show_splats", renderSettings_.showSplats);readFloat(r, "splat_opacity", renderSettings_.splatOpacity);- if (r["matcap"].isString()) {- renderSettings_.matcap = -1; // unknown or empty name: studio lighting- for (int i = 0; i < matcapCount(); ++i)- if (r["matcap"].asString() == matcapName(i)) renderSettings_.matcap = i;- }+ // Unknown, empty or missing (projects from before MatCaps): studio lighting, as they were saved.+ renderSettings_.matcap = -1;+ for (int i = 0; i < matcapCount(); ++i)+ if (r["matcap"].isString() && r["matcap"].asString() == matcapName(i)) renderSettings_.matcap = i;}if (const Json& b = s["brush"]; b.isObject()) {for (int i = 0; i < int(BrushType::Count); ++i)diff --git a/src/app/Pickers.cpp b/src/app/Pickers.cppindex 00c4e555..634f63cd 100644--- a/src/app/Pickers.cpp+++ b/src/app/Pickers.cpp@@ -789,7 +789,8 @@ void drawMaterialGrid(App& app, GridMode mode) {int column = 0;int hovered = -2;const int active = s.previewing ? s.savedMatcap : app.renderSettings_.matcap;- for (int i = -1; i < matcapCount(); ++i) {+ for (int k = 0; k <= matcapCount(); ++k) {+ const int i = k < matcapCount() ? k : -1; // the MatCaps (Sculpt first), then StudiotileGrid(column, columns);const char* name = i < 0 ? "Studio" : matcapName(i);const ImTextureID tex = app.thumbs_.material(i);@@ -801,8 +802,10 @@ void drawMaterialGrid(App& app, GridMode mode) {}if (ImGui::IsItemHovered()) hovered = i;ui::HelpText(name, nullptr,- i < 0 ? "Clay lighting with cavity shading (the default)."- : "MatCap material: the whole lit look in one image.",+ i < 0 ? "Soft studio lighting with cavity shading, in the Base colour."+ : i == 0 ? "Made for sculpting (the default): a strong key light, crisp highlights and deep "+ "cavities so every stroke reads."+ : "MatCap material: the whole lit look in one image.","Material");}// ZBrush's "Preview Material On Mesh": hovering a material shows it on the model until the pointer leaves.diff --git a/src/app/Thumbnails.cpp b/src/app/Thumbnails.cppindex a4c2dddc..881bfce5 100644--- a/src/app/Thumbnails.cpp+++ b/src/app/Thumbnails.cpp@@ -5,6 +5,7 @@#include "app/AssetLibrary.h"#include "core/Commands.h"#include "core/Document.h"+#include "core/Matcap.h"#include "core/PathStroke.h"#include "core/Primitives.h"#include "core/Project.h"@@ -311,7 +312,9 @@ ImTextureID ThumbnailCache::alpha(const BrushAlpha& alpha) {}ImTextureID ThumbnailCache::material(int matcap) {- const std::string key = "material|" + std::to_string(matcap) + "|" + std::to_string(kThumbnailVersion);+ // By name: the built-in list can grow or change order between versions.+ const std::string key =+ "material|" + std::string(matcap < 0 ? "Studio" : matcapName(matcap)) + "|" + std::to_string(kThumbnailVersion);return request(hex64(fnv1a64(key)),[matcap] {diff --git a/src/core/Matcap.cpp b/src/core/Matcap.cppindex 209cd21f..f3742112 100644--- a/src/core/Matcap.cpp+++ b/src/core/Matcap.cpp@@ -24,9 +24,12 @@ struct MatcapStyle {glm::vec3 rim;float metal; // 0 = dielectric, 1 = pure environment reflectionfloat roughness; // blurs the environment for metals+ bool sculpt = false; // the readability-first sculpting light (shadeSculpt) instead of the shared model+ MatcapCavity cavity{};};const MatcapStyle kStyles[] = {+ {"Sculpt", {0.56f, 0.44f, 0.36f}, 0.0f, {0.0f, 0.0f, 0.0f}, 0.0f, 0.0f, {0.0f, 0.0f, 0.0f}, 0.0f, 0.0f, true, {0.8f, 0.35f}},{"Red Wax", {0.50f, 0.045f, 0.03f}, 0.55f, {0.55f, 0.06f, 0.03f}, 0.55f, 70.0f, {0.25f, 0.08f, 0.06f}, 0.0f, 0.0f},{"Clay", {0.46f, 0.38f, 0.33f}, 0.25f, {0.05f, 0.03f, 0.02f}, 0.06f, 10.0f, {0.10f, 0.10f, 0.11f}, 0.0f, 0.0f},{"Skin", {0.68f, 0.38f, 0.28f}, 0.6f, {0.6f, 0.16f, 0.08f}, 0.16f, 28.0f, {0.22f, 0.16f, 0.15f}, 0.0f, 0.0f},@@ -54,7 +57,30 @@ glm::vec3 environment(const glm::vec3& r, float roughness) {return c;}+// Built for reading the surface while sculpting, after ZBrush's default material and Blender's sculpt+// studio light: a strong key from the upper left, little ambient so forms don't flatten, a crisp+// highlight that catches every undulation, only a hint of rim and no fresnel glow. Creases get the+// strongest cavity darkening of the materials (kStyles' cavity, applied by the mesh shader).+glm::vec3 shadeSculpt(const MatcapStyle& m, const glm::vec3& n) {+ const glm::vec3 v(0.0f, 0.0f, 1.0f);+ const glm::vec3 key = glm::normalize(glm::vec3(-0.4f, 0.65f, 0.65f));+ const glm::vec3 fill = glm::normalize(glm::vec3(0.75f, -0.3f, 0.6f));+ const float diff = std::max((glm::dot(n, key) + 0.1f) / 1.1f, 0.0f);+ const float fd = std::max(glm::dot(n, fill), 0.0f);+ const float hemi = 0.04f + 0.04f * (0.5f + 0.5f * n.y);+ // A steep falloff on both lights: brightness changes quickly with the slope everywhere in view.+ const glm::vec3 light = 1.6f * std::pow(diff, 2.5f) + 0.5f * fd * fd * glm::vec3(0.85f, 0.9f, 1.0f) + glm::vec3(hemi);+ // A tight highlight over a broad sheen, plus a faint one from the fill, so strokes catch light+ // on the shadow side too.+ const float nh = std::max(glm::dot(n, glm::normalize(key + v)), 0.0f);+ const float spec = (0.3f * std::pow(nh, 80.0f) + 0.25f * std::pow(nh, 12.0f)) * std::min(1.0f, diff * 4.0f);+ const float fillSpec = 0.07f * std::pow(std::max(glm::dot(n, glm::normalize(fill + v)), 0.0f), 40.0f);+ const float rim = std::pow(1.0f - std::max(n.z, 0.0f), 4.0f) * 0.1f;+ return m.albedo * light + glm::vec3(spec) + glm::vec3(0.8f, 0.85f, 0.95f) * (fillSpec + rim);+}+glm::vec3 shade(const MatcapStyle& m, const glm::vec3& n) {+ if (m.sculpt) return shadeSculpt(m, n);const glm::vec3 v(0.0f, 0.0f, 1.0f);const float nv = std::max(n.z, 0.0f);if (m.metal > 0.0f) {@@ -91,6 +117,8 @@ int matcapCount() { return kStyleCount; }const char* matcapName(int index) { return index >= 0 && index < kStyleCount ? kStyles[index].name : ""; }+MatcapCavity matcapCavity(int index) { return index >= 0 && index < kStyleCount ? kStyles[index].cavity : MatcapCavity{}; }+int findMatcap(const std::string& name) {const std::string key = squash(name);for (int i = 0; i < kStyleCount; ++i)diff --git a/src/core/Matcap.h b/src/core/Matcap.hindex 653db4ff..bc0c5a6f 100644--- a/src/core/Matcap.h+++ b/src/core/Matcap.h@@ -18,6 +18,13 @@ const char* matcapName(int index);// Case-insensitive; also accepts names without spaces ("redwax"). -1 if unknown.int findMatcap(const std::string& name);+// How strongly the viewport darkens creases and lifts ridges on top of this matcap (the+// curvature term in the mesh shader); the Sculpt material leans on it more than the others.+struct MatcapCavity {+ float crease = 0.55f, ridge = 0.2f;+};+MatcapCavity matcapCavity(int index);+// `size` x `size` RGBA8 pixels, sRGB-encoded, rows bottom-up (OpenGL order):// pixel (i, j) shows the sphere normal x = (i + 0.5) / size * 2 - 1,// y = (j + 0.5) / size * 2 - 1. Pixels outside the disk repeat the rim.diff --git a/src/render/Renderer.cpp b/src/render/Renderer.cppindex 791bc3e8..a989269e 100644--- a/src/render/Renderer.cpp+++ b/src/render/Renderer.cpp@@ -53,6 +53,7 @@ uniform int uGroups; // 0: off, 1: per-triangle ids from uGroupIds, 2: everyuniform usamplerBuffer uGroupIds;uniform int uMatcap; // 1: shade with the matcap texture instead of the studio lightsuniform sampler2D uMatcapTex; // sRGB-encoded lit sphere (core/Matcap.h)+uniform vec2 uMatcapCavity; // crease darkening, ridge lift (sf::matcapCavity)uniform int uDim; // 1: an inactive SubTool, shown a little darker and greyerout vec4 fragColor;vec4 finish(vec3 c) {@@ -88,7 +89,7 @@ void main() {vec3 mc = pow(texture(uMatcapTex, uv).rgb, vec3(2.2));float mcrease = smoothstep(0.0, 0.16, vCurvature);float mridge = smoothstep(0.0, 0.2, -vCurvature);- vec3 c = mc * tint * (1.0 - 0.55 * mcrease) * (1.0 + 0.2 * mridge);+ vec3 c = mc * tint * (1.0 - uMatcapCavity.x * mcrease) * (1.0 + uMatcapCavity.y * mridge);if (uShowMask == 1) c *= 1.0 - 0.75 * clamp(vMask, 0.0, 1.0);fragColor = finish(c);return;@@ -279,7 +280,7 @@ bool Renderer::init(std::string& error) {gl::GenVertexArrays(1, &emptyVao_);- // Built-in matcaps, generated once (6 x 256 KB).+ // Built-in matcaps, generated once (256 KB each).matcapTextures_.assign(size_t(matcapCount()), 0);gl::GenTextures(GLsizei(matcapTextures_.size()), matcapTextures_.data());gl::PixelStorei(GL_UNPACK_ALIGNMENT, 1);@@ -737,6 +738,8 @@ void Renderer::draw(const Camera& camera, int targetWidth, int targetHeight, conconst GLuint matcap = matcapTexture(settings.matcap);gl::Uniform1i(gl::GetUniformLocation(meshProgram_, "uMatcap"), matcap ? 1 : 0);gl::Uniform1i(gl::GetUniformLocation(meshProgram_, "uMatcapTex"), 2);+ const MatcapCavity cavity = matcapCavity(settings.matcap);+ gl::Uniform2f(gl::GetUniformLocation(meshProgram_, "uMatcapCavity"), cavity.crease, cavity.ridge);gl::ActiveTexture(kTexture2);gl::BindTexture(GL_TEXTURE_2D, matcap);gl::ActiveTexture(GL_TEXTURE0);diff --git a/src/render/Renderer.h b/src/render/Renderer.hindex 7c2e5b9b..0ddb2e2d 100644--- a/src/render/Renderer.h+++ b/src/render/Renderer.h@@ -19,7 +19,7 @@ struct RenderSettings {bool showPolypaint = true; // vertex colours replace baseColor when the mesh has thembool showMask = true; // masked areas render darker (ZBrush style)bool showPolygroups = false; // colour each polygroup (see polygroupColor)- int matcap = -1; // built-in MatCap material (core/Matcap.h); -1 = studio clay lighting+ int matcap = 0; // built-in MatCap material (core/Matcap.h), 0 = Sculpt; -1 = studio clay lightingbool showMesh = true;bool showSplats = true;float splatOpacity = 1.0f; // global fade for using a capture as referencediff --git a/tests/test_polypaint.cpp b/tests/test_polypaint.cppindex b8a17b7f..9e3b0264 100644--- a/tests/test_polypaint.cpp+++ b/tests/test_polypaint.cpp@@ -305,6 +305,16 @@ TEST(matcap_builtin_materials) {CHECK(std::abs(cc.x - cc.z) < 40); // neutral metal// Deterministic.CHECK(generateMatcap(findMatcap("Chrome"), size) == chrome);++ // Sculpt, the default material, comes first: a neutral warm clay with a strong key from the upper+ // left (a clear light-to-shadow range, so slopes read), and the deepest cavity shading of them all.+ CHECK(findMatcap("sculpt") == 0);+ const std::vector<uint8_t> sculpt = generateMatcap(0, size);+ const glm::ivec4 sc = pixel(sculpt, size / 2, size / 2);+ CHECK(sc.x >= sc.z && sc.x - sc.z < 60);+ CHECK(pixel(sculpt, size / 4, size * 3 / 4).x > pixel(sculpt, size * 3 / 4, size / 4).x + 60);+ for (int i = 1; i < matcapCount(); ++i) CHECK(matcapCavity(0).crease > matcapCavity(i).crease);+ CHECK(matcapCavity(-1).crease > 0.0f && matcapCavity(matcapCount()).crease == matcapCavity(-1).crease);}TEST(polypaint_restore_stroke_marks_colors_dirty) {diff --git a/website/guide/glossary.html b/website/guide/glossary.htmlindex 94e58db7..cf3c3e30 100644--- a/website/guide/glossary.html+++ b/website/guide/glossary.html@@ -52,7 +52,7 @@<h1 id="glossary">Glossary</h1><p>This chapter maps ZBrush terms to their SculptForge equivalents, so you can find a familiar tool quickly, and explains the terms that only SculptForge uses. "Not yet" means SculptForge doesn't have it today; see the roadmap for what is planned.</p><h2 id="zbrush-terms-in-sculptforge">ZBrush terms in SculptForge<a class="anchor" href="#zbrush-terms-in-sculptforge" aria-label="Link to this section">#</a></h2>-<div class="table-wrap"><table><thead><tr><th>ZBrush</th><th>SculptForge</th></tr></thead><tbody><tr><td>Alpha</td><td><strong>Alpha</strong>: built-in round, square and noise, or any grayscale image. Left shelf, Alpha palette. See <a href="sculpting.html">Sculpting</a></td></tr><tr><td>Auto Groups</td><td><strong>Tool > Polygroups > By pieces</strong> (<code>polygroup_by_connectivity</code>)</td></tr><tr><td>BPR render</td><td>Not yet as a renderer. Headless renders and turntables with <code>sculptforge --render</code> (<a href="scripting.html">Scripting</a>)</td></tr><tr><td>Brush pop-up (B)</td><td><strong>Brush picker</strong>, <kbd>B</kbd>, then type letters (B S T = Standard)</td></tr><tr><td>Clip brushes</td><td>Not yet. The <strong>Trim</strong> brush shaves to a plane</td></tr><tr><td>Curve brushes, IMM, ZModeler, ZSpheres</td><td>Not yet</td></tr><tr><td>Decimation Master</td><td><strong>Tool > Geometry > Decimate</strong> (<code>decimate</code>). See <a href="geometry.html#decimate">Geometry</a></td></tr><tr><td>Del Hidden</td><td><strong>Tool > Visibility > Delete hidden</strong> (<code>delete_hidden</code>)</td></tr><tr><td>Divide (Ctrl+D)</td><td><strong>Tool > Geometry > Subdivide</strong>, <kbd>Ctrl</kbd>+<kbd>D</kbd></td></tr><tr><td>Document, 2.5D canvas, pixols</td><td>Not planned: SculptForge is a 3D sculpting app only</td></tr><tr><td>Draw Size</td><td><strong>Draw Size</strong> (top shelf, <kbd>S</kbd>, <kbd>[</kbd> / <kbd>]</kbd>)</td></tr><tr><td>DynaMesh</td><td><strong>Voxel Remesh</strong> (<strong>Tool > Remesh</strong>, <code>remesh</code>). See <a href="geometry.html#voxel-remesh">Geometry</a></td></tr><tr><td>Focal Shift</td><td>No slider for the built-in brushes. Custom brushes have <strong>Hardness</strong> and <strong>Tip sharpness</strong> in their recipe</td></tr><tr><td>Ghost, Transp</td><td>Not yet. Inactive SubTools are drawn slightly dimmed</td></tr><tr><td>GoZ</td><td><strong>GoZ</strong>: <code>.GoZ</code> import and export and the GoZ bridge (<strong>File > ZBrush (GoZ)</strong>). See <a href="exporting.html">Exporting</a></td></tr><tr><td>Group Masked</td><td><strong>Tool > Polygroups > From mask</strong> (<code>polygroup_from_mask</code>)</td></tr><tr><td>Group Visible</td><td><strong>Tool > Polygroups > Merge visible</strong> (<code>polygroup_merge_visible</code>)</td></tr><tr><td>Groups By Normals</td><td><strong>Tool > Polygroups > By normals</strong> with an angle (<code>polygroup_auto_by_normals</code>)</td></tr><tr><td>Layers (sculpt layers)</td><td><strong>Tool > Layers</strong>: sculpt layers with weights, exported as blend shapes. See <a href="layers.html">Layers</a></td></tr><tr><td>LazyMouse</td><td><strong>LazyMouse</strong> stroke type (Stroke palette)</td></tr><tr><td>LightBox</td><td><strong>LightBox</strong>, <kbd>,</kbd> (comma)</td></tr><tr><td>Live Boolean</td><td>Not yet</td></tr><tr><td>Local symmetry, radial symmetry</td><td>Not yet. Symmetry is X, Y and Z across the world axes</td></tr><tr><td>Mask by Cavity</td><td><strong>Tool > Masking > By cavity</strong> (<code>mask_by_cavity</code>)</td></tr><tr><td>Masking (Ctrl)</td><td>Hold <kbd>Ctrl</kbd> to paint the mask, <kbd>Ctrl</kbd>+<kbd>Alt</kbd> to erase. See <a href="masking.html">Masking</a></td></tr><tr><td>Mask Lasso, Select Lasso</td><td>Not yet. Rectangle hide works: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+drag</td></tr><tr><td>MatCap</td><td><strong>Material</strong>: Studio plus six MatCaps (<kbd>M</kbd>). Custom MatCap images not yet. See <a href="polypaint.html">Polypaint</a></td></tr><tr><td>Morph target</td><td>A <a href="layers.html">sculpt layer</a>; exported as glTF morph targets and FBX/USD blend shapes</td></tr><tr><td>Mrgb, M (material channel)</td><td>Not yet: there is no per-vertex material channel</td></tr><tr><td>Polyframe (PolyF, Shift+F)</td><td><strong>PolyF</strong> on the right shelf, <kbd>W</kbd> or <kbd>Shift</kbd>+<kbd>F</kbd></td></tr><tr><td>Polygroups</td><td><strong>Polygroups</strong>: same idea, same Ctrl+Shift gestures. See <a href="polygroups.html">Polygroups and visibility</a></td></tr><tr><td>Polypaint</td><td><strong>Polypaint</strong>: Paint brush (<kbd>P</kbd>), Rgb, fills, cavity paint. See <a href="polypaint.html">Polypaint</a></td></tr><tr><td>Projection Master</td><td>Not yet. <strong>Generate > Stamp</strong> projects an image onto the model from the view</td></tr><tr><td>QuickSave</td><td><strong>QuickSave</strong> in the title strip; the last 10 are kept. See <a href="projects.html#quicksave">Projects</a></td></tr><tr><td>Rgb</td><td><strong>Rgb</strong> on the top shelf (paint while sculpting)</td></tr><tr><td>Rgb Intensity, Z Intensity</td><td><strong>Strength</strong> (top shelf, <kbd>I</kbd>)</td></tr><tr><td>Sculptris Pro, dynamic topology</td><td>Not yet</td></tr><tr><td>SDiv, D / Shift+D (subdivision levels)</td><td>Not yet: Subdivide is a single, destructive step</td></tr><tr><td>Solo</td><td><strong>Solo</strong> on the right shelf or in <strong>Tool > SubTool</strong></td></tr><tr><td>Spotlight</td><td>Not yet</td></tr><tr><td>Store Config</td><td><strong>Store Config</strong>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (<strong>Preferences > Config</strong>)</td></tr><tr><td>Stroke (Dots, DragRect, Spray)</td><td><strong>Stroke</strong> types Dots, DragRect, Spray, LazyMouse</td></tr><tr><td>SubTool</td><td><strong>SubTool</strong>: same idea, <kbd>Alt</kbd>+click to select. See <a href="subtools.html">SubTools</a></td></tr><tr><td>Texture palette</td><td>Not yet: there is no texture painting or texture slot</td></tr><tr><td>Transpose, Gizmo 3D</td><td>Not yet. Use the <strong>Move</strong> brush, or move the camera with the right-shelf buttons</td></tr><tr><td>UV Master</td><td>Not yet. UVs that come in with a GoZ model are kept (and saved in projects)</td></tr><tr><td>Zadd / Zsub</td><td><strong>Zadd</strong> / <strong>Zsub</strong> on the top shelf; <kbd>Alt</kbd> flips for one stroke</td></tr><tr><td>ZPlugin</td><td>No in-app plugin system yet. Automate with the Python module, <code>sculptforge-cli</code> and MCP (<a href="scripting.html">Scripting</a>)</td></tr><tr><td>ZRemesher</td><td>Not yet (quad retopology is on the roadmap)</td></tr><tr><td>ZScript</td><td>Script commands: the console (backtick key), script files, <code>sculptforge-cli</code>. See <a href="scripting.html">Scripting</a></td></tr><tr><td>ZTL, ZPR files</td><td>Not supported. Use GoZ, OBJ, FBX or GLB to bring models over; save work as <code>.sfproj</code></td></tr></tbody></table></div>+<div class="table-wrap"><table><thead><tr><th>ZBrush</th><th>SculptForge</th></tr></thead><tbody><tr><td>Alpha</td><td><strong>Alpha</strong>: built-in round, square and noise, or any grayscale image. Left shelf, Alpha palette. See <a href="sculpting.html">Sculpting</a></td></tr><tr><td>Auto Groups</td><td><strong>Tool > Polygroups > By pieces</strong> (<code>polygroup_by_connectivity</code>)</td></tr><tr><td>BPR render</td><td>Not yet as a renderer. Headless renders and turntables with <code>sculptforge --render</code> (<a href="scripting.html">Scripting</a>)</td></tr><tr><td>Brush pop-up (B)</td><td><strong>Brush picker</strong>, <kbd>B</kbd>, then type letters (B S T = Standard)</td></tr><tr><td>Clip brushes</td><td>Not yet. The <strong>Trim</strong> brush shaves to a plane</td></tr><tr><td>Curve brushes, IMM, ZModeler, ZSpheres</td><td>Not yet</td></tr><tr><td>Decimation Master</td><td><strong>Tool > Geometry > Decimate</strong> (<code>decimate</code>). See <a href="geometry.html#decimate">Geometry</a></td></tr><tr><td>Del Hidden</td><td><strong>Tool > Visibility > Delete hidden</strong> (<code>delete_hidden</code>)</td></tr><tr><td>Divide (Ctrl+D)</td><td><strong>Tool > Geometry > Subdivide</strong>, <kbd>Ctrl</kbd>+<kbd>D</kbd></td></tr><tr><td>Document, 2.5D canvas, pixols</td><td>Not planned: SculptForge is a 3D sculpting app only</td></tr><tr><td>Draw Size</td><td><strong>Draw Size</strong> (top shelf, <kbd>S</kbd>, <kbd>[</kbd> / <kbd>]</kbd>)</td></tr><tr><td>DynaMesh</td><td><strong>Voxel Remesh</strong> (<strong>Tool > Remesh</strong>, <code>remesh</code>). See <a href="geometry.html#voxel-remesh">Geometry</a></td></tr><tr><td>Focal Shift</td><td>No slider for the built-in brushes. Custom brushes have <strong>Hardness</strong> and <strong>Tip sharpness</strong> in their recipe</td></tr><tr><td>Ghost, Transp</td><td>Not yet. Inactive SubTools are drawn slightly dimmed</td></tr><tr><td>GoZ</td><td><strong>GoZ</strong>: <code>.GoZ</code> import and export and the GoZ bridge (<strong>File > ZBrush (GoZ)</strong>). See <a href="exporting.html">Exporting</a></td></tr><tr><td>Group Masked</td><td><strong>Tool > Polygroups > From mask</strong> (<code>polygroup_from_mask</code>)</td></tr><tr><td>Group Visible</td><td><strong>Tool > Polygroups > Merge visible</strong> (<code>polygroup_merge_visible</code>)</td></tr><tr><td>Groups By Normals</td><td><strong>Tool > Polygroups > By normals</strong> with an angle (<code>polygroup_auto_by_normals</code>)</td></tr><tr><td>Layers (sculpt layers)</td><td><strong>Tool > Layers</strong>: sculpt layers with weights, exported as blend shapes. See <a href="layers.html">Layers</a></td></tr><tr><td>LazyMouse</td><td><strong>LazyMouse</strong> stroke type (Stroke palette)</td></tr><tr><td>LightBox</td><td><strong>LightBox</strong>, <kbd>,</kbd> (comma)</td></tr><tr><td>Live Boolean</td><td>Not yet</td></tr><tr><td>Local symmetry, radial symmetry</td><td>Not yet. Symmetry is X, Y and Z across the world axes</td></tr><tr><td>Mask by Cavity</td><td><strong>Tool > Masking > By cavity</strong> (<code>mask_by_cavity</code>)</td></tr><tr><td>Masking (Ctrl)</td><td>Hold <kbd>Ctrl</kbd> to paint the mask, <kbd>Ctrl</kbd>+<kbd>Alt</kbd> to erase. See <a href="masking.html">Masking</a></td></tr><tr><td>Mask Lasso, Select Lasso</td><td>Not yet. Rectangle hide works: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+drag</td></tr><tr><td>MatCap</td><td><strong>Material</strong>: seven MatCaps, Sculpt the default, plus Studio (<kbd>M</kbd>). Custom MatCap images not yet. See <a href="polypaint.html">Polypaint</a></td></tr><tr><td>Morph target</td><td>A <a href="layers.html">sculpt layer</a>; exported as glTF morph targets and FBX/USD blend shapes</td></tr><tr><td>Mrgb, M (material channel)</td><td>Not yet: there is no per-vertex material channel</td></tr><tr><td>Polyframe (PolyF, Shift+F)</td><td><strong>PolyF</strong> on the right shelf, <kbd>W</kbd> or <kbd>Shift</kbd>+<kbd>F</kbd></td></tr><tr><td>Polygroups</td><td><strong>Polygroups</strong>: same idea, same Ctrl+Shift gestures. See <a href="polygroups.html">Polygroups and visibility</a></td></tr><tr><td>Polypaint</td><td><strong>Polypaint</strong>: Paint brush (<kbd>P</kbd>), Rgb, fills, cavity paint. See <a href="polypaint.html">Polypaint</a></td></tr><tr><td>Projection Master</td><td>Not yet. <strong>Generate > Stamp</strong> projects an image onto the model from the view</td></tr><tr><td>QuickSave</td><td><strong>QuickSave</strong> in the title strip; the last 10 are kept. See <a href="projects.html#quicksave">Projects</a></td></tr><tr><td>Rgb</td><td><strong>Rgb</strong> on the top shelf (paint while sculpting)</td></tr><tr><td>Rgb Intensity, Z Intensity</td><td><strong>Strength</strong> (top shelf, <kbd>I</kbd>)</td></tr><tr><td>Sculptris Pro, dynamic topology</td><td>Not yet</td></tr><tr><td>SDiv, D / Shift+D (subdivision levels)</td><td>Not yet: Subdivide is a single, destructive step</td></tr><tr><td>Solo</td><td><strong>Solo</strong> on the right shelf or in <strong>Tool > SubTool</strong></td></tr><tr><td>Spotlight</td><td>Not yet</td></tr><tr><td>Store Config</td><td><strong>Store Config</strong>, <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> (<strong>Preferences > Config</strong>)</td></tr><tr><td>Stroke (Dots, DragRect, Spray)</td><td><strong>Stroke</strong> types Dots, DragRect, Spray, LazyMouse</td></tr><tr><td>SubTool</td><td><strong>SubTool</strong>: same idea, <kbd>Alt</kbd>+click to select. See <a href="subtools.html">SubTools</a></td></tr><tr><td>Texture palette</td><td>Not yet: there is no texture painting or texture slot</td></tr><tr><td>Transpose, Gizmo 3D</td><td>Not yet. Use the <strong>Move</strong> brush, or move the camera with the right-shelf buttons</td></tr><tr><td>UV Master</td><td>Not yet. UVs that come in with a GoZ model are kept (and saved in projects)</td></tr><tr><td>Zadd / Zsub</td><td><strong>Zadd</strong> / <strong>Zsub</strong> on the top shelf; <kbd>Alt</kbd> flips for one stroke</td></tr><tr><td>ZPlugin</td><td>No in-app plugin system yet. Automate with the Python module, <code>sculptforge-cli</code> and MCP (<a href="scripting.html">Scripting</a>)</td></tr><tr><td>ZRemesher</td><td>Not yet (quad retopology is on the roadmap)</td></tr><tr><td>ZScript</td><td>Script commands: the console (backtick key), script files, <code>sculptforge-cli</code>. See <a href="scripting.html">Scripting</a></td></tr><tr><td>ZTL, ZPR files</td><td>Not supported. Use GoZ, OBJ, FBX or GLB to bring models over; save work as <code>.sfproj</code></td></tr></tbody></table></div><h2 id="sculptforge-terms">SculptForge terms<a class="anchor" href="#sculptforge-terms" aria-label="Link to this section">#</a></h2><div class="table-wrap"><table><thead><tr><th>Term</th><th>Meaning</th></tr></thead><tbody><tr><td>Brush Lab</td><td>The AI brush creator: describe a brush in words and it builds a recipe you can tweak. Opens from <strong>AI Brush</strong>. See <a href="brush-lab.html">Brush Lab</a></td></tr><tr><td>Brush code</td><td>One line of text (<code>sfbrush1:...</code>) that holds a whole brush, for sharing in chat or a forum. Paste with <kbd>Ctrl</kbd>+<kbd>V</kbd></td></tr><tr><td>Brush library</td><td>Your saved custom brushes, loaded at every start</td></tr><tr><td>Brush recipe</td><td>The data that defines a custom brush (direction, depth, plane, pinch, pattern and so on): values, never code</td></tr><tr><td><code>.sfbrush</code></td><td>A file holding one brush recipe</td></tr><tr><td><code>.sfproj</code></td><td>A SculptForge project file: the whole scene. See <a href="projects.html">Projects</a></td></tr><tr><td>Command palette</td><td><kbd>F3</kbd>: search every command, brush and setting by name and run it</td></tr><tr><td>Community gallery</td><td>Shared CC0 brushes you can install in one click (<strong>Community brushes</strong>)</td></tr><tr><td>Console</td><td>The script console (backtick key): every action appears as a script line</td></tr><tr><td>Ctrl help</td><td>Hold <kbd>Ctrl</kbd> and point at a control to see what it does, its shortcut and its command</td></tr><tr><td>Gaussian splat</td><td>A 3D capture made of soft coloured blobs (from phone scanning apps). Load one as a reference, convert it to a mesh, or turn a sculpt into splats. See <a href="splats.html">Gaussian splats</a></td></tr><tr><td>Generate 3D</td><td>Turn an image or a description into a sculptable model. See <a href="generate-3d.html">Image and text to 3D</a></td></tr><tr><td>LOD chain</td><td>A series of lighter copies of a model (LOD0, LOD1...) for game engines. See <a href="geometry.html#lod-chains">Geometry</a></td></tr><tr><td>MCP</td><td>Model Context Protocol: <code>sculptforge-cli --mcp</code> lets AI agents such as Claude run SculptForge commands</td></tr><tr><td>Send to Unreal</td><td>Export and import a model into a running Unreal Editor in one step (<kbd>Ctrl</kbd>+<kbd>U</kbd>)</td></tr><tr><td>Shelves, palettes, trays</td><td>The interface around the canvas: shelves hold the most-used controls, palettes hold everything, trays hold pinned palettes. See <a href="interface.html">The interface</a></td></tr><tr><td>Studio brush folder</td><td>A shared, read-only brush folder for a team (<code>SCULPTFORGE_BRUSH_PATH</code>). See <a href="studios.html">For studios</a></td></tr></tbody></table></div><h2 id="see-also">See also<a class="anchor" href="#see-also" aria-label="Link to this section">#</a></h2>diff --git a/website/guide/images/interface-overview.jpg b/website/guide/images/interface-overview.jpgindex 2bfcad0c..d187d8b9 100644Binary files a/website/guide/images/interface-overview.jpg and b/website/guide/images/interface-overview.jpg differdiff --git a/website/guide/images/masking.jpg b/website/guide/images/masking.jpgindex 69d48b54..aa0a37f4 100644Binary files a/website/guide/images/masking.jpg and b/website/guide/images/masking.jpg differdiff --git a/website/guide/images/material-picker.jpg b/website/guide/images/material-picker.jpgindex a932c596..3cb0f4dd 100644Binary files a/website/guide/images/material-picker.jpg and b/website/guide/images/material-picker.jpg differdiff --git a/website/guide/images/polygroups.jpg b/website/guide/images/polygroups.jpgindex b852b330..47ffa6a4 100644Binary files a/website/guide/images/polygroups.jpg and b/website/guide/images/polygroups.jpg differdiff --git a/website/guide/images/polypaint.jpg b/website/guide/images/polypaint.jpgindex 4e7151f5..3833eca7 100644Binary files a/website/guide/images/polypaint.jpg and b/website/guide/images/polypaint.jpg differdiff --git a/website/guide/images/remesh.jpg b/website/guide/images/remesh.jpgindex ac159fff..09721327 100644Binary files a/website/guide/images/remesh.jpg and b/website/guide/images/remesh.jpg differdiff --git a/website/guide/images/sculpt-lion.jpg b/website/guide/images/sculpt-lion.jpgindex 11458243..5512941b 100644Binary files a/website/guide/images/sculpt-lion.jpg and b/website/guide/images/sculpt-lion.jpg differdiff --git a/website/guide/images/subtools.jpg b/website/guide/images/subtools.jpgindex 511172e2..031ee2ae 100644Binary files a/website/guide/images/subtools.jpg and b/website/guide/images/subtools.jpg differdiff --git a/website/guide/interface.html b/website/guide/interface.htmlindex 5b834b6e..5d870ecd 100644--- a/website/guide/interface.html+++ b/website/guide/interface.html@@ -87,7 +87,7 @@<p>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.</p><figure class="shot"><a href="images/palette-dropdown.jpg" class="zoom"><img src="images/palette-dropdown.jpg" alt="The Stroke palette open as a drop-down from the palette bar" width="620" height="560" loading="lazy" decoding="async"></a><figcaption>The Stroke palette open as a drop-down from the palette bar</figcaption></figure><p>The palette bar lists <strong>File</strong> and <strong>Edit</strong> first and <strong>Help</strong> 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 <strong>Preferences > Interface > Palettes strictly A-Z (ZBrush order)</strong>.</p>-<div class="table-wrap"><table><thead><tr><th>Palette</th><th>What's in it</th></tr></thead><tbody><tr><td><strong>File</strong></td><td>New Sphere, New Plane, Open, Open Recent, Save, Save As, autosave interval, Import and every export (OBJ, GLB, LOD chain, USD/USDZ, FBX for Unreal, Send to Unreal, splats), ZBrush (GoZ), Quit</td></tr><tr><td><strong>Edit</strong></td><td>Undo and Redo (with the name of the step), Paste brush</td></tr><tr><td><strong>Alpha</strong></td><td>The brush alphas: Round, Square, Noise, images from your library, Load image, Invert loaded image</td></tr><tr><td><strong>Brush</strong></td><td>AI Brush (Brush Lab), Community brushes, Paste brush, your custom brushes, Front faces only, Invert (Alt), the recipe editor for a custom brush, and every brush as a thumbnail grid with a filter</td></tr><tr><td><strong>Color</strong></td><td>The Paint brush, RGB while sculpting, the paint colour and swatches, Fill, Fill masked, Cavity, Clear, Show polypaint</td></tr><tr><td><strong>Draw</strong></td><td>Draw Size, Strength, Sculpt/Paint, Zadd/Zsub, Rgb, Front, and the tablet options (Pressure > strength, Pressure > size) with a pen readout</td></tr><tr><td><strong>Generate</strong></td><td>Generate 3D (image or text to 3D), Relief, Inflate and Stamp from an image, and the AI brush provider settings</td></tr><tr><td><strong>Material</strong></td><td>Studio and the six MatCap materials, Base colour</td></tr><tr><td><strong>Preferences</strong></td><td>Config, Interface, Hotkeys, LightBox and Autosave sub-palettes (see <a href="#customizing-the-interface">Customizing the interface</a>)</td></tr><tr><td><strong>Render</strong></td><td>Wireframe, Show Mesh, Show Polypaint, Show Mask, Show Polygroups, Show Splats, Frame, Fullscreen</td></tr><tr><td><strong>Script</strong></td><td>Console, Run script file, Copy session as script, Clear console</td></tr><tr><td><strong>Splats</strong></td><td>Gaussian splat tools: show, flip, turn, fit, clean floaters, convert to mesh, sculpt to splats, save, clear</td></tr><tr><td><strong>Stroke</strong></td><td>The stroke types (Dots, DragRect, Spray, LazyMouse) and their settings</td></tr><tr><td><strong>Tool</strong></td><td>The active SubTool with Open, Save and Import, and the SubTool, Layers, Geometry, Remesh, Masking, Polygroups, Visibility, Export and Display sub-palettes</td></tr><tr><td><strong>Transform</strong></td><td>Symmetry X, Y and Z, Frame, Solo, PolyF</td></tr><tr><td><strong>Help</strong></td><td>Controls, User Guide, Command palette, Website & documentation, Report a problem, About SculptForge</td></tr></tbody></table></div>+<div class="table-wrap"><table><thead><tr><th>Palette</th><th>What's in it</th></tr></thead><tbody><tr><td><strong>File</strong></td><td>New Sphere, New Plane, Open, Open Recent, Save, Save As, autosave interval, Import and every export (OBJ, GLB, LOD chain, USD/USDZ, FBX for Unreal, Send to Unreal, splats), ZBrush (GoZ), Quit</td></tr><tr><td><strong>Edit</strong></td><td>Undo and Redo (with the name of the step), Paste brush</td></tr><tr><td><strong>Alpha</strong></td><td>The brush alphas: Round, Square, Noise, images from your library, Load image, Invert loaded image</td></tr><tr><td><strong>Brush</strong></td><td>AI Brush (Brush Lab), Community brushes, Paste brush, your custom brushes, Front faces only, Invert (Alt), the recipe editor for a custom brush, and every brush as a thumbnail grid with a filter</td></tr><tr><td><strong>Color</strong></td><td>The Paint brush, RGB while sculpting, the paint colour and swatches, Fill, Fill masked, Cavity, Clear, Show polypaint</td></tr><tr><td><strong>Draw</strong></td><td>Draw Size, Strength, Sculpt/Paint, Zadd/Zsub, Rgb, Front, and the tablet options (Pressure > strength, Pressure > size) with a pen readout</td></tr><tr><td><strong>Generate</strong></td><td>Generate 3D (image or text to 3D), Relief, Inflate and Stamp from an image, and the AI brush provider settings</td></tr><tr><td><strong>Material</strong></td><td>The seven MatCap materials (Sculpt, the default, first) and Studio, Base colour</td></tr><tr><td><strong>Preferences</strong></td><td>Config, Interface, Hotkeys, LightBox and Autosave sub-palettes (see <a href="#customizing-the-interface">Customizing the interface</a>)</td></tr><tr><td><strong>Render</strong></td><td>Wireframe, Show Mesh, Show Polypaint, Show Mask, Show Polygroups, Show Splats, Frame, Fullscreen</td></tr><tr><td><strong>Script</strong></td><td>Console, Run script file, Copy session as script, Clear console</td></tr><tr><td><strong>Splats</strong></td><td>Gaussian splat tools: show, flip, turn, fit, clean floaters, convert to mesh, sculpt to splats, save, clear</td></tr><tr><td><strong>Stroke</strong></td><td>The stroke types (Dots, DragRect, Spray, LazyMouse) and their settings</td></tr><tr><td><strong>Tool</strong></td><td>The active SubTool with Open, Save and Import, and the SubTool, Layers, Geometry, Remesh, Masking, Polygroups, Visibility, Export and Display sub-palettes</td></tr><tr><td><strong>Transform</strong></td><td>Symmetry X, Y and Z, Frame, Solo, PolyF</td></tr><tr><td><strong>Help</strong></td><td>Controls, User Guide, Command palette, Website & documentation, Report a problem, About SculptForge</td></tr></tbody></table></div><h3 id="sub-palettes">Sub-palettes<a class="anchor" href="#sub-palettes" aria-label="Link to this section">#</a></h3><p>Large palettes are divided into <strong>sub-palettes</strong>: headers you click to open or close. The Tool palette is the main example (SubTool, Layers, Geometry and so on). By default opening one sub-palette closes the others in the same palette, which keeps the palette short. <strong>Shift</strong>+click a header to open it without closing the others, or turn off <strong>Preferences > Interface > One sub-palette open</strong>.</p><aside class="callout callout-zbrush"><p><strong>ZBrush:</strong> as in ZBrush, SubTool, Layers, Masking, Polygroups and Visibility are sub-palettes of the Tool palette rather than palettes of their own. SculptForge's Remesh sub-palette is where DynaMesh would be.</p></aside>@@ -241,7 +241,7 @@ Press that orange letter to pick the brush. For example <kbd>B</kbd> <kbd>S</kbd<strong>Alpha</strong> (click the Alpha tile): Round, Square and Noise, the image alpha you loaded, images in your library's Alphas folder, <strong>Load image...</strong> and <strong>Invert loaded image</strong>.</li><li>-<strong>Material</strong> (<kbd>M</kbd>, or click the Material tile): Studio and the MatCaps. Point at a material to preview it on the model; click to keep it. Closing the picker without clicking puts the old material back. See <a href="polypaint.html">Polypaint and materials</a>.+<strong>Material</strong> (<kbd>M</kbd>, or click the Material tile): the MatCaps and Studio. Point at a material to preview it on the model; click to keep it. Closing the picker without clicking puts the old material back. See <a href="polypaint.html">Polypaint and materials</a>.</li></ul><h3 id="draw-size-and-strength-at-the-cursor">Draw Size and Strength at the cursor<a class="anchor" href="#draw-size-and-strength-at-the-cursor" aria-label="Link to this section">#</a></h3>@@ -249,7 +249,7 @@ Press that orange letter to pick the brush. For example <kbd>B</kbd> <kbd>S</kbd<h2 id="the-lightbox">The LightBox<a class="anchor" href="#the-lightbox" aria-label="Link to this section">#</a></h2><p>The LightBox is a strip of thumbnails across the top of the canvas for browsing everything you can load. Press <kbd>,</kbd> (comma) or click <strong>LightBox</strong> on the top shelf to show or hide it. It opens on its own at start-up (see <a href="#interface-preferences">Preferences</a>).</p><figure class="shot"><a href="images/lightbox.jpg" class="zoom"><img src="images/lightbox.jpg" alt="The LightBox on the Tool tab" width="800" height="200" loading="lazy" decoding="async"></a><figcaption>The LightBox on the Tool tab</figcaption></figure>-<div class="table-wrap"><table><thead><tr><th>Tab</th><th>Shows</th><th>Double-click</th></tr></thead><tbody><tr><td><strong>Project</strong></td><td>Projects (<code>.sfproj</code>) in your library and recently opened projects</td><td>Open the project</td></tr><tr><td><strong>Tool</strong></td><td>Sphere, Plane and Cube, and model files in your library</td><td>Open (replaces the scene)</td></tr><tr><td><strong>Brush</strong></td><td>Every brush: built-in, custom and <code>.sfbrush</code> files</td><td>Select or load the brush</td></tr><tr><td><strong>Alpha</strong></td><td>Round, Square, Noise and images in your Alphas folder</td><td>Use as the brush alpha</td></tr><tr><td><strong>Material</strong></td><td>Studio and the MatCaps</td><td>Use the material</td></tr><tr><td><strong>Image</strong></td><td>Reference images in your library</td><td>A menu: Generate 3D, relief, inflate, project onto the model, use as alpha</td></tr><tr><td><strong>Splats</strong></td><td>Gaussian splat captures (<code>.ply</code>, <code>.splat</code>)</td><td>Open the capture as a reference</td></tr><tr><td><strong>QuickSave</strong></td><td>The autosave and your QuickSaves, newest first</td><td>Open it</td></tr><tr><td><strong>Recent</strong></td><td>Recently opened files of every kind</td><td>Open it</td></tr></tbody></table></div>+<div class="table-wrap"><table><thead><tr><th>Tab</th><th>Shows</th><th>Double-click</th></tr></thead><tbody><tr><td><strong>Project</strong></td><td>Projects (<code>.sfproj</code>) in your library and recently opened projects</td><td>Open the project</td></tr><tr><td><strong>Tool</strong></td><td>Sphere, Plane and Cube, and model files in your library</td><td>Open (replaces the scene)</td></tr><tr><td><strong>Brush</strong></td><td>Every brush: built-in, custom and <code>.sfbrush</code> files</td><td>Select or load the brush</td></tr><tr><td><strong>Alpha</strong></td><td>Round, Square, Noise and images in your Alphas folder</td><td>Use as the brush alpha</td></tr><tr><td><strong>Material</strong></td><td>The MatCaps and Studio</td><td>Use the material</td></tr><tr><td><strong>Image</strong></td><td>Reference images in your library</td><td>A menu: Generate 3D, relief, inflate, project onto the model, use as alpha</td></tr><tr><td><strong>Splats</strong></td><td>Gaussian splat captures (<code>.ply</code>, <code>.splat</code>)</td><td>Open the capture as a reference</td></tr><tr><td><strong>QuickSave</strong></td><td>The autosave and your QuickSaves, newest first</td><td>Open it</td></tr><tr><td><strong>Recent</strong></td><td>Recently opened files of every kind</td><td>Open it</td></tr></tbody></table></div><p>Working with the strip:</p><ul><li>diff --git a/website/guide/polypaint.html b/website/guide/polypaint.htmlindex 9f076006..4e1d2263 100644--- a/website/guide/polypaint.html+++ b/website/guide/polypaint.html@@ -118,7 +118,7 @@ Press <kbd>C</kbd> with the cursor over the model to pick the colour under it (t<aside class="callout callout-tip"><p><strong>Tip:</strong> To paint a base colour and then dirt in the creases: <strong>Fill</strong> with the base colour, then <strong>Cavity</strong>. For a different cavity colour or strength, use the command (below).</p></aside><h2 id="materials-matcaps">Materials (MatCaps)<a class="anchor" href="#materials-matcaps" aria-label="Link to this section">#</a></h2><p>Materials change only how the model is shaded in the viewport. They aren't exported and don't change polypaint.</p>-<div class="table-wrap"><table><thead><tr><th>Material</th><th>Look</th></tr></thead><tbody><tr><td>Studio</td><td>The default clay shading with soft studio lighting. Its colour is <strong>Base colour</strong> in the Material palette</td></tr><tr><td>Red Wax</td><td>Glossy deep red wax, the classic sculpting look</td></tr><tr><td>Clay</td><td>Matte grey-brown clay</td></tr><tr><td>Skin</td><td>Warm, soft skin tones</td></tr><tr><td>Chrome</td><td>Mirror-like metal, good for checking surface flow</td></tr><tr><td>White</td><td>Neutral off-white for judging forms</td></tr><tr><td>Bronze</td><td>Polished bronze</td></tr></tbody></table></div>+<div class="table-wrap"><table><thead><tr><th>Material</th><th>Look</th></tr></thead><tbody><tr><td>Sculpt</td><td>The default, made for sculpting: neutral warm clay under a strong key light from the upper left, a crisp highlight and deep cavity shading, so small strokes and undulations stay readable</td></tr><tr><td>Red Wax</td><td>Glossy deep red wax, the classic sculpting look</td></tr><tr><td>Clay</td><td>Matte grey-brown clay</td></tr><tr><td>Skin</td><td>Warm, soft skin tones</td></tr><tr><td>Chrome</td><td>Mirror-like metal, good for checking surface flow</td></tr><tr><td>White</td><td>Neutral off-white for judging forms</td></tr><tr><td>Bronze</td><td>Polished bronze</td></tr><tr><td>Studio</td><td>Softer clay shading with studio lighting (the default in earlier versions). Its colour is <strong>Base colour</strong> in the Material palette</td></tr></tbody></table></div><p>To choose one:</p><ul><li>@@ -128,11 +128,12 @@ Press <kbd>M</kbd> for the material picker under the cursor, or click the <stronOpen the <strong>Material</strong> palette, or the <strong>Material</strong> tab of the LightBox.</li></ul>-<figure class="shot"><a href="images/material-picker.jpg" class="zoom"><img src="images/material-picker.jpg" alt="The material picker with the six MatCaps and Studio" width="520" height="260" loading="lazy" decoding="async"></a><figcaption>The material picker with the six MatCaps and Studio</figcaption></figure>-<p>Polypaint multiplies the material, and cavity shading stays on with every material. The material is saved with the project.</p>+<figure class="shot"><a href="images/material-picker.jpg" class="zoom"><img src="images/material-picker.jpg" alt="The material picker with the seven MatCaps and Studio" width="520" height="260" loading="lazy" decoding="async"></a><figcaption>The material picker with the seven MatCaps and Studio</figcaption></figure>+<p>Polypaint multiplies the material, and cavity shading stays on with every material (strongest with Sculpt). The material is saved with the project: projects saved with Studio open with Studio.</p>+<aside class="callout callout-tip"><p><strong>Tip:</strong> <strong>Sculpt</strong> is the material to judge strokes with. The prettier ones (Skin, Red Wax) soften small detail; switch to them for presenting.</p></aside><aside class="callout callout-not-yet"><p><strong>Not yet:</strong> loading your own MatCap images, and physically based materials or BPR-style renders.</p></aside><h2 id="scripting">Scripting<a class="anchor" href="#scripting" aria-label="Link to this section">#</a></h2>-<div class="table-wrap"><table><thead><tr><th>Command</th><th>What it does</th></tr></thead><tbody><tr><td><code>set_color color=#c08060</code></td><td>Set the paint colour: <code>rrggbb</code>, <code>#rrggbb</code> (quote it in scripts), <code>r,g,b</code> or a name such as <code>white</code>, <code>skin</code>, <code>bone</code></td></tr><tr><td><code>paint_fill area=unmasked</code></td><td>Fill; <code>area</code> is <code>unmasked</code> (default), <code>masked</code> or <code>all</code>; <code>strength</code> 0-1</td></tr><tr><td><code>paint_from_cavity color=#202020 strength=0.7 smoothing=2</code></td><td>Cavity paint (defaults: dark brown, 0.7, 2 blur passes)</td></tr><tr><td><code>paint_clear</code></td><td>Remove all polypaint</td></tr><tr><td><code>set_material name=Chrome</code></td><td>Viewport material: <code>studio</code> or a MatCap name (desktop app only)</td></tr></tbody></table></div>+<div class="table-wrap"><table><thead><tr><th>Command</th><th>What it does</th></tr></thead><tbody><tr><td><code>set_color color=#c08060</code></td><td>Set the paint colour: <code>rrggbb</code>, <code>#rrggbb</code> (quote it in scripts), <code>r,g,b</code> or a name such as <code>white</code>, <code>skin</code>, <code>bone</code></td></tr><tr><td><code>paint_fill area=unmasked</code></td><td>Fill; <code>area</code> is <code>unmasked</code> (default), <code>masked</code> or <code>all</code>; <code>strength</code> 0-1</td></tr><tr><td><code>paint_from_cavity color=#202020 strength=0.7 smoothing=2</code></td><td>Cavity paint (defaults: dark brown, 0.7, 2 blur passes)</td></tr><tr><td><code>paint_clear</code></td><td>Remove all polypaint</td></tr><tr><td><code>set_material name=Chrome</code></td><td>Viewport material: a MatCap name (<code>Sculpt</code> is the default) or <code>studio</code> (desktop app only)</td></tr></tbody></table></div><div class="code-block"><pre class="code"><code class="language-text">set_color color="#d9b38c"; paint_fill; paint_from_cavity strength=0.5</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div><h2 id="see-also">See also<a class="anchor" href="#see-also" aria-label="Link to this section">#</a></h2><ul>diff --git a/website/guide/scripting.html b/website/guide/scripting.htmlindex b55d7b01..a68a47e9 100644--- a/website/guide/scripting.html+++ b/website/guide/scripting.html@@ -116,7 +116,7 @@ Type a statement and press <kbd>Enter</kbd> to run it. Several statements separa<h2 id="commonly-used-commands">Commonly used commands<a class="anchor" href="#commonly-used-commands" aria-label="Link to this section">#</a></h2><p><code>sculptforge-cli --list</code> (or <code>help</code> in the console) prints every command with all its parameters. These are the ones you will use most:</p><div class="table-wrap"><table><thead><tr><th>Area</th><th>Command</th><th>Key parameters</th></tr></thead><tbody><tr><td>Scene</td><td><code>new_sphere</code></td><td><code>subdivisions</code> (0 to 8, default 6)</td></tr><tr><td>Scene</td><td><code>new_plane</code></td><td><code>resolution</code> (cells per side, default 128)</td></tr><tr><td>Files</td><td><code>open</code></td><td><code>path</code>: models, projects, splats, GoZ</td></tr><tr><td>Files</td><td><code>save_project</code></td><td><code>path</code> (default: the current project)</td></tr><tr><td>Files</td><td><code>open_project</code></td><td><code>path</code></td></tr><tr><td>Geometry</td><td><code>subdivide</code></td><td><code>levels</code> (1 to 4, default 1)</td></tr><tr><td>Geometry</td><td><code>remesh</code></td><td><code>resolution</code> (32 to 512, default 200)</td></tr><tr><td>Geometry</td><td><code>decimate</code></td><td><code>ratio</code> (default 0.5) or <code>triangles</code></td></tr><tr><td>Geometry</td><td><code>mesh_info</code></td><td></td></tr><tr><td>Sculpting</td><td><code>stroke</code></td><td><code>points</code> (required), <code>brush</code>, <code>radius</code>, <code>strength</code>, <code>invert</code>, <code>symmetry</code></td></tr><tr><td>Brushes</td><td><code>brush_set_alpha</code></td><td><code>name</code> (round, square, noise) or <code>path</code>, <code>invert</code></td></tr><tr><td>Brushes</td><td><code>brush_ai</code></td><td><code>prompt</code> (required), <code>provider</code>, <code>model</code>, <code>endpoint</code></td></tr><tr><td>Brushes</td><td><code>brush_install</code></td><td><code>path</code>, <code>code</code> or <code>json</code></td></tr><tr><td>Brushes</td><td><code>brush_save</code></td><td><code>path</code> (required), <code>name</code></td></tr><tr><td>Layers</td><td><code>layer_add</code></td><td><code>name</code></td></tr><tr><td>Layers</td><td><code>layer_set_weight</code></td><td><code>index</code>, <code>weight</code> (both required)</td></tr><tr><td>Masking</td><td><code>mask_by_cavity</code></td><td><code>strength</code>, <code>threshold</code></td></tr><tr><td>Masking</td><td><code>mask_invert</code>, <code>mask_clear</code>, <code>mask_blur</code>, <code>mask_grow</code></td><td><code>iterations</code> where it applies</td></tr><tr><td>Polygroups</td><td><code>polygroup_auto_by_normals</code></td><td><code>angle</code> (default 30)</td></tr><tr><td>Visibility</td><td><code>isolate_polygroup</code>, <code>hide_polygroup</code></td><td><code>group</code> (required)</td></tr><tr><td>Visibility</td><td><code>show_all</code>, <code>delete_hidden</code></td><td></td></tr><tr><td>SubTools</td><td><code>subtool_append</code></td><td><code>type</code> (sphere, cube, plane) or <code>path</code>, <code>name</code>, <code>size</code></td></tr><tr><td>SubTools</td><td><code>subtool_select</code></td><td><code>index</code> or <code>name</code></td></tr><tr><td>Polypaint</td><td><code>set_color</code>, <code>paint_fill</code></td><td><code>color</code>, <code>area</code> (unmasked, masked, all)</td></tr><tr><td>Polypaint</td><td><code>paint_from_cavity</code></td><td><code>color</code>, <code>strength</code>, <code>smoothing</code></td></tr><tr><td>AI</td><td><code>image_to_3d</code></td><td><code>path</code> (required), <code>service</code>, <code>model</code>, <code>remesh</code>, <code>resolution</code></td></tr><tr><td>AI</td><td><code>text_to_3d</code></td><td><code>prompt</code> (required), <code>service</code>, <code>model</code></td></tr><tr><td>Export</td><td><code>export_glb</code>, <code>export_usd</code>, <code>export_stl</code>, <code>export_ply</code></td><td><code>path</code> (required)</td></tr><tr><td>Export</td><td><code>export_fbx</code></td><td><code>path</code> (required), <code>lods</code>, <code>ratio</code>, <code>scale</code></td></tr><tr><td>Export</td><td><code>export_lods</code></td><td><code>path</code> (required), <code>levels</code>, <code>ratio</code></td></tr><tr><td>Unreal</td><td><code>unreal_send</code></td><td><code>destination</code>, <code>height_cm</code>, <code>lods</code>, <code>network</code></td></tr><tr><td>Splats</td><td><code>splat_to_mesh</code></td><td><code>resolution</code>, <code>close</code>, <code>smooth</code></td></tr><tr><td>Edit</td><td><code>undo</code>, <code>redo</code></td><td></td></tr></tbody></table></div>-<p>A few commands exist only inside the app, because they change the view rather than the model: <code>set_material</code> (<code>name=</code> Studio or a MatCap) and <code>new_cube</code>.</p>+<p>A few commands exist only inside the app, because they change the view rather than the model: <code>set_material</code> (<code>name=</code> a MatCap such as Sculpt, or Studio) and <code>new_cube</code>.</p><h2 id="sculptforge-cli">sculptforge-cli<a class="anchor" href="#sculptforge-cli" aria-label="Link to this section">#</a></h2><p><code>sculptforge-cli</code> runs commands without a window: on a server, a render farm node or in a build pipeline. It keeps one scene for the whole run, loads your brush library (and studio brushes), and uses the same <code>ai.json</code> settings as the app.</p><div class="code-block"><pre class="code"><code class="language-text">sculptforge-cli [options]diff --git a/website/guide/search-index.js b/website/guide/search-index.jsindex b5f9deab..60625b57 100644--- a/website/guide/search-index.js+++ b/website/guide/search-index.js@@ -1 +1 @@-window.GUIDE_INDEX=[{"p":"index.html","c":"SculptForge User Guide","a":"","h":"SculptForge User Guide","t":"This guide explains every part of SculptForge, the free, open-source sculpting app for VFX, animation and games: how the interface is organised, how to sculpt, mask, paint and manage SubTools, how to generate models with AI, and how to get your work into a game engine, a film pipeline or ZBrush. It is written for SculptForge 0.3. You can read it inside SculptForge (Help > User Guide, or Shift+F1) or on the SculptForge website. If you're coming from ZBrush, start with The interface and keep the Glossary at hand: most ZBrush habits work as they are. The SculptForge window with its main regions labelled"},{"p":"index.html","c":"SculptForge User Guide","a":"getting-started","h":"Getting started","t":"Welcome to SculptForge Installing SculptForge The interface Navigating the view"},{"p":"index.html","c":"SculptForge User Guide","a":"sculpting","h":"Sculpting","t":"Sculpting and brushes Brush Lab and sharing brushes Masking Polygroups and visibility SubTools Polypaint and materials Sculpt layers and blend shapes Subdivide, remesh, decimate and LODs"},{"p":"index.html","c":"SculptForge User Guide","a":"ai-and-capture","h":"AI and capture","t":"Image and text to 3D Gaussian splats"},{"p":"index.html","c":"SculptForge User Guide","a":"files-and-pipelines","h":"Files and pipelines","t":"Exporting, Unreal and ZBrush Projects, autosave and QuickSave Scripting and automation SculptForge for studios"},{"p":"index.html","c":"SculptForge User Guide","a":"reference","h":"Reference","t":"Keyboard and mouse Troubleshooting and FAQ Glossary"},{"p":"index.html","c":"SculptForge User Guide","a":"getting-help","h":"Getting help","t":"Hold Ctrl and point at any button for what it does, its shortcut and its script command. Press F1 for every shortcut and mouse gesture, and F3 to find any command by name. Ask questions and report problems on the issue tracker (Help > Report a problem). SculptForge is free software under the GNU General Public License v3.0 or later. This guide is part of SculptForge and is covered by the same licence."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"","h":"Welcome to SculptForge","t":"SculptForge is a free, open-source digital sculpting application for VFX, animation and games. This chapter explains what it is, what it can and can't do yet, and how the rest of this guide is organised."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"what-sculptforge-is","h":"What SculptForge is","t":"SculptForge is a focused sculpting tool with the brushes, symmetry, masking and navigation that ZBrush artists already know, built around a ZBrush-style interface: shelves around a canvas, alphabetical palettes that hold every function, a LightBox of thumbnails and pop-up pickers. It runs natively on Windows, macOS and Linux, starts in a moment, works offline and costs nothing. There is no account, no subscription, no licence server and no telemetry. It is free software under the GNU General Public License v3.0 or later. You own everything you make with it: the GPL covers the program, not your models."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"what-you-can-do-with-it","h":"What you can do with it","t":"Sculpt with fourteen built-in brushes (Standard, Clay, Clay Buildup, Dam Standard, Move, Smooth, Inflate, Pinch, Flatten, Crease, Trim, Snake Hook, Layer and Nudge), four stroke types, brush alphas, X/Y/Z symmetry and tablet pressure. See Sculpting and brushes. Design brushes in words with Brush Lab: describe \"dry cracked mud\" and an AI builds a brush recipe you can tweak with sliders, keep in your library and share as a file or a one-line brush code. See Brush Lab and sharing brushes. Mask, group and hide parts of the model the ZBrush way: Ctrl to paint a mask, Ctrl+Shift to isolate a polygroup. See Masking and Polygroups and visibility. Keep separate meshes as SubTools (body, eyes, teeth, armour), each with its own undo history. See SubTools. Paint colour on the surface (polypaint) and look at the model through six MatCap materials. See Polypaint and materials. Sculpt layers that double as blend shapes (morph targets), with live weights. See Sculpt layers and blend shapes. Rebuild the mesh: Loop subdivision, voxel remesh (similar to DynaMesh), decimation and one-click LOD chains. See Subdivide, remesh, decimate and LODs. Generate a model from a sketch, concept art or a description, free through Hugging Face or on your own ComfyUI server. See Image and text to 3D. Work with Gaussian splats from phone captures: sculpt against them or turn them into meshes. See Gaussian splats. Export to glTF/GLB, FBX, OpenUSD, OBJ, STL and PLY, send models straight into Unreal Engine, and exchange them with ZBrush through GoZ. See Exporting, Unreal and ZBrush. Automate everything: every action is a command you can type in the console, run headless with sculptforge-cli, script from Python or hand to an AI agent over MCP. See Scripting and automation."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"what-it-doesnt-do-yet","h":"What it doesn't do yet","t":"SculptForge is young (version 0.3). Some things ZBrush artists rely on are still on the roadmap: Multiresolution sculpting (subdivision levels you can step up and down). Subdivide works, but it is a one-way operation. Dynamic topology (Sculptris Pro style) and ZRemesher-class quad retopology. UV unwrapping, texture painting and map baking. Booleans, stencils, and lasso or marquee masking. Others are not on the roadmap: ZSpheres, ZModeler, the 2.5D canvas, and reading ZBrush's own .ZTL and .ZPR files (bring models over with GoZ or as OBJ, FBX or GLB instead). Not yet: where a chapter describes a ZBrush feature SculptForge doesn't have, it says so in a callout like this one. The project's ROADMAP.md lists what is planned and in which order."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"coming-from-zbrush","h":"Coming from ZBrush","t":"Most habits carry over. You sculpt with a left drag, hold Alt to subtract and Shift to smooth, drag on the background to rotate, Alt+drag to pan, and hold Ctrl to mask. The palettes have the names you expect (Alpha, Brush, Stroke, Tool, Transform...), the Tool palette holds the SubTool, Masking and Polygroups sub-palettes, B opens the brush pop-up with the same letter keys (B, S, T picks Standard), , opens the LightBox and Ctrl+Shift+I stores your interface. The Glossary maps ZBrush terms to SculptForge ones."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"how-this-guide-is-organised","h":"How this guide is organised","t":"Getting started: installing, the interface and navigating the view. Sculpting: brushes, Brush Lab, masking, polygroups, SubTools, polypaint, layers and mesh operations. AI and capture: generating models from images and text, and Gaussian splats. Files and pipelines: exporting, projects, scripting and studio deployment. Reference: keyboard and mouse, troubleshooting and the glossary. Inside SculptForge, Help > User Guide opens this guide in its own window with a table of contents, search and links between chapters. Two other kinds of help are always a keystroke away: Hold Ctrl and point at any button, slider or tile to see what it does, its shortcut and the script command behind it. Press F1 for the Controls sheet (every shortcut and mouse gesture) or F3 to search for any command by name."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"getting-help-and-reporting-problems","h":"Getting help and reporting problems","t":"Help > Report a problem opens the issue tracker on GitHub (github.com/islandmed/SculptForge/issues). Include your operating system, your graphics card and what you did just before the problem; see Troubleshooting and FAQ for what else helps. Help > Website & documentation opens the SculptForge website."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"see-also","h":"See also","t":"Installing SculptForge The interface Glossary"},{"p":"installing.html","c":"Installing SculptForge","a":"","h":"Installing SculptForge","t":"This chapter covers what SculptForge needs, which package to download for your system, what to expect the first time you open it, and how to build it from source."},{"p":"installing.html","c":"Installing SculptForge","a":"system-requirements","h":"System requirements","t":"Operating system: Windows 10 or 11 (x64), macOS 11 or later (Apple Silicon or Intel), or a 64-bit Linux distribution (x86_64 or ARM64) with X11 or Wayland. Graphics: a GPU and driver that support OpenGL 3.3 (core profile). Any graphics card from the last ten years qualifies, including integrated Intel, AMD and Apple GPUs. SculptForge asks for 4x multisampling and falls back to none if the driver refuses it. Input: a three-button mouse works for everything. A pen tablet adds pressure (see Sculpting and brushes). Network: not needed for sculpting. The free AI features (Brush Lab and image or text to 3D) and the community brush gallery need an internet connection unless you run models on your own machine. Note: SculptForge is a 64-bit desktop application. There is no web, iPad or Android version."},{"p":"installing.html","c":"Installing SculptForge","a":"download","h":"Download","t":"Download the latest release from the releases page. Pick the file for your system: System File How to install Windows 10/11 (x64) SculptForge--windows-x86_64.exe Run the installer (adds a Start menu shortcut) Windows, portable SculptForge--windows-x86_64.zip Unzip anywhere and run bin\\sculptforge.exe macOS 11+ (Apple Silicon and Intel) SculptForge--darwin-universal.dmg Open the disk image and drag SculptForge to Applications Ubuntu, Debian, Mint, Pop!_OS sculptforge__amd64.deb or ..._arm64.deb sudo apt install ./sculptforge_*.deb Fedora, RHEL, Rocky, Alma 8+ sculptforge-...x86_64.rpm or ...aarch64.rpm sudo dnf install ./sculptforge-*.rpm Any Linux SculptForge--linux-x86_64.AppImage or ...-arm64.AppImage chmod +x the file, then run it Arch Linux packaging/arch/PKGBUILD in the source makepkg -si in that folder (an AUR package is planned) Studio pipelines SculptForge--...-vfx2026.tar.gz or ...-vfx2027.tar.gz See SculptForge for studios Every release also has a SHA256SUMS.txt file with the checksum of each download, so you can confirm a file arrived intact. Each package contains two programs: SculptForge, the desktop application, and sculptforge-cli, the headless command-line tool for scripts, build farms and AI agents (see Scripting and automation). On macOS the command-line tool sits inside the app bundle, at SculptForge.app/Contents/MacOS/sculptforge-cli."},{"p":"installing.html","c":"Installing SculptForge","a":"opening-sculptforge-for-the-first-time","h":"Opening SculptForge for the first time","t":"The builds are not code-signed yet, so your operating system may warn you the first time."},{"p":"installing.html","c":"Installing SculptForge","a":"macos-gatekeeper","h":"macOS: Gatekeeper","t":"macOS may say that SculptForge \"cannot be opened because the developer cannot be verified\". In Finder, open the Applications folder. Right-click (or Ctrl+click) SculptForge and choose Open. Click Open in the dialog that appears. You only need to do this once. On recent macOS versions you may instead have to go to System Settings > Privacy & Security and click Open Anyway next to the message about SculptForge."},{"p":"installing.html","c":"Installing SculptForge","a":"windows-smartscreen","h":"Windows: SmartScreen","t":"Windows may show \"Windows protected your PC\". Click More info. Click Run anyway."},{"p":"installing.html","c":"Installing SculptForge","a":"linux","h":"Linux","t":"The .deb and .rpm packages add SculptForge to your desktop's application menu. An AppImage needs to be made executable first (chmod +x SculptForge-*.AppImage, or tick \"Allow executing file as program\" in your file manager's properties)."},{"p":"installing.html","c":"Installing SculptForge","a":"what-you-see-at-start-up","h":"What you see at start-up","t":"SculptForge opens a 1600 x 960 window with a sphere ready to sculpt and the LightBox open along the top of the canvas on its Project tab, so you can reopen recent work with a double-click. Press , (comma) to close it, or turn off Preferences > LightBox > Show at startup. The first start also creates your library folder (Documents/SculptForge, with Projects, Tools, Brushes, Alphas, Images, Splats and QuickSave sub-folders), which the LightBox shows as User. You can open a file directly from the command line, too: sculptforge model.obj (or a .glb, .sfproj, splat capture or image). sculptforge --fullscreen starts filling the screen; sculptforge --help lists every option. The next chapter, The interface, explains what everything on screen does."},{"p":"installing.html","c":"Installing SculptForge","a":"updating-and-uninstalling","h":"Updating and uninstalling","t":"SculptForge doesn't update itself. To update, download the new release and install it over the old one. Your settings, brushes and library are kept: they live in your user folders, not next to the program (see Troubleshooting and FAQ for where). To uninstall, use your system's usual method (Settings > Apps on Windows, dragging the app to the Bin on macOS, sudo apt remove sculptforge or sudo dnf remove sculptforge on Linux, or delete the AppImage). Delete the settings and library folders as well if you want to remove everything."},{"p":"installing.html","c":"Installing SculptForge","a":"building-from-source","h":"Building from source","t":"You need CMake 3.24 or later and a C++20 compiler: GCC 11+, Clang 14+, Xcode 15+ or Visual Studio 2022. Dear ImGui, GLM and (if it isn't installed already) SDL3 are downloaded automatically. AI features use libcurl on Linux and macOS and the built-in WinHTTP on Windows. git clone https://github.com/islandmed/SculptForge.git cd SculptForge # Linux only: compilers and X11/Wayland/GL/curl headers (Debian/Ubuntu or Fedora/RHEL) sudo ./packaging/linux/install-build-deps.sh cmake -S . -B build -DCMAKE_BUILD_TYPE=Release cmake --build build --parallel ctest --test-dir build --output-on-failure ./build/sculptforge On Windows the program is build\\Release\\sculptforge.exe; on macOS run open build/SculptForge.app. Useful CMake options: Option Default What it does SCULPTFORGE_BUILD_APP ON Build the desktop application (turn off for a headless build of sculptforge-cli only) SCULPTFORGE_BUILD_PYTHON OFF Build the Python module (import sculptforge); needs Python development headers SCULPTFORGE_BUILD_TESTS ON Build the unit and UI tests SCULPTFORGE_USE_SYSTEM_SDL ON Use an installed SDL3 if one is found Running cpack in the build folder makes the platform's packages (.deb, .rpm and .tar.gz on Linux, a .dmg on macOS, an installer and a .zip on Windows)."},{"p":"installing.html","c":"Installing SculptForge","a":"see-also","h":"See also","t":"The interface Troubleshooting and FAQ SculptForge for studios"},{"p":"interface.html","c":"The interface","a":"","h":"The interface","t":"SculptForge's window is laid out like ZBrush's: a canvas in the middle, shelves of the most-used controls around it, a bar of alphabetical palettes that hold every function, and trays at the sides where palettes can stay open. This chapter walks through each region, the pop-up pickers, the LightBox, the built-in help, and how to rearrange the interface and keep your changes. The SculptForge window with its main regions labelled"},{"p":"interface.html","c":"The interface","a":"the-regions-at-a-glance","h":"The regions at a glance","t":"Region Where What it holds Title strip Top edge Document name, scene statistics, status messages, QuickSave, layout presets, Menus, Search Palette bar Under the title strip The 16 palettes, which hold every function Top shelf Above the canvas LightBox, Sculpt/Paint, Zadd/Zsub, Rgb, Draw Size, Strength, symmetry, pressure Left shelf Left of the canvas Brush, Stroke, Alpha and Material tiles, the colour picker Canvas Centre The 3D view; strokes and navigation start only here Right shelf Right of the canvas Frame, Move, Zoom and Rotate, display toggles, Solo Bottom shelf Below the canvas Your quick brushes Trays Far left and far right Palettes you keep open; the right tray holds the Tool palette by default Press Tab to hide the shelves and trays for a bigger canvas, and again to bring them back. The palette bar stays, so every function is still one click away."},{"p":"interface.html","c":"The interface","a":"the-title-strip","h":"The title strip","t":"From left to right: SculptForge and the document name (\"Untitled\" until you save). A * after the name means there are unsaved changes; click the name to save (Ctrl+S). Scene statistics: vertices and triangles across all SubTools, the active SubTool and its position (\"SubTool Body (2/5)\"), the active sculpt layer (\"Layer Base\" when you sculpt the base mesh), the number of Gaussian splats when a capture is loaded, and the frame rate. The status message: the result of the last command or action. Errors show in red for a few seconds. Point at a long message to read all of it. QuickSave: saves a timestamped copy of the whole scene to your library without touching your project file (see Projects, autosave and QuickSave). 1, 2, 3: the layout presets (see Layout presets). Menus: shows or hides the palette bar. Search (F3): opens the command palette. Minimize and Close at the far right. Close asks to save changes first, as Ctrl+Q does."},{"p":"interface.html","c":"The interface","a":"palettes","h":"Palettes","t":"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 Esc or click outside to close it. The Stroke palette open as a drop-down from the palette bar The palette bar lists File and Edit first and Help last, where other desktop applications put them, and the rest in alphabetical order. If you prefer ZBrush's strict A to Z order, turn on Preferences > Interface > Palettes strictly A-Z (ZBrush order). Palette What's in it File New Sphere, New Plane, Open, Open Recent, Save, Save As, autosave interval, Import and every export (OBJ, GLB, LOD chain, USD/USDZ, FBX for Unreal, Send to Unreal, splats), ZBrush (GoZ), Quit Edit Undo and Redo (with the name of the step), Paste brush Alpha The brush alphas: Round, Square, Noise, images from your library, Load image, Invert loaded image Brush AI Brush (Brush Lab), Community brushes, Paste brush, your custom brushes, Front faces only, Invert (Alt), the recipe editor for a custom brush, and every brush as a thumbnail grid with a filter Color The Paint brush, RGB while sculpting, the paint colour and swatches, Fill, Fill masked, Cavity, Clear, Show polypaint Draw Draw Size, Strength, Sculpt/Paint, Zadd/Zsub, Rgb, Front, and the tablet options (Pressure > strength, Pressure > size) with a pen readout Generate Generate 3D (image or text to 3D), Relief, Inflate and Stamp from an image, and the AI brush provider settings Material Studio and the six MatCap materials, Base colour Preferences Config, Interface, Hotkeys, LightBox and Autosave sub-palettes (see Customizing the interface) Render Wireframe, Show Mesh, Show Polypaint, Show Mask, Show Polygroups, Show Splats, Frame, Fullscreen Script Console, Run script file, Copy session as script, Clear console Splats Gaussian splat tools: show, flip, turn, fit, clean floaters, convert to mesh, sculpt to splats, save, clear Stroke The stroke types (Dots, DragRect, Spray, LazyMouse) and their settings Tool The active SubTool with Open, Save and Import, and the SubTool, Layers, Geometry, Remesh, Masking, Polygroups, Visibility, Export and Display sub-palettes Transform Symmetry X, Y and Z, Frame, Solo, PolyF Help Controls, User Guide, Command palette, Website & documentation, Report a problem, About SculptForge"},{"p":"interface.html","c":"The interface","a":"sub-palettes","h":"Sub-palettes","t":"Large palettes are divided into sub-palettes: headers you click to open or close. The Tool palette is the main example (SubTool, 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. ZBrush: as in ZBrush, SubTool, Layers, Masking, Polygroups and Visibility are sub-palettes of the Tool palette rather than palettes of their own. SculptForge's Remesh sub-palette is where DynaMesh would be."},{"p":"interface.html","c":"The interface","a":"trays","h":"Trays","t":"The trays are columns at the far left and far right of the window where palettes stay open while you work. The right tray is open by default and holds the Tool palette; the left tray starts closed and empty. Put a palette in a tray: open it from the palette bar and click the tray icon at the left of its header. It goes into the right tray; Shift+click the icon to put it in the left tray. You can also drag the icon onto a tray. Take it out again: click the tray icon in its header inside the tray. The palette returns to the bar. Collapse it in place: click its title (or the arrow at the right of the header). Find it: a palette that is in a tray shows its name in orange in the palette bar. Clicking the name scrolls the tray to the palette and flashes its header. Open or close a tray: click its divider, the thin strip with a grip between the tray and the shelves. Drag the divider to make the tray wider or narrower (240 to 480 pixels). The Stroke palette kept in the right tray above the Tool palette When a tray holds several palettes, 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. 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 mouse wheel."},{"p":"interface.html","c":"The interface","a":"the-shelves","h":"The shelves","t":"Shelves surround the canvas and hold the controls you use all the time. Point at anything with Ctrl held to see what it does. Right-click an item for Remove from shelf; see Customizing the interface to add items."},{"p":"interface.html","c":"The interface","a":"top-shelf","h":"Top shelf","t":"First row: LightBox (,): shows or hides the LightBox. Sculpt / Paint (P): brushes change the shape, or paint colour without sculpting. Zadd / Zsub: brushes add to or subtract from the surface. Holding Alt flips it for one stroke. Rgb: sculpt brushes paint the colour at the same time. Draw Size: the brush radius in screen pixels (2 to 800). Strength: how strongly each dab changes the surface (0.01 to 1), ZBrush's Z Intensity. Second row: AI Brush: opens Brush Lab (see Brush Lab and sharing brushes). Front: front faces only, so brushes leave the far side of thin parts alone. X, Y, Z: symmetry across each axis (X toggles X). Pressure > Strength and Pressure > Size: what pen pressure controls. ActiveTris / TotalTris at the right: the triangles you can see and sculpt (visible SubTools, hidden parts left out) and the total in the scene. Draw Size and Strength are sliders with the label inside, as in ZBrush: drag along them, or Ctrl+click to type a value."},{"p":"interface.html","c":"The interface","a":"left-shelf","h":"Left shelf","t":"Four large tiles, each showing the current choice. Click one to open its pop-up picker: Brush: the active brush, with a rendered preview. Stroke: Dots, DragRect, Spray or LazyMouse. Alpha: the brush's stamp shape. Material: how the model is shaded in the view. Under them is the colour picker for polypaint (a saturation/value square and a hue strip), two swatches (the main and second colour; click either to swap them, like ZBrush's Alternate) and Fill, which fills the unmasked area with the main colour."},{"p":"interface.html","c":"The interface","a":"right-shelf","h":"Right shelf","t":"Frame (F): fits the model in the view. Move, Zoom, Rotate: drag on these buttons to pan, zoom and orbit the view, as in ZBrush. PolyF (W): shows the mesh's triangles. Groups: colours each polygroup. Mask: darkens masked areas (on by default). Paint: shows polypaint colours (on by default). Solo: shows only the active SubTool (available with two or more SubTools). Splats: shows or hides a Gaussian splat capture (only shown while one is loaded). Toggles that are on have an orange background. See Navigating the view for the camera."},{"p":"interface.html","c":"The interface","a":"bottom-shelf","h":"Bottom shelf","t":"A row of quick brushes: Standard, Clay, ClayBuildup, DamStandard, Move, Smooth, Inflate, Pinch, Flatten, Crease, Trim, SnakeHook, Layer, Nudge and Paint. The small digit in a tile's corner is its shortcut (1 to 9 and 0 select the first ten built-in brushes, P is Paint). The active brush has an orange outline. The bottom shelf of quick brushes Add a brush: click + at the end of the shelf and pick any brush, built-in or one of your own. Or right-click a brush in the brush picker and choose Add to bottom shelf. Custom brushes show a small sparkle in the corner. Remove a brush: right-click its tile and choose Remove from shelf."},{"p":"interface.html","c":"The interface","a":"pop-up-pickers","h":"Pop-up pickers","t":"Pickers are pop-up grids of thumbnails. They open beside the left-shelf tile you click, or under the mouse when you use a key. They close when you pick something, press Esc or click elsewhere. Pointing at a tile for a moment shows Quick Info: a large preview and a description."},{"p":"interface.html","c":"The interface","a":"brush-picker","h":"Brush picker","t":"Press B (or click the Brush tile). The picker shows a Recent row, then Built-in, Custom (your brushes and Brush Lab creations) and Library (.sfbrush files in your library that aren't loaded yet; picking one loads it). The brush picker after pressing B and typing S Choose a brush with the keyboard the ZBrush way: Press B. Type the first letter of the brush. Only the brushes starting with that letter stay, and each shows an orange letter: the next key that tells it apart. Press that orange letter to pick the brush. For example B S T picks Standard. Backspace takes back a letter and Enter picks the first match. If no name starts with what you typed, the picker falls back to names that contain it. The letter chips along the top (with a count for each letter) filter by a click as well. Right-click a brush for Add to bottom shelf and, for custom brushes, Copy brush code, Rename..., Save as .sfbrush..., Delete... and Reveal in folder (see Brush Lab and sharing brushes)."},{"p":"interface.html","c":"The interface","a":"stroke-alpha-and-material-pickers","h":"Stroke, Alpha and Material pickers","t":"Stroke (click the Stroke tile): Dots, DragRect, Spray and LazyMouse, with Scatter for Spray and Lazy radius for LazyMouse. See Sculpting and brushes. Alpha (click the Alpha tile): Round, Square and Noise, the image alpha you loaded, images in your library's Alphas folder, Load image... and Invert loaded image. Material (M, or click the Material tile): Studio and the MatCaps. Point at a material to preview it on the model; click to keep it. Closing the picker without clicking puts the old material back. See Polypaint and materials."},{"p":"interface.html","c":"The interface","a":"draw-size-and-strength-at-the-cursor","h":"Draw Size and Strength at the cursor","t":"Press S for a Draw Size slider under the mouse, or I for Strength. Drag the slider, or type a number and press Enter (Esc cancels). The pop-up closes when you release the slider. For Strength, typing a number above 1 is read as a percentage (50 means 0.50). [ and ] make the brush 10% smaller or larger at any time."},{"p":"interface.html","c":"The interface","a":"the-lightbox","h":"The LightBox","t":"The LightBox is a strip of thumbnails across the top of the canvas for browsing everything you can load. Press , (comma) or click LightBox on the top shelf to show or hide it. It opens on its own at start-up (see Preferences). The LightBox on the Tool tab Tab Shows Double-click Project Projects (.sfproj) in your library and recently opened projects Open the project Tool Sphere, Plane and Cube, and model files in your library Open (replaces the scene) Brush Every brush: built-in, custom and .sfbrush files Select or load the brush Alpha Round, Square, Noise and images in your Alphas folder Use as the brush alpha Material Studio and the MatCaps Use the material Image Reference images in your library A menu: Generate 3D, relief, inflate, project onto the model, use as alpha Splats Gaussian splat captures (.ply, .splat) Open the capture as a reference QuickSave The autosave and your QuickSaves, newest first Open it Recent Recently opened files of every kind Open it Working with the strip: Shift+double-click a model, project or primitive to append it to the scene as a new SubTool instead of replacing the scene. Drag sideways (or use the mouse wheel) to scroll through the strip. A drag of more than a few pixels scrubs, so a plain click still selects. Drag a tile down out of the LightBox onto the canvas to load it, like a double-click. Folders open with a double-click; the first tile inside a folder goes back up. The arrows at the top go back and forward through tabs and folders, and the breadcrumb shows where you are. Type in Filter to show only items whose names contain the text. Choose 1 to 4 rows of thumbnails. Open folder... adds a folder of your own to the root of every tab. On the QuickSave tab, Save now makes a QuickSave. Right-click a tile for Open, Append as SubTool, the image actions, Show in file manager and Refresh thumbnail. 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 > LightBox > Library folder. ZBrush: the LightBox works like ZBrush's: comma toggles it, double-click loads, and Built-in and User folders play the part of ZBrush's Maxon and User folders."},{"p":"interface.html","c":"The interface","a":"ctrl-hover-help","h":"Ctrl-hover help","t":"Hold Ctrl and point at any button, slider, tile or shelf item. A box shows the item's name, its shortcut as keycaps, what it does, where it lives (for example \"Tool > Geometry\") and the script command it runs. Ctrl-hover help on the Subdivide button Hold Ctrl+Alt instead to see the scripting reference for items that run a command: the command's usage line and each parameter with its type and description. This is the same information the console, sculptforge-cli and AI agents use. Without Ctrl, 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 Info (Ctrl+hover help), and make the box more or less see-through with Popup Info opacity."},{"p":"interface.html","c":"The interface","a":"the-controls-sheet","h":"The Controls sheet","t":"Press F1 (or Help > Controls) for the Controls window. The Keyboard tab lists every action that has a shortcut, grouped by palette and generated from the actions themselves, so it always shows your current keys. The Mouse & pen tab lists the gestures. Type in the filter field to search both. Double-click a row on the Keyboard tab to give that action a new key."},{"p":"interface.html","c":"The interface","a":"this-guide","h":"This guide","t":"Help > User Guide (Shift+F1) opens this guide in its own window: the contents on the left (the open chapter lists its sections), the chapter on the right, and links between chapters. The User Guide window on the Masking chapter Search: type in the search box (Ctrl+F) to find every section that mentions all of your words. Click a result to jump there; the words are marked on the page. Esc clears it. Back and forward: the arrow buttons, Alt+Left / Alt+Right, or the back and forward buttons of your mouse. From any control: while Ctrl-hover help is showing, press F1 (keep Ctrl held) to open the chapter about that control. The help box shows which chapter it is (\"Learn more: ...\"). Code blocks have a Copy button, and Open in browser shows the same page on the SculptForge website. The guide is built into SculptForge, so it works offline and always matches your version."},{"p":"interface.html","c":"The interface","a":"the-command-palette","h":"The command palette","t":"Press F3 (or Ctrl+Shift+P, or click Search in the title strip) to find any action or command by name and run it. It opens at the top centre of the canvas. The command palette searching for subdivide Type part of a name, a palette or a word from the description. The search is forgiving: letters in order are enough (\"sbdv\" finds Subdivide), and every word you type must match somewhere. Each row shows the action, its palette and its shortcut. Up and Down (or Page Up and Page Down) choose a row, Enter runs it and Esc closes the palette. With nothing typed, the palette lists the actions you used most recently. Commands with a required parameter (for example image_relief path=) open in the console with the name already typed. Other commands run with their default values; Shift+Enter sends a command with parameters to the console instead, so you can set them first. Everything scriptable is in the command palette, including commands that have no button in the interface."},{"p":"interface.html","c":"The interface","a":"the-console","h":"The console","t":"Press ` (the backtick key, left of 1 on US keyboards) to open the console, a strip between the canvas and the bottom shelf. It works like ZBrush's ZScript window: Every command you run, from a button, a key, the command palette, a script or an AI agent, appears as a script line followed by its result. Errors show in red. Type a command and press Enter: for example remesh resolution=200 or subdivide; decimate ratio=0.5. Tab completes command and parameter names, Up and Down recall earlier lines, and help (or help remesh) explains commands. Drag the console's top edge to make it taller or shorter. The Script palette has Run script file..., Copy session as script (every command you ran this session, ready to replay, which makes it a macro recorder) and Clear console. The console after a few commands See Scripting and automation for the command language, scripts and headless use."},{"p":"interface.html","c":"The interface","a":"customizing-the-interface","h":"Customizing the interface","t":"Everything about the layout can change: which palettes sit in the trays, what's on each shelf, and which keys do what. As in ZBrush, changes last until you quit unless you store them with Store Config."},{"p":"interface.html","c":"The interface","a":"move-add-and-remove-shelf-items","h":"Move, add and remove shelf items","t":"Open 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\". Hold Ctrl+Alt 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 from palettes to a shelf; along its shelf, or to another shelf, to move it; off the shelves (onto the canvas, for example) to remove it. Turn Enable Customize off when you're done, and press Ctrl+Shift+I to keep the result. Right-clicking a shelf item and choosing Remove from shelf works without Customize mode."},{"p":"interface.html","c":"The interface","a":"assign-shortcuts","h":"Assign shortcuts","t":"Hold Ctrl+Alt and click any button (with Customize off), then press the key you want. Esc cancels and Backspace removes the button's shortcut. Or open 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 (F1). If the key already belongs to another action, it moves to the new one (as in ZBrush) and the status line says which action lost it."},{"p":"interface.html","c":"The interface","a":"store-config-and-friends","h":"Store Config and friends","t":"All in Preferences > Config: Item What it does Store Config (Ctrl+Shift+I) Keeps the current layout, shortcuts and interface preferences for future sessions Restore Custom UI Goes back to what the last Store Config saved Restore Standard UI Goes back to the built-in layout and default shortcuts (Store Config afterwards to make it stick) Save UI... Saves the layout, shortcuts and preferences to a .json file you can share Load UI... (Ctrl+L) Loads such a file (Store Config afterwards to keep it) The first time you change the layout in a session, the status line reminds you once: \"Layout changed - Ctrl+Shift+I to keep it\". What a session changes by itself (the console and LightBox being open, the LightBox tab) doesn't count as a layout change. ZBrush: Store Config has the same shortcut as in ZBrush, and SculptForge never saves the layout on its own either."},{"p":"interface.html","c":"The interface","a":"layout-presets","h":"Layout presets","t":"The 1, 2 and 3 buttons in the title strip (also in Preferences > Config) switch between three layouts: Standard: the Tool palette in the right tray and shelves around the canvas. Sculpt: both trays closed, for the largest canvas. Wide: Brush, Stroke and Alpha in the left tray, Tool and Material in the right tray. A preset changes the layout only (the console, LightBox and left-handed setting stay as they are). Store Config keeps it."},{"p":"interface.html","c":"The interface","a":"interface-preferences","h":"Interface preferences","t":"Preferences > Interface: Setting Default What it does Popup Info (Ctrl+hover help) On Ctrl-hover help boxes Popup Info opacity 0.97 How solid the help box is Tooltip delay 0.5 s How long to point at an icon-only button before its name appears One sub-palette open On Opening a sub-palette closes the others in that palette Auto collapse left tray / right tray On / Off Collapse other palettes in the tray when one wouldn't fit Palettes strictly A-Z (ZBrush order) Off Strict alphabetical palette bar instead of File and Edit first, Help last Left-handed layout Off Mirrors the shelves and trays: tools on the right, navigation on the left UI scale Automatic Size of text and controls (100% to 200%); takes effect at the next start Camera notch Automatic Keeps the interface below a laptop's camera notch in fullscreen (see below) Preferences > LightBox 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 QuickSave). The Preferences palette with the Config and Interface sub-palettes"},{"p":"interface.html","c":"The interface","a":"fullscreen-the-palette-bar-and-the-camera-notch","h":"Fullscreen, the palette bar and the camera notch","t":"F11 (or Render > 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. Tab hides the shelves and trays. On MacBooks with a camera notch, SculptForge keeps the interface below the notch when it fills the screen and fills the band beside the notch with the shell colour. Automatic asks macOS for the safe area (on Linux it recognises a notched MacBook display); Always reserve always keeps a band free at the top, whatever the display; Off uses the full height."},{"p":"interface.html","c":"The interface","a":"see-also","h":"See also","t":"Navigating the view Keyboard and mouse Scripting and automation Troubleshooting and FAQ"},{"p":"navigation.html","c":"Navigating the view","a":"","h":"Navigating the view","t":"This chapter explains how to rotate, pan and zoom the camera with a mouse, a pen or the right-shelf buttons, how to frame the model, and which display toggles help while you sculpt."},{"p":"navigation.html","c":"Navigating the view","a":"how-the-camera-works","h":"How the camera works","t":"The camera orbits around a target point, like a turntable: dragging sideways turns the model around its vertical axis and dragging up or down tilts it, stopping just short of looking straight down or up so the view never flips over. Panning moves the target; zooming moves the camera closer to it or further away. The view is a perspective view with a 35 degree field of view. Navigation starts only on the canvas. A drag that begins on a shelf, a tray or a palette never moves the camera. ZBrush: dragging on the background rotates, Alt+drag pans and the right-shelf Move, Zoom and Rotate buttons work as in ZBrush. SculptForge's left-drag zoom uses Ctrl rather than ZBrush's Alt-then-release gesture."},{"p":"navigation.html","c":"Navigating the view","a":"mouse-and-pen","h":"Mouse and pen","t":"To Do this Rotate Left-drag on the background, or right-drag anywhere on the canvas Pan Alt+left-drag on the background, middle-drag, or Shift+right-drag Zoom Mouse wheel, Ctrl+middle-drag, or Ctrl+left-drag on the background Frame the model F, or Frame on the right shelf \"Background\" means any part of the canvas where the cursor isn't over the model. A left-drag that starts on the model sculpts instead, so with a pen or a one-button mouse, start rotations beside the model. When the model fills the view, zoom out a little or use the right-shelf buttons. Note: Ctrl+left-drag on the background clears the mask when something is masked (and Ctrl+click there inverts it); it zooms only while nothing is masked. Use the wheel or Ctrl+middle-drag to zoom on a masked model. See Masking. On macOS, Cmd works wherever this guide says Ctrl for these gestures, except Ctrl+middle-drag, which needs Ctrl itself."},{"p":"navigation.html","c":"Navigating the view","a":"the-right-shelf-navigation-buttons","h":"The right-shelf navigation buttons","t":"The right shelf has three buttons you drag on rather than click, as in ZBrush. They are handy with a pen, on a laptop trackpad, or when the model fills the canvas and there is no background to drag on. The right shelf: Frame, Move, Zoom and Rotate, then the display toggles Button Drag on it to Frame (click) Fit the whole scene in the view (F) Move Pan the view Zoom Zoom: drag up to come closer, down to move away Rotate Orbit the view The button stays orange while you drag. Frame is also in the Render and Transform palettes."},{"p":"navigation.html","c":"Navigating the view","a":"framing","h":"Framing","t":"Frame (F) points the camera at the centre of the scene and moves it back until everything fits: every visible SubTool, plus the Gaussian splats when they are shown. SculptForge frames the scene for you when you open a file or start from a new primitive. Use it after panning far away, or when a model comes in at an unusual scale."},{"p":"navigation.html","c":"Navigating the view","a":"display-toggles-that-help-navigation","h":"Display toggles that help navigation","t":"These live on the right shelf and in the Render palette: PolyF (W or Shift+F): shows the triangles of the active SubTool over the surface, ZBrush's PolyFrame. Useful for judging mesh density before you subdivide or remesh. Groups: colours each polygroup. Mask: darkens masked areas. Paint: shows polypaint colours (off shows the plain material). Solo: shows only the active SubTool, 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. Fullscreen (F11) and hiding the shelves (Tab) give the canvas the most room. See The interface."},{"p":"navigation.html","c":"Navigating the view","a":"not-yet","h":"Not yet","t":"Not yet: SculptForge has no orthographic view, no snapping to front, side or top views, no rotation around the point under the cursor (the camera always orbits its target, which Frame sets to the scene centre), no floor grid and no saved camera views. Pan the target onto the area you're working on to orbit around it."},{"p":"navigation.html","c":"Navigating the view","a":"see-also","h":"See also","t":"The interface Keyboard and mouse Sculpting and brushes"},{"p":"sculpting.html","c":"Sculpting and brushes","a":"","h":"Sculpting and brushes","t":"This chapter covers everything that happens when you drag a brush across a model: the built-in brushes and the custom brushes that ship with SculptForge, brush size and strength, modifier keys, stroke types, alphas, symmetry and pen pressure. To design your own brushes, see Brush Lab and sharing brushes. Sculpting the lion head with X symmetry"},{"p":"sculpting.html","c":"Sculpting and brushes","a":"your-first-stroke","h":"Your first stroke","t":"Pick a brush: click it on the bottom shelf, press its number key, or press B to open the brush picker. Left-drag on the model. The brush works on the surface under the cursor. Hold Alt while dragging to invert the brush (dig in instead of building up), or hold Shift to smooth. Press Ctrl+Z to undo a stroke, Ctrl+Shift+Z (or Ctrl+Y) to redo it. Each SubTool keeps its own history of up to about 1 GB; the oldest steps are dropped beyond that. Dragging on the background never sculpts: it rotates the view (see Navigation). The brush only works on the active SubTool, and only on parts that are visible and not masked. ZBrush: the modifiers are the ones you know. Alt flips Zadd and Zsub for one stroke, Shift smooths with any brush, Ctrl paints a mask (see Masking)."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"built-in-brushes","h":"Built-in brushes","t":"SculptForge has fourteen sculpting brushes plus the Paint brush. The first ten have number keys; all of them are on the bottom shelf by default and in the brush picker. Brush Key What it does With Alt Standard 1 Raises the surface along the stroke, the all-purpose brush. Digs in Clay 2 Builds up clay that fills the hollows first, with a slightly flat top. Carves away Smooth 3 Relaxes the surface, evening out bumps. The same brush Shift gives you. No change Move 4 Grabs the surface under the cursor and pulls it along, parallel to the screen. No change Inflate 5 Swells the surface outward along its normals. Deflates Crease 6 Cuts a sharp crease and pinches its sides in. Raises a ridge Flatten 7 Presses the surface toward a plane through the brush area. Pushes away from the plane Pinch 8 Pulls the surface toward the stroke to tighten edges. Spreads it apart DamStandard 9 A narrow, deep V-shaped crease with the sides pinched in. A sharp ridge ClayBuildup 0 Square, flat-topped clay strokes for blocking in forms. Carves flat-bottomed SnakeHook Pulls the surface out into horns and tendrils that taper as you drag. No change Trim Trim Dynamic: shaves away everything above a plane for hard surfaces. Fills up to the plane Layer Raises the surface to one fixed height per stroke; overlapping passes never stack. Lowers to a fixed depth Nudge Slides the surface sideways along the stroke without lifting it. No change Paint P Paints colour without sculpting. See Polypaint and materials. Paints back to white Notes on particular brushes: Move and SnakeHook move the surface with the cursor instead of placing dabs, so stroke types (Dots, Spray and so on) don't apply to them. Layer sets its height from the brush size and Strength. Pen pressure lowers the height when Pressure > Strength is on, so you can feather the edge of a layer. Trim gives crisp planes on cylinders and edges. Use it with Front on when you work on thin shapes. ZBrush: DamStandard, ClayBuildup, SnakeHook, Trim (Dynamic), Layer and Nudge behave like their ZBrush namesakes. Brushes such as hPolish, ClayTubes, Slash or the IMM and curve brushes are not built in; you can get close to several of them with a custom brush in Brush Lab."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"custom-brushes-that-ship-with-sculptforge","h":"Custom brushes that ship with SculptForge","t":"Besides the built-in brushes, SculptForge ships seven custom brushes. They are recipes: data that you can open and change in Brush Lab. They appear in the Custom section of the brush picker and in Brush > Custom brushes. Brush What it does Wrinkle Fine, sharp creases for skin folds and fabric wrinkles. Palette Knife Flattens and drags clay sideways like a sculptor's knife. Dragon Scales Stamps rounded overlapping scales along the stroke. Stone Chisel Scrapes hard planes and breaks them up with cracks for rocks and ruins. Skin Pores Sprinkles tiny pores for close-up skin detail. Clay Buildup Builds up flat-topped strokes of clay for blocking in forms. Edge Wear Chips and softens only the sharp edges and ridges, for weathered props. Custom brushes respond to Alt, Shift, the mask, symmetry and the stroke settings just like built-in ones. Their thumbnails carry a small sparkle when you put them on the bottom shelf."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"pick-a-brush","h":"Pick a brush","t":"You can choose a brush in several places: Bottom shelf: click a tile. The active brush has an orange outline and the number key is shown in the corner of each tile. Number keys: 1 to 9 and 0 pick the first ten built-in brushes (see the table above); P 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. Command palette (F3): type the brush name and press Enter."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"the-brush-picker","h":"The brush picker","t":"Press B to open the brush picker under the mouse. It shows a Recent row (once you have picked brushes), then Built-in, Custom and Library sections. The Library section lists .sfbrush files in the Brushes folder of your LightBox library that aren't loaded yet; picking one loads it. The brush picker after pressing B, with letter badges The picker works the ZBrush way, by typing letters: Press B. Type the first letter of the brush. Only brushes starting with that letter stay, and each shows an orange key badge: the next letter that tells it apart from the others. Press the letter on the badge to pick that brush. For example B, S, T picks Standard, and with the brushes that ship, B, C, L picks Clay. If no brush name starts with what you typed, the picker falls back to names that contain it. Backspace removes the last letter, Enter picks the first match, and Esc or a click outside closes the picker. The letter chips along the top (A 2, C 4 ...) show how many brushes start with each letter; click one to filter by it. Hover a tile for a large preview and the brush's description. Right-click a tile for Add to bottom shelf, and on custom brushes also Copy brush code, Rename..., Save as .sfbrush..., Delete... and Reveal in folder (see Brush Lab and sharing brushes). ZBrush: B then two letters is the same muscle memory. Holding Ctrl while picking to choose a masking brush is not supported; mask strokes always use Ctrl with the current settings."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"draw-size-and-strength","h":"Draw Size and Strength","t":"Two values control every brush. Both are on the top shelf and in the Draw palette. Setting Range Default How to change it Draw Size 2 to 800 60 Brush radius in screen pixels. [ and ] make it 10% smaller or larger (hold to repeat). S opens a slider at the cursor. Strength 0.01 to 1 0.50 How strongly each dab changes the surface (ZBrush Z Intensity). I opens a slider at the cursor. Because Draw Size is measured on screen, the brush covers less of the model as you zoom in, which is what you want for detail work. The S and I pop-ups take the mouse or the keyboard: drag the slider and release to close it, or type a number and press Enter. For Strength you can type either 0.35 or 35. Esc closes the pop-up without typing anything new. The Draw palette"},{"p":"sculpting.html","c":"Sculpting and brushes","a":"sculpt-paint-zadd-zsub-rgb-and-front","h":"Sculpt, Paint, Zadd, Zsub, Rgb and Front","t":"These toggles sit on the top shelf and in the Draw palette: Control What it does Sculpt / Paint Sculpt makes brushes change the shape. Paint (P) paints colour only. Zadd / Zsub Zadd makes brushes add (the default), Zsub makes them subtract. Alt flips the current choice for one stroke. Rgb Sculpt brushes also paint the current colour as they sculpt (ZBrush Rgb with Zadd). Front Front faces only: brushes leave the far side of thin parts alone, such as the back of an ear or a cape. The Brush palette has the same Front and invert settings as the checkboxes Front faces only and Invert (Alt)."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"modifier-keys-while-sculpting","h":"Modifier keys while sculpting","t":"Hold Effect Alt Inverts the brush for this stroke (see the table of brushes). Shift Smooths with the Smooth brush, whatever brush is active. With the Paint brush active, Shift still smooths the shape. Ctrl Paints a mask instead of sculpting; Ctrl+Alt erases it. See Masking. Ctrl+Shift Visibility gestures: isolate, hide and show polygroups. See Polygroups and visibility. Smoothing uses the current Strength, so lower Strength gives a gentler smooth."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"strokes","h":"Strokes","t":"The stroke type decides how cursor movement becomes brush dabs. Choose it from the Stroke tile on the left shelf, which opens the stroke picker, or from the Stroke palette. The stroke picker Stroke What it does Setting Dots Even dabs along the path: the classic brush stroke (default). None; spacing comes from the brush. DragRect Click and drag one stamp: the drag length sets its size and its direction the rotation. Great with alphas. None Spray Scattered dabs of random size, strength and rotation, for organic texture. Scatter (0 to 2, default 1): how far dabs land from the cursor, as a fraction of the brush size. LazyMouse The brush trails the cursor on a string, for smooth, steady lines. Lazy radius (1 to 300 px, default 40): longer is steadier. The setting slider appears under the stroke tiles when Spray or LazyMouse is selected. With LazyMouse, the viewport draws the string between the cursor and the brush point. Notes: With DragRect, the stamp is placed where you first click. While you drag, it is redrawn at the new size and angle, and it is committed when you release. Mask strokes (Ctrl) always use dots, even when DragRect is selected. Custom brushes set their own dab spacing and can add jitter (see Brush Lab). ZBrush: DragRect, Spray and LazyMouse match ZBrush's DragRect, Spray and LazyMouse. Freehand and Dots are the same thing here. DragDot, Roll and curve strokes are not available yet."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"alphas","h":"Alphas","t":"An alpha is a grayscale stamp that shapes the brush tip: white is full effect, black is none. It affects every brush, built-in or custom. Choose one from the Alpha tile on the left shelf (the alpha picker) or the Alpha palette, which also shows a large preview of the current alpha. The alpha picker Alpha What it does Round The plain round falloff (no alpha). The default. Square A square stamp with soft edges. Noise A noisy stamp for rough, organic texture. To use your own image: Click Load image... in the alpha picker or the Alpha palette. Choose a PNG, JPG, BMP, TGA, PSD or GIF. Colour images are converted to grayscale. Turn on Invert loaded image before loading if your image is white where it should have no effect. Images you keep in the Alphas folder of your LightBox library (Documents/SculptForge/Alphas by default) appear in the picker's Images section, so you can switch between them with one click. The alpha's top edge points up the screen; with DragRect it follows the drag direction instead. From a script: brush_set_alpha name=square, or brush_set_alpha path=bark.png invert=true. ZBrush: there is no alpha library browser with hundreds of alphas yet, and alpha options such as MidValue, Rf (radial fade) or tiling are not available. Any grayscale image works, including alphas you already have as PNG."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"symmetry","h":"Symmetry","t":"Symmetry mirrors every stroke, including mask and paint strokes. X mirrors left and right. It is on by default; press X to toggle it. Y mirrors top and bottom, and Z mirrors front and back. They have no default key (you can assign one; see The interface). The X, Y and Z buttons are on the top shelf and in the Transform palette. You can combine them: X and Z together give four-way symmetry. Symmetry mirrors across the scene's axes through the origin. Models that are centred on the origin, such as SculptForge's primitives and most character exports, mirror correctly. If a stroke lands in the wrong place on the other side, the model is off-centre. ZBrush: this is ZBrush's world symmetry with the >X< axis on. Local symmetry, radial symmetry and topological (poseable) symmetry are not available yet."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"pen-pressure-and-tablets","h":"Pen pressure and tablets","t":"SculptForge reads pen pressure from graphics tablets and pen displays through the operating system. When it 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: Toggle Default Effect Pressure > Strength On Pen pressure scales the brush strength. Pressure > Size Off Pen pressure scales the brush size (down to 5% at the lightest touch). Pressure applies only to strokes made with the pen; mouse strokes always use full pressure. Custom brushes also have a Pressure curve setting that makes them respond to a light or a firm touch (see Brush Lab). If the pen moves the cursor but pressure does nothing, see Troubleshooting. 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 Alt) and the side buttons (default: lower button right-click to rotate the view, upper button Invert, third button Pan view). Store Config (Ctrl+Shift+I) keeps these settings. Setup notes for Windows Ink, macOS and Linux are in docs/tablet.md."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"customize-the-bottom-shelf","h":"Customize the bottom shelf","t":"The bottom shelf holds your most-used brushes. By default it shows Standard, Clay, ClayBuildup, DamStandard, Move, Smooth, Inflate, Pinch, Flatten, Crease, Trim, SnakeHook, Layer, Nudge and Paint. The bottom shelf 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 Ctrl+Alt+drag a tile to a new place. Change a brush's key: Ctrl+Alt+click its tile, then press the new key. Shelf changes last until you quit. Press Ctrl+Shift+I (Store Config) to keep them. See The interface for more on customizing."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"sculpt-from-a-script","h":"Sculpt from a script","t":"The stroke command applies a brush along a path on the active SubTool, as one undo step. It is useful for scripted detailing and for AI agents: sculptforge-cli -c 'new_sphere subdivisions=6; stroke brush=Crease points=\"-0.6,0.2,0 0,0.4,0 0.6,0.2,0\" symmetry=x; export_glb path=out.glb' Points are projected onto the surface along view (default 0,0,-1, the front view). radius (world units), strength, pressure, invert, spacing, curve and seed work as in the viewport. See Scripting and automation."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"see-also","h":"See also","t":"Brush Lab and sharing brushes: design brushes with AI, the brush library and brush codes Masking: protect areas from every brush Polypaint and materials: Paint brush, Rgb and colour Sculpt layers and blend shapes: sculpt into a layer you can dial in and out Keyboard and mouse reference"},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"","h":"Brush Lab and sharing brushes","t":"Brush Lab designs sculpting brushes from a description: type \"dry cracked mud\" and an AI model builds the brush, then you refine it in words or with sliders. This chapter covers Brush Lab, the AI providers it can use, the recipe settings, your brush library, and the ways to share brushes: .sfbrush files, one-line brush codes, studio folders and the community gallery. Brush Lab with a brush designed from a description"},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"what-a-custom-brush-is","h":"What a custom brush is","t":"A custom brush is a recipe: about twenty named values that describe how the brush moves the surface, the shape of its tip, a surface pattern, stroke spacing and masking. A recipe is data, never code, so brushes are safe to download and share. The AI only fills in these values; you can see and change every one of them. Custom brushes work everywhere built-in brushes do: on the bottom shelf, in the brush picker (B), with Alt, Shift, masks, symmetry, strokes and alphas."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"open-brush-lab","h":"Open Brush Lab","t":"Click AI Brush on the top shelf, or AI Brush at the top of the Brush palette. Brush Lab is a floating window; it opens at the top-left corner of the canvas the first time, and you can drag it anywhere. Click the button again, or the window's close box, to hide it."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"design-a-brush","h":"Design a brush","t":"Open Brush Lab. Type a description in the field at the bottom, the way you'd describe the brush to another sculptor, for example bark of an old oak tree or soft folds in heavy cloth. Or click one of the starter ideas, such as Overlapping dragon scales or Dry cracked mud. Press Enter or click Create. While the model works, the conversation shows \"Designing brush\". When the brush is ready, it becomes the active brush and the status bar says so. Try it on the model. The model replies with the brush name in brackets and a sentence on what the brush does and what to try next. Errors (no connection, rate limits, a model that didn't return a recipe) appear in red in the same conversation."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"refine-a-brush-in-words","h":"Refine a brush in words","t":"With Refine the selected brush ticked, your next message changes the active custom brush instead of creating a new one: \"sharper\", \"less buildup\", \"make the scales smaller\". The model sees the current recipe and your conversation so far. Clear chat starts a new conversation."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"tune-a-brush-with-sliders","h":"Tune a brush with sliders","t":"Open the Recipe section of Brush Lab to see every value of the active custom brush. The same editor appears in the Brush palette as Edit recipe: NAME when a custom brush is active. Hover a slider for a description. Setting Range What it does Direction normal, inflate, view, stroke Which way the surface moves: out of the surface, outward in every direction, toward the camera, or along the stroke. Depth -1 to 1 Adds material (positive) or carves it away (negative). Plane none, clay, flatten, fill, scrape Planar behaviour: flat-topped clay layers, levelling, raising only low spots, or cutting only high spots. Plane amount 0 to 1 Strength of the plane behaviour. Pinch -1 to 1 Pulls the surface toward the stroke for crisp creases (negative spreads it apart). Drag 0 to 1 Smears the surface along the stroke, like a palette knife. Auto smooth 0 to 1 Relaxes the surface after each dab for softer, cleaner results. Hardness 0 to 1 Soft airbrush edge (0) to hard-edged stamp (1). Tip sharpness 0 to 1 Round, broad tip (0) to a narrow needle point (1). Pattern none, noise, scales, ridges, pores, cracks A surface texture stamped by the brush. Pattern size 0.03 to 2 Size of the pattern relative to the brush size. Pattern amount 0 to 1 How strongly the pattern shows. Spacing 0.02 to 2 Distance between dabs, relative to the brush size. Jitter 0 to 1 Random scatter of dabs around the stroke. Pressure curve 0.3 to 3 Tablet response: above 1 needs a firmer press, below 1 responds to a light touch. Front faces only on / off Only affects surfaces facing the camera, protecting thin parts. Cavity mask -1 to 1 Positive: only cavities. Negative: only ridges and peaks (as Edge Wear does). The name field at the top of the editor renames the brush when you press Enter. Tip: to adapt a built-in recipe such as Dragon Scales, select it and move the sliders. Your version is saved to your library and replaces the built-in one; delete it to get the original back."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"choose-an-ai-provider","h":"Choose an AI provider","t":"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. Provider What you need Notes Free - no account or key (default) Nothing An open model (GPT-OSS 20B) hosted by Pollinations.ai. Only your description and settings are sent. Rate limited to about one request every few seconds. If it can't be reached, a running local Ollama is used instead. Anthropic (Claude) - your key An Anthropic API key Uses claude-opus-5-5 by default. Effort (low, medium, high) trades speed for more considered brushes. OpenAI-compatible (OpenAI, Ollama, LM Studio...) An endpoint, a model name and, for hosted services, a key Any server that speaks the OpenAI chat completions API, including local models. For Anthropic and OpenAI-compatible providers you can edit the Endpoint, Model and API key fields. Leave the key empty to use the ANTHROPIC_API_KEY or OPENAI_API_KEY environment variable. Click Save settings to keep your choice; settings and keys are stored only on your computer, in ai.json in the SculptForge settings folder (readable only by you). Requests go only to the endpoint you set."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"run-a-model-on-your-own-computer","h":"Run a model on your own computer","t":"For private, offline use with no rate limits, run a local model with Ollama or LM Studio: Install Ollama and download the recommended model: ollama pull qwen3:4b-instruct (2.5 GB, works without a graphics card). In AI provider, choose OpenAI-compatible (OpenAI, Ollama, LM Studio...). Click Ollama (or LM Studio) to fill in the local endpoint. Click Find models. SculptForge checks the connection, shows \"Connected\" with the number of installed models, and lets you pick one from the Model list. Click Save settings. The Run a model on this computer section in the panel shows the install steps for your operating system. The model needs about 4 GB of free memory; expect 10-20 seconds per brush on a laptop CPU and a few seconds with a GPU. The full walkthrough for Windows, macOS, Linux and LM Studio is in docs/local-ai.md."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"your-brush-library","h":"Your brush library","t":"Every brush you create or refine in Brush Lab is saved to your brush library automatically, a moment after your last change (slider edits save when you release the slider). The library loads at every start, in the app, in sculptforge-cli and in the Python module, so your brushes are always there. The library is a folder of .sfbrush files in the SculptForge settings folder: System Brush library Linux ~/.local/share/SculptForge/SculptForge/brushes 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"},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"the-custom-brushes-list","h":"The Custom brushes list","t":"The Brush palette lists every custom brush under Custom brushes. A small tag after a name says where the brush comes from when it isn't simply yours or built in: Tag Meaning (none) A built-in brush, or a brush in your library yours Your version, which replaces a built-in or studio brush of the same name studio From a shared studio folder (read-only) gallery Installed from the community gallery (kept in your library) project Came with the open project and isn't in your library unsaved Made this session (for example picked from the picker's Library section, or loaded by a script) and not in your library Hover a brush for its description, origin and file. Right-click it for: Copy brush code: one line of text to share (see below). Save .sfbrush...: write the brush to a file. Rename...: rename it. Renaming a built-in or studio brush saves a renamed copy and keeps the original. Delete...: remove it from your library, after a confirmation. Only brushes in your own library can be deleted. If your brush replaced a built-in or studio brush, that one is used again. Reveal in folder: open the folder that holds its file. The same menu is available when you right-click a custom brush in the brush picker. When brushes share a name, your library wins over studio folders, and studio folders win over built-in brushes."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"brush-codes","h":"Brush codes","t":"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 brush code. Paste: copy a code, then press Ctrl+V over the viewport, click Paste brush in Brush Lab, or choose Edit > Paste brush. The brush is installed in your library and becomes active. Pasting also accepts the text of a .sfbrush file. Codes are validated like files: values outside their range are clamped, and anything that isn't a recipe is refused."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"brush-files-sfbrush","h":"Brush files (.sfbrush)","t":"A .sfbrush file is a small JSON file holding one recipe. Save: right-click the brush and choose Save .sfbrush..., or click Save .sfbrush... under the recipe sliders. Install: click Install .sfbrush... under the recipe sliders, or drop the file onto the SculptForge window. The brush goes into your library. Library folder: .sfbrush files in the Brushes folder of your LightBox library (Documents/SculptForge by default) appear in the Library section of the brush picker and in LightBox's Brush tab. Picking one loads it for the session. The file format and every key are documented in docs/brushes.md."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"studio-brush-folders","h":"Studio brush folders","t":"A studio can share brushes read-only from network folders. Set the environment variable SCULPTFORGE_BRUSH_PATH to one or more folders (separated by : on Linux and macOS, ; on Windows). Every .sfbrush file in them loads at start-up, tagged studio. Artists can't change or delete studio brushes; if they edit one, their own version is saved in their library under the same name. The Rez package adds the folder in SCULPTFORGE_STUDIO_BRUSHES to this path. See For studios. Projects (.sfproj) also store the brushes they use, so a scene opens with its brushes on any machine."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"the-community-gallery","h":"The community gallery","t":"The community gallery is a public collection of free (CC0) brushes shared by other sculptors. Click Community brushes at the top of the Brush palette. Search by name or description (scales, skin, stone...), or pick a tag from the All tags list. Click Install under a brush. It is downloaded, checked against its SHA-256 checksum, installed in your library and made active. Installed brushes show Installed. The Community brushes window The gallery is cached, so the window still opens offline (with a notice) showing the brushes from your last visit. Refresh fetches the latest list. Share yours opens the gallery's page on GitHub, where you can submit a brush you saved as .sfbrush with a pull request. You can also browse the gallery on the website at islandmed.github.io/SculptForge/brushes.html. Studios can mirror the gallery or run their own. Enter a URL or folder in the Gallery field at the bottom of the window and click Use, or set SCULPTFORGE_BRUSH_GALLERY (which then takes precedence and hides the field). See docs/brushes.md for the gallery format."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"brushes-from-scripts","h":"Brushes from scripts","t":"Every brush operation is also a command, for sculptforge-cli, the console, Python and AI agents: Command What it does brush_ai prompt=... Design a brush from a description (optional provider, endpoint, model). brush_create name=... depth=... Create or update a brush from recipe values. brush_list / brush_library List custom brushes (with their source and file, and the library folders). brush_save path=... Save a brush as .sfbrush (name defaults to the active brush). brush_load path=... Load a .sfbrush file for this session only. brush_install path=... / code=... / json=... Install a brush into your library and make it active. brush_code Print a brush as a brush code. brush_rename to=... / brush_delete name=... Rename or delete a brush. brush_gallery_search / brush_gallery_install name=... Search and install from the community gallery. # Design a brush for free and save it for the team sculptforge-cli -c 'brush_ai prompt=\"weathered stone edges\"; brush_save path=stone.sfbrush' # Install a gallery brush and try it on a sphere sculptforge-cli -c 'brush_gallery_install name=\"Snake Scales\"; new_sphere subdivisions=6; stroke points=\"-0.5,0,0 0.5,0.2,0\"' See Scripting and automation for running commands."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"see-also","h":"See also","t":"Sculpting and brushes: built-in brushes, strokes, alphas and pressure For studios: shared brush folders and pipelines Troubleshooting: AI provider errors and rate limits"},{"p":"masking.html","c":"Masking","a":"","h":"Masking","t":"A mask protects part of the model from change. Masked areas are drawn darker, and every brush, the Paint brush and colour fills leave them alone. This chapter covers painting masks with Ctrl, the background gestures, and the Tool > Masking controls for inverting, blurring, growing and building masks from cavities or polygroups. A mask painted on the lion's mane, with the Masking sub-palette"},{"p":"masking.html","c":"Masking","a":"how-masks-work","h":"How masks work","t":"A mask is a value per vertex from 0 (free) to 1 (fully masked). Values in between give partial protection, so a soft mask edge blends sculpting into the protected area. Masks belong to a SubTool: each SubTool has its own mask. Masks are saved in projects (.sfproj) and in .GoZ files, so they survive a round trip to ZBrush. Masking is not a layer and isn't affected by sculpt layers: a mask stroke always works on the model itself. Mask strokes and mask commands are undoable like any other change. To see the mask, keep Mask on in the right shelf (it is on by default). The same toggle is Show mask in Tool > Masking, and Show Mask in the Render palette. Turning it off hides the darkening; the mask still protects the surface."},{"p":"masking.html","c":"Masking","a":"paint-a-mask","h":"Paint a mask","t":"Hold Ctrl and drag on the model. The area under the brush becomes masked. Hold Ctrl+Alt and drag to erase the mask. Mask strokes use the current Draw Size, symmetry and, with a pen, pressure (when Pressure > Strength is on). How much each stroke masks is set by Mask Strength in Tool > Masking (0.01 to 1, default 1): lower values build up a soft, partial mask over several strokes. Mask strokes always use a round tip, whatever alpha you have selected, and a DragRect stroke masks with dabs along the path instead of one stamp. On macOS, Cmd works wherever this guide says Ctrl. ZBrush: this is ZBrush's Ctrl-masking with the MaskPen behaviour. Selecting a different masking brush (MaskLasso, MaskRect, MaskCurve) is not available yet."},{"p":"masking.html","c":"Masking","a":"background-gestures","h":"Background gestures","t":"With Ctrl held, clicks and drags on the empty background act on the whole mask: Gesture Effect Ctrl + click the background Invert the mask Ctrl + drag on the background Clear the mask Ctrl + drag on the background, with nothing masked Zoom the view A drag starts after the cursor moves a few pixels, so a slightly shaky click still inverts."},{"p":"masking.html","c":"Masking","a":"the-masking-sub-palette","h":"The Masking sub-palette","t":"Open Tool > Masking (the Tool palette is in the right tray by default). Every button is one undo step. Control What it does Command Show mask Darken masked areas in the viewport. Mask Strength How much each mask stroke masks (0.01 to 1), and the mask value By cavity gives the deepest cavities. Clear Unmask everything. mask_clear Invert Masked becomes free and free becomes masked. mask_invert All Mask every visible vertex. mask_all Blur Soften the mask edges by averaging with neighbouring vertices. mask_blur Sharpen Tighten soft edges, pushing values toward fully masked or free. mask_sharpen Grow Expand the masked region by one ring of edges per pass. mask_grow Shrink Contract the masked region by one ring of edges per pass. mask_shrink passes How many times Blur, Sharpen, Grow and Shrink run (1 to 20 here, default 1). iterations= By cavity Mask concave areas (creases, folds, pores), replacing the current mask. mask_by_cavity threshold How concave a spot must be for By cavity (-0.2 to 0.5, default 0.02). 0 masks anything concave; higher values keep only deep creases. threshold= By polygroup Mask one polygroup, replacing the current mask. The number field next to it is the polygroup id. mask_by_polygroup Mask operations only change visible parts of the model; hidden parts keep their mask. Clear is the exception and frees everything."},{"p":"masking.html","c":"Masking","a":"protect-detail-while-smoothing","h":"Protect detail while smoothing","t":"Click By cavity to mask the creases and pores. Smooth with Shift. The cavities keep their sharpness while the surface between them relaxes. Ctrl + drag on the background to clear the mask when you're done. Raise threshold if too much is masked; lower Mask Strength for partial protection."},{"p":"masking.html","c":"Masking","a":"sculpt-one-part-only","h":"Sculpt one part only","t":"Paint a mask over the part you want to work on with Ctrl. Ctrl + click the background to invert it. Now everything except that part is protected. Sculpt freely; strokes that cross the edge stop at the mask."},{"p":"masking.html","c":"Masking","a":"mask-a-whole-polygroup","h":"Mask a whole polygroup","t":"The quickest way works without knowing the group's number: Ctrl+Shift + click the group to isolate it (see Polygroups and visibility). Click All: only visible vertices are masked. Ctrl+Shift + click the background to show everything again. The mask stays. By polygroup masks a group by its id. The viewport doesn't show ids, but the console does: isolate the group, then open the console (`) and read the isolate_polygroup group=N line. Enter that number in the field next to By polygroup and click it."},{"p":"masking.html","c":"Masking","a":"a-soft-edged-mask","h":"A soft-edged mask","t":"Paint the mask, then click Blur a few times (or set passes to 3-5 first). Sharpen does the opposite."},{"p":"masking.html","c":"Masking","a":"turn-a-mask-into-a-polygroup","h":"Turn a mask into a polygroup","t":"Click From mask in Tool > Polygroups: the masked triangles become a new polygroup. See Polygroups and visibility."},{"p":"masking.html","c":"Masking","a":"masks-and-painting","h":"Masks and painting","t":"Polypaint respects the mask too: the Paint brush, Rgb strokes and Fill leave masked areas alone, so you can mask an area and fill the rest with a colour. See Polypaint and materials."},{"p":"masking.html","c":"Masking","a":"masking-from-a-script","h":"Masking from a script","t":"Command Options mask_clear, mask_all, mask_invert mask_blur, mask_sharpen, mask_grow, mask_shrink iterations (1-100, default 1) mask_by_cavity strength (0-1, default 1), threshold (-1 to 1, default 0.02) mask_by_polygroup group (required), add=true to add to the current mask instead of replacing it sculptforge-cli -c 'open path=head.obj; mask_by_cavity threshold=0.05; mask_blur iterations=2; save_project path=head.sfproj' Not yet: masking by topology, by normals or by alpha, Mask By Smoothness, and lasso, rectangle or curve mask selections are not available yet."},{"p":"masking.html","c":"Masking","a":"see-also","h":"See also","t":"Polygroups and visibility: groups, isolating and hiding parts Sculpting and brushes: modifier keys and brush settings Polypaint and materials: fills that respect the mask"},{"p":"polygroups.html","c":"Polygroups and visibility","a":"","h":"Polygroups and visibility","t":"Polygroups divide a SubTool's surface into named regions, shown as flat colours when you turn them on. You use them to hide and isolate parts of a model so you can reach what you want to sculpt, to build masks, and to split a model into SubTools. This chapter covers creating polygroups, the Ctrl+Shift visibility gestures and the Tool > Polygroups and Tool > Visibility controls. Polygroups shown as colours, with the Polygroups sub-palette"},{"p":"polygroups.html","c":"Polygroups and visibility","a":"show-polygroups","h":"Show polygroups","t":"Click Groups in the right shelf to colour each polygroup of the active SubTool. The same toggle is Show polygroups in Tool > Polygroups and Show Polygroups in the Render palette. The grouping buttons turn the colours on for you, so you see the result straight away. The number next to Show polygroups is how many polygroups are visible right now. A mesh without polygroups is one group. Polygroups come from: the grouping buttons below; OBJ files: each g group becomes a polygroup, as ZBrush writes them (SculptForge also writes polygroups as g groups when it exports OBJ); .GoZ files from ZBrush and SculptForge projects, which keep polygroups."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"create-polygroups","h":"Create polygroups","t":"Open Tool > Polygroups. Grouping works on the visible part of the SubTool only; hidden parts keep their groups. So you can isolate one part and regroup just that part. Control What it does Command By normals A new group wherever the surface turns more than the angle next to it (1 to 90 degrees, default 30). Each flat side of a box becomes its own group. polygroup_auto_by_normals By pieces One group per disconnected piece, such as separate eyes or buttons in one mesh. polygroup_by_connectivity From mask Masked triangles move into a new group. polygroup_from_mask Merge visible Everything visible becomes one group. polygroup_merge_visible Clear groups Remove all polygroups; the whole SubTool becomes one group again. polygroup_clear Each button is one undo step. ZBrush: By normals is Auto Groups / Groups By Normals, By pieces is Auto Groups on a mesh with separate parts, From mask is Group Masked (Ctrl+W in ZBrush; it has no shortcut here, but you can assign one), and Merge visible is Group Visible."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"group-a-region-you-painted","h":"Group a region you painted","t":"Paint a mask over the region with Ctrl (see Masking). Click From mask in Tool > Polygroups. Ctrl + drag on the background to clear the mask."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"hide-and-show-parts","h":"Hide and show parts","t":"Visibility is the main reason to have polygroups: hide what is in the way, sculpt what's left, then show everything again. Hidden parts can't be sculpted, painted or masked, so hiding also protects them. All of the gestures use Ctrl+Shift in the viewport (Cmd+Shift on macOS): Gesture Effect Ctrl+Shift + click a polygroup Isolate it: show only that group. Ctrl+Shift + click the isolated group again Invert the visibility: show everything else instead. Ctrl+Shift+Alt + click a polygroup Hide that group. Ctrl+Shift + click the background Show everything. Ctrl+Shift + drag a rectangle Keep what's inside the rectangle, hide the rest. The rectangle is drawn green. Ctrl+Shift+Alt + drag a rectangle Hide what's inside the rectangle. The rectangle is drawn red. The rectangle works in screen space: a triangle counts as inside when its centre falls inside the rectangle as you see it, including triangles on the far side of the model. You can press or release Alt while dragging; what counts is whether it is held when you let go. SculptForge refuses a change that would hide everything, as ZBrush does. Every visibility change is one undo step, so Ctrl+Z brings back what you just hid. ZBrush: the gestures are the same as ZBrush's SelectRect with polygroups. SelectLasso, Grow and Shrink visibility and hiding by clicking with the rectangle brush are not available yet."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"the-visibility-sub-palette","h":"The Visibility sub-palette","t":"Open Tool > Visibility: Control What it does Command Show all Show every hidden part again. Available when something is hidden. show_all Invert visible Hide what is visible and show what is hidden. invert_visibility Delete hidden Permanently remove the hidden triangles from the mesh. Undoable. delete_hidden Delete hidden keeps every attribute of what remains (mask, polypaint, polygroups, UVs and sculpt layers). Use it to cut away parts of a scan or a generated model, or to remove the inside of a mesh after you isolated the outside."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"work-on-one-part-of-a-character","h":"Work on one part of a character","t":"Click By pieces (for a mesh made of separate parts) or By normals. Ctrl+Shift + click the part you want, for example the head. Sculpt. The rest of the body is hidden and can't be touched. Ctrl+Shift + click the background to show everything."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"clean-up-a-scan-or-a-generated-model","h":"Clean up a scan or a generated model","t":"Turn the model so the unwanted piece is on screen. Ctrl+Shift+Alt + drag a rectangle over it to hide it. Click Delete hidden in Tool > Visibility."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"split-a-model-into-subtools","h":"Split a model into SubTools","t":"Group the model, then click Split groups in Tool > SubTool: each polygroup becomes its own SubTool. Split parts does the same by disconnected piece. See SubTools."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"polygroups-and-other-tools","h":"Polygroups and other tools","t":"Masking: By polygroup in Tool > Masking masks one group (see Masking). Brushes and polypaint skip hidden faces. Projects save polygroups and what's hidden; GoZ and OBJ carry polygroups to and from ZBrush. Each SubTool has its own polygroups and visibility. To show and hide whole SubTools, use the eye icons and Solo in Tool > SubTool."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"polygroups-from-a-script","h":"Polygroups from a script","t":"Command Options polygroup_auto_by_normals angle (1-180 degrees, default 30) polygroup_by_connectivity, polygroup_from_mask, polygroup_merge_visible, polygroup_clear isolate_polygroup, hide_polygroup group (required): the polygroup id show_all, invert_visibility, delete_hidden hide_rect x0 y0 x1 y1 (-1 to 1, y up), inside, optional view_proj matrix; without a view the rectangle spans the mesh seen from the front When you isolate or hide a group in the viewport, the console (`) shows the command with the group's id, for example isolate_polygroup group=3, which you can reuse in scripts. sculptforge-cli -c 'open path=robot.obj; polygroup_by_connectivity; subtool_split_groups; save_project path=robot.sfproj' Not yet: a polygroup paint brush, Group Front, polygroups from UV islands or PolyPaint, and polygroup-based crease edges are not available yet."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"see-also","h":"See also","t":"Masking: build masks from polygroups and polygroups from masks SubTools: split by groups, show, hide and solo whole SubTools Keyboard and mouse reference"},{"p":"subtools.html","c":"SubTools","a":"","h":"SubTools","t":"A scene in SculptForge can hold several separate meshes, called SubTools, just as in ZBrush: a body, eyes, teeth, a helmet and a sword can each live in their own SubTool. This chapter covers the SubTool list, selecting, adding, hiding, reordering, merging and splitting SubTools, and how they travel through files."},{"p":"subtools.html","c":"SubTools","a":"how-subtools-work","h":"How SubTools work","t":"Only the active SubTool is sculpted, painted, masked or changed by a command. The others are drawn slightly darker and greyer so you can see which one you are working on. Each SubTool keeps its own mesh, mask, polypaint, polygroups, hidden faces, UVs and sculpt layers. Each SubTool has its own undo history. Ctrl+Z undoes the last change in the active SubTool, and switching SubTools doesn't lose the history of the others. Adding, deleting, reordering, merging and splitting SubTools are not undoable, as in ZBrush. Merges and deletes ask for confirmation first. The title strip shows the active SubTool and its place in the list, for example SubTool Helmet (2/5). ZBrush: SubTools work the way you expect: one active SubTool, the rest dimmed, Alt+click in the viewport to switch. There is no folder grouping of SubTools yet."},{"p":"subtools.html","c":"SubTools","a":"the-subtool-list","h":"The SubTool list","t":"The list is in Tool > SubTool, which is open in the right tray by default. The SubTool sub-palette with several SubTools, the active one highlighted Each row shows the SubTool's name, its triangle count and an eye. To Do this Select a SubTool Click its row, or Alt+click it in the viewport Rename it Double-click the row (or right-click > Rename), type, press Enter Hide or show it Click the eye at the end of the row Duplicate or delete it Right-click the row > Duplicate or Delete... See its vertex and triangle counts Point at the row for a moment The list shows six rows and scrolls when there are more. Names are kept unique: renaming a SubTool to a name that is already taken adds a number. Selecting a hidden SubTool shows it again, because you can't sculpt what you can't see."},{"p":"subtools.html","c":"SubTools","a":"select-a-subtool-in-the-viewport","h":"Select a SubTool in the viewport","t":"Hold Alt and click another SubTool on the canvas. It becomes the active one and the list scrolls to it. Alt+click only selects when you click a SubTool other than the active one and release without moving. If you drag instead, Alt keeps its usual meaning: an inverted stroke on the active SubTool, or a pan when you start off the model."},{"p":"subtools.html","c":"SubTools","a":"add-a-subtool","h":"Add a SubTool","t":"Click Append and choose: Sphere, Cube or Plane: a new primitive placed beside the visible model (to the right, on +X), sized to about a third of the largest visible SubTool. From file...: a model (.obj, .fbx, .glb, .gltf, .ply, .stl, .GoZ, .usda, .usd, .usdz) or a project (.sfproj). A file with several objects adds one SubTool per object. The new SubTool becomes the active one. You can also add files as SubTools from elsewhere: Import in the Tool palette header (or File > Import) adds a model file as a new SubTool. In the LightBox Tool tab, Shift+double-click a model, or right-click it and choose Append as SubTool. Tip: Duplicate copies the active SubTool with its layers and attributes, names it copy and puts it right under the original. Use it to keep a safe copy before a destructive step such as a remesh."},{"p":"subtools.html","c":"SubTools","a":"show-hide-and-solo","h":"Show, hide and solo","t":"The eye on each row shows or hides that SubTool. Solo shows only the active SubTool. Click it again to bring the others back. The Solo button on the right shelf does the same. Unhide all shows every SubTool. Hidden SubTools aren't drawn, can't be selected with Alt+click, and are left out of exports. Note: SubTool visibility is different from hiding part of a mesh with polygroups or a rectangle. That hides faces inside one SubTool; see Polygroups and visibility."},{"p":"subtools.html","c":"SubTools","a":"reorder-subtools","h":"Reorder SubTools","t":"The up and down arrow buttons under the list move the active SubTool one place up or down. The order matters for Merge down and is the order objects are written to files."},{"p":"subtools.html","c":"SubTools","a":"merge-subtools","h":"Merge SubTools","t":"Merge down... merges the active SubTool with the one below it. Merge visible... merges every visible SubTool into one new SubTool called Merged. Hidden SubTools stay as they are. Merging keeps every attribute, gives each original mesh its own polygroups (so you can split them again later) and matches sculpt layers by name. The merged SubTool starts with an empty undo history. Tip: Merge first when you want one voxel remesh to fuse several pieces into a single watertight surface."},{"p":"subtools.html","c":"SubTools","a":"split-a-subtool","h":"Split a SubTool","t":"Split groups makes one SubTool per polygroup. It is available when the active SubTool has more than one polygroup. Split parts makes one SubTool per disconnected piece, largest first. Both replace the active SubTool with the pieces. Because a merge keeps each original mesh in its own polygroup, Split groups undoes a merge."},{"p":"subtools.html","c":"SubTools","a":"delete-a-subtool","h":"Delete a SubTool","t":"Click Delete... (or right-click a row > Delete...) and confirm. The last SubTool can't be deleted, and a delete can't be undone."},{"p":"subtools.html","c":"SubTools","a":"subtools-in-files","h":"SubTools in files","t":"Format What happens to SubTools Project (.sfproj) Every SubTool is saved with its name, visibility, attributes, layers and active layer OBJ Each visible SubTool is an o object; on import, o objects become SubTools and g groups become polygroups glTF / GLB One node and mesh per visible SubTool, both ways FBX One model per visible SubTool (with LODs, an LOD group each), both ways USD One Mesh prim per visible SubTool, both ways GoZ Each visible SubTool is sent to ZBrush as its own SubTool PLY, STL, splat conversion The visible SubTools are merged into one mesh Opening a multi-object file replaces the scene with one SubTool per object. See Exporting for the details of each format."},{"p":"subtools.html","c":"SubTools","a":"scripting","h":"Scripting","t":"Every SubTool action is a command, so you can use them in the console, scripts, Python and MCP agents. SubTools are addressed by index (0 is the top of the list) or name; without either, the active one is used. Command What it does subtool_list List the SubTools subtool_select index=1 Make a SubTool active subtool_append type=cube Add a primitive (sphere, cube, plane); path= adds a file; size= (0.05-2, default 0.35) subtool_duplicate Copy a SubTool subtool_delete name=Helmet Delete a SubTool subtool_rename to=Body Rename a SubTool subtool_visibility visible=false Show or hide (toggles when visible is left out) subtool_solo / subtool_show_all Solo the active SubTool / show every SubTool subtool_move direction=up Move a SubTool up or down the list subtool_merge_down / subtool_merge_visible Merge subtool_split_groups / subtool_split_parts Split subtool_append type=sphere name=EyeL size=0.12; subtool_duplicate; subtool_rename to=EyeR"},{"p":"subtools.html","c":"SubTools","a":"see-also","h":"See also","t":"Polygroups and visibility: hide parts of one SubTool Sculpt layers and blend shapes: layers belong to each SubTool Exporting: how SubTools reach other applications Projects, autosave and QuickSave"},{"p":"polypaint.html","c":"Polypaint and materials","a":"","h":"Polypaint and materials","t":"Polypaint stores a colour on every vertex of the mesh, so you can paint a sculpt without UVs or textures, as in ZBrush. This chapter covers the Paint brush, painting while you sculpt, fills and cavity paint, picking colours, and the MatCap materials that change how the model is shaded in the viewport."},{"p":"polypaint.html","c":"Polypaint and materials","a":"how-polypaint-works","h":"How polypaint works","t":"Colour is stored per vertex. The detail you can paint is limited by how dense the mesh is: on a light mesh, colour edges look soft. Subdivide or remesh at a higher resolution before fine painting. Painting respects the mask (masked areas keep their colour) and skips hidden faces. Symmetry works for painting as it does for sculpting. Polypaint is per SubTool and is saved in projects. It is exported as vertex colours to PLY, glTF/GLB, OBJ, USD (displayColor) and GoZ. FBX export doesn't include it. A mesh starts without polypaint. The first paint stroke or fill adds it (white everywhere you haven't painted). Not yet: texture painting on UVs, layers of paint, and baking polypaint to a texture map. See the roadmap."},{"p":"polypaint.html","c":"Polypaint and materials","a":"paint-with-the-paint-brush","h":"Paint with the Paint brush","t":"Press P, click Paint on the top shelf, or pick Paint on the bottom shelf. Choose a colour (see below). Stroke over the model. Draw Size, Strength, the stroke type and the alpha work as they do for sculpting. While the Paint brush is active: Alt paints back towards white. Shift still smooths the shape, as in ZBrush. The surface isn't changed. Press P again, or click Sculpt on the top shelf, to go back to sculpting. Polypaint on a sculpt with the Color palette open 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."},{"p":"polypaint.html","c":"Polypaint and materials","a":"paint-while-sculpting","h":"Paint while sculpting","t":"Turn on Rgb on the top shelf (or RGB while sculpting in the Color palette). Every sculpt brush then also paints the current colour along its stroke. The Smooth brush and Shift-smoothing never paint."},{"p":"polypaint.html","c":"Polypaint and materials","a":"choose-a-colour","h":"Choose a colour","t":"The left shelf has a colour picker (a square plus a hue strip), two swatches and a Fill button. Clicking the second swatch swaps it with the main colour, like ZBrush's Alternate. The Color palette has a larger hue wheel with a hex value, ten preset swatches (white, near black, red, orange, yellow, green, blue, purple, skin and brown) and the fill buttons. Press C with the cursor over the model to pick the colour under it (the mesh needs polypaint for this)."},{"p":"polypaint.html","c":"Polypaint and materials","a":"fill-cavity-paint-and-clear","h":"Fill, cavity paint and clear","t":"The Color palette has four buttons: Button What it does Fill Fills the unmasked area with the colour (the whole mesh when nothing is masked). Same as Fill on the left shelf Fill masked Fills only the masked area. Available when the mesh has a mask Cavity Darkens the creases and cavities with a dark brown, respecting the mask. A quick way to bring out detail Clear Removes all polypaint from the active SubTool All of them are undoable. Show polypaint in the same palette (or Paint on the right shelf) turns the colours off in the viewport without deleting them. Tip: To paint a base colour and then dirt in the creases: Fill with the base colour, then Cavity. For a different cavity colour or strength, use the command (below)."},{"p":"polypaint.html","c":"Polypaint and materials","a":"materials-matcaps","h":"Materials (MatCaps)","t":"Materials change only how the model is shaded in the viewport. They aren't exported and don't change polypaint. Material Look Studio The default clay shading with soft studio lighting. Its colour is Base colour in the Material palette Red Wax Glossy deep red wax, the classic sculpting look Clay Matte grey-brown clay Skin Warm, soft skin tones Chrome Mirror-like metal, good for checking surface flow White Neutral off-white for judging forms Bronze Polished bronze To choose one: Press M for the material picker under the cursor, or click the Material tile on the left shelf. Point at a material to preview it on the model, click to keep it. Esc or clicking away puts the previous material back. Open the Material palette, or the Material tab of the LightBox. The material picker with the six MatCaps and Studio Polypaint multiplies the material, and cavity shading stays on with every material. The material is saved with the project. Not yet: loading your own MatCap images, and physically based materials or BPR-style renders."},{"p":"polypaint.html","c":"Polypaint and materials","a":"scripting","h":"Scripting","t":"Command What it does set_color color=#c08060 Set the paint colour: rrggbb, #rrggbb (quote it in scripts), r,g,b or a name such as white, skin, bone paint_fill area=unmasked Fill; area is unmasked (default), masked or all; strength 0-1 paint_from_cavity color=#202020 strength=0.7 smoothing=2 Cavity paint (defaults: dark brown, 0.7, 2 blur passes) paint_clear Remove all polypaint set_material name=Chrome Viewport material: studio or a MatCap name (desktop app only) set_color color=\"#d9b38c\"; paint_fill; paint_from_cavity strength=0.5"},{"p":"polypaint.html","c":"Polypaint and materials","a":"see-also","h":"See also","t":"Masking: protect areas from painting Sculpting and brushes: Draw Size, Strength, strokes and alphas also apply to painting Exporting: which formats carry vertex colours"},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"","h":"Sculpt layers and blend shapes","t":"Sculpt layers hold changes on top of the base mesh, each with its own weight: a smile, a blink, a corrective shape or a variation you want to dial in and out. Because a layer is a set of per-vertex offsets, it exports straight to game engines and DCC tools as a blend shape (morph target). This chapter covers creating, sculpting into, weighting, playing and exporting layers."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"how-layers-work","h":"How layers work","t":"Each layer stores how far every vertex moves from the base. The shape you see is the base plus every layer times its weight. New strokes go into the active layer, or into the base mesh when Base mesh is selected. Layers belong to a SubTool: each SubTool has its own list of layers. A weight of 0 turns a layer off, 1 shows it as sculpted. Scripts can also set negative weights or weights above 1 to exaggerate a shape. Layers survive subdividing, decimating and LOD chains. A voxel remesh bakes them into the surface (the layers are gone afterwards). Note: Sculpt layers are not the Layer brush. The Layer brush raises the surface to a fixed height; sculpt layers are the blend-shape stack described here."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"the-layers-sub-palette","h":"The Layers sub-palette","t":"Open Tool > Layers in the right tray. The Layers sub-palette with a base mesh and two blend shapes From top to bottom: Base mesh: select it to sculpt the base shape. One block per layer: a radio button with the layer's name (select it to sculpt into that layer), Play, X (delete) and a weight slider from 0 to 1. A name field and + Add at the bottom. The title strip shows the active layer (Layer Smile, or Layer Base)."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"add-a-layer-and-sculpt-into-it","h":"Add a layer and sculpt into it","t":"Type a name in the field at the bottom of Tool > Layers, for example Smile or BlinkL. Click + Add (or press Enter in the field). The new layer becomes the active one. Sculpt. Every stroke goes into the layer until you select another layer or Base mesh. A layer whose weight is 0 can't be sculpted into: SculptForge tells you to raise the weight first. Tip: Name layers the way your engine or rig expects (jawOpen, BlinkL): the names become the blend shape and morph target names in exported files."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"adjust-and-preview-weights","h":"Adjust and preview weights","t":"Drag a layer's weight slider to blend it in and out. Play animates the layer from 0 to 1 and back, over and over, so you can judge the motion. Click Stop to end it; the weight returns to 1. Starting a stroke also stops playback. Weights are saved with the project and used by exports that keep weights (USD writes the current weights)."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"delete-a-layer","h":"Delete a layer","t":"Click X next to the layer. Its offsets are removed from the mesh and the base mesh becomes the active target. Deleting a layer is undoable."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"export-blend-shapes","h":"Export blend shapes","t":"Format What layers become glTF / GLB (File > Export GLB..., Ctrl+E) Morph targets FBX Blend shapes USD / USDZ UsdSkel blend shapes, with their current weights Send to Unreal / Export FBX for Unreal A skeletal mesh with morph targets LOD chain Blend shapes are kept on every LOD Project (.sfproj) Everything: layers, weights and the active layer OBJ, PLY, STL The current blended shape only Importing works the other way: glTF morph targets and FBX or USD blend shapes open as sculpt layers. See Exporting. ZBrush: Layers here are close to ZBrush's sculpt layers with the slider used as a morph. There is no record/eye toggle per layer, no layer folders and no per-layer mask yet."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"scripting","h":"Scripting","t":"Command What it does layer_add name=Smile Add a layer and make it active layer_set_active index=0 Choose the layer strokes go into (-1 = base mesh) layer_set_weight index=0 weight=0.5 Set a layer's weight (negative or above 1 exaggerates) layer_remove index=0 Delete a layer Layers are addressed by index, starting at 0 for the top layer. layer_add name=jawOpen; stroke points=\"0,-0.3,1 0,-0.5,1\" brush=Inflate; export_glb path=head.glb"},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"see-also","h":"See also","t":"SubTools Subdivide, remesh, decimate and LODs Exporting: glTF morph targets, FBX blend shapes, Send to Unreal"},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"","h":"Subdivide, remesh, decimate and LODs","t":"These tools change the topology of the active SubTool: add resolution for detail, rebuild an even surface, reduce the triangle count, or make a chain of levels of detail for a game engine. This chapter explains what each one does to your mesh and its attributes, and when to use it. All of them work on the active SubTool and, except the LOD preview, are undoable with Ctrl+Z."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"at-a-glance","h":"At a glance","t":"Tool Where Triangles Keeps sculpt layers Keeps mask and polypaint Keeps polygroups, hidden faces, UVs Subdivide Tool > Geometry > Subdivide, Ctrl+D x4 per level Yes Yes (interpolated) Yes Voxel Remesh Tool > Remesh > Voxel Remesh Set by resolution Baked in Yes (transferred) No (reset) Decimate Tool > Geometry > Decimate Reduced Yes Yes Yes LOD chain Tool > Export One level per ratio step Yes, on every level Yes Yes"},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"subdivide","h":"Subdivide","t":"Tool > Geometry > Subdivide (Ctrl+D) smooths the mesh with Loop subdivision. Each level multiplies the triangle count by four and rounds off the shape slightly, like ZBrush's Divide with Smt on. Sculpt layers are subdivided with the mesh, so blend shapes keep working. Mask, polypaint and UVs are interpolated; polygroups and hidden faces carry over. SculptForge refuses to subdivide past 50 million triangles. Not yet: multiresolution sculpting. Subdivide replaces the mesh with a denser one; there are no subdivision levels to step down to (ZBrush's SDiv, D / Shift+D) and no reconstruct. Use undo or a duplicate SubTool to keep the lighter version. Multiresolution and dynamic topology are on the roadmap. Tip: The title strip shows the vertex and triangle counts of the whole scene. A few million triangles sculpt smoothly on a recent GPU; go up a level only when you need finer detail."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"voxel-remesh","h":"Voxel remesh","t":"Tool > Remesh > Voxel Remesh rebuilds the active SubTool as an even, watertight surface, like ZBrush's DynaMesh. Use it to: fuse overlapping pieces into one surface (append a sphere, overlap it, merge, remesh); even out stretched triangles after heavy Move or Snake Hook work; clean up scans, splat conversions and AI-generated models before sculpting. The Resolution slider next to the button sets how many voxels span the longest side of the model (64 to 400 in the palette, default 200). Higher keeps more detail and makes more triangles. Wireframe of a model before and after a voxel remesh What happens to your data: Sculpt layers are baked into the surface: the result has no layers. Mask and polypaint are transferred from the nearest original vertex. Polygroups, hidden faces and UVs are reset (everything becomes visible, one polygroup, no UVs). Hidden parts are remeshed too. Separate pieces that don't touch stay separate pieces; overlapping ones are merged. To remesh several SubTools into one, first combine them with Merge visible... or Merge down... in SubTools. ZBrush: There is no Project option, Groups-aware remesh or Blur slider yet, and the remesh produces triangles, not quads. For quad retopology (ZRemesher) see the roadmap: it is not available yet."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"decimate","h":"Decimate","t":"Tool > Geometry > Decimate reduces the triangle count while keeping the shape, using quadric edge collapse (the same family of algorithm as ZBrush's Decimation Master). The Keep slider next to the button sets the fraction of triangles to keep (0.05 to 0.95, default 0.50). Decimation keeps open borders in place, and because it only removes vertices, every remaining vertex keeps its exact sculpt layer offsets, mask and polypaint. Polygroups, hidden flags and UVs survive on the remaining triangles. Use it to make a lighter version of a finished sculpt for export, 3D printing or a review, or to bring a dense scan down to something you can work with. Tip: Decimate a duplicate SubTool (Tool > SubTool > Duplicate) when you want to keep the full-resolution sculpt in the same project."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"lod-chains","h":"LOD chains","t":"A level-of-detail chain is a series of lighter copies of the model for game engines: LOD0 is the full sculpt, and each level after it has a fixed fraction of the triangles of the one before. Open Tool > Export. Set LODs (2 to 6 levels, including LOD0) and Reduction (the triangle ratio from one level to the next, 0.1 to 0.9, default 0.50). Click Generate LOD chain. The Export sub-palette with a generated LOD chain A table lists each level with its triangle count and its budget as a percentage of LOD0. Click a level to preview it on the canvas (wireframe turns on and sculpting pauses); click Sculpt in the table to go back to the editable mesh. The next stroke, or a change to LODs or Reduction, clears the chain; click Generate LOD chain again to rebuild it. Blend shapes (sculpt layers) are kept on every level, so morph targets work at every LOD. To write the chain to disk: LOD chain (GLB per level) in the same sub-palette, or File > Export LOD Chain..., writes one GLB per level named _LOD0.glb, _LOD1.glb and so on. Send to Unreal and Export FBX for Unreal... pack the LODs into one FBX for Unreal's automatic LOD import. See Exporting for these exports and their options. Note: The preview in Tool > Export is of the active SubTool. The exports themselves build a chain for every visible SubTool."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"undo-and-safety","h":"Undo and safety","t":"Subdivide, remesh, decimate and delete hidden are single undo steps on the active SubTool. They can use a lot of memory on dense meshes, and undo keeps a full copy of the previous mesh for each of them. Before a big change on a heavy sculpt: QuickSave (title strip) keeps a timestamped copy of the scene without touching your project file; see Projects. Duplicate the SubTool to keep the old version side by side."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"scripting","h":"Scripting","t":"Command Options subdivide levels 1-4 (default 1) remesh resolution 32-512 voxels across the longest side (default 200) decimate ratio 0.01-1 of the triangles to keep (default 0.5), or triangles for an exact target export_lods path (base name), levels 1-8 including LOD0 (default 4), ratio 0.1-0.9 (default 0.5) sculptforge-cli -c 'open path=scan.obj; remesh resolution=256; decimate triangles=200000; export_lods path=out/rock.glb levels=4 ratio=0.5' The command line accepts a wider remesh range (32-512) than the palette slider."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"see-also","h":"See also","t":"SubTools: merge pieces before a remesh, duplicate before a decimate Sculpt layers and blend shapes Exporting: LOD chains, FBX for Unreal, Send to Unreal Image and text to 3D: generated models are voxel-remeshed for sculpting"},{"p":"generate-3d.html","c":"Image and text to 3D","a":"","h":"Image and text to 3D","t":"SculptForge can turn a picture or a written description into a full 3D model that you can sculpt straight away. This chapter covers the Generate 3D window, the services it can use (free Hugging Face models, your own ComfyUI server, paid fal.ai or Meshy, your own command line, or an offline blockout) and the offline image tools: relief, inflate and stamp. The Generate 3D window with a sketch loaded and the Hugging Face service selected"},{"p":"generate-3d.html","c":"Image and text to 3D","a":"how-it-works","h":"How it works","t":"You give SculptForge an image (a sketch, concept art, a photo of a figurine) or a short description. The service you picked reconstructs a complete mesh: front, back, limbs and all. SculptForge opens the result as a new scene and, unless you turn it off, voxel-remeshes it into one even, watertight surface, so the brushes behave the same as on any other sculpt. Nothing leaves your computer until you choose a hosted service and press Generate 3D model. For exactly what is sent where, see AI services and privacy below. ZBrush: ZBrush has no built-in image-to-3D. The closest workflow is blocking out a base mesh by hand with DynaMesh or ZSpheres; here you get a starting shape in seconds and refine it with the usual brushes."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"open-the-generate-3d-window","h":"Open the Generate 3D window","t":"Any of these opens it: Drop an image file (PNG, JPG, BMP, TGA, PSD or GIF) onto the SculptForge window. The image is loaded as the picture for the From image tab and the window opens. Open the Generate palette and click Generate 3D. Press F3, type generate and press Enter. The window has two tabs, From image and From text. Warning: A generated model replaces the current scene without asking, and arrives as a new, untitled scene. Save your work (Ctrl+S) before you generate."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"generate-from-an-image","h":"Generate from an image","t":"On the From image tab, click Choose image... (or drop a file onto the window). A preview and the image size appear. Pick a service in the drop-down under Full 3D model (AI reconstruction). The default is Hugging Face free models. Set the service's options (model, token or key, see below). Leave Remesh for sculpting on and set its Resolution (96 to 400, default 256). Higher keeps more detail and makes more triangles. Click Generate 3D model. A progress bar shows the queue position and progress; Cancel stops the job. When it finishes, the status line reports the triangle count before and after remeshing, for example \"Generated model imported (412000 tris, remeshed to 180000) - ready to sculpt\"."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"pictures-that-work-well","h":"Pictures that work well","t":"One character or object per image. A plain or transparent background. SculptForge crops the subject out of a transparent background, centres it on a square and scales it to at most 1024 pixels before sending it. The whole subject in frame, seen from the front or a three-quarter view. A clean concept turnaround pose works better than a busy illustration with scenery."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"generate-from-text","h":"Generate from text","t":"On the From text tab, type one object into the box, for example \"a stylised dragon head with curled horns\" or \"a cartoon fox sitting\". Pick Hugging Face - free models, fal.ai, Meshy or ComfyUI - your server. Text to 3D does not work with My generator command or Offline blockout. Click Generate 3D model. Which model runs depends on the service: Service Text-to-3D model Hugging Face Hunyuan3D 2 mini Turbo (Tencent), or Hunyuan3D 2 if you chose it in Model. Any other choice uses Turbo fal.ai Hunyuan3D 3.1 Rapid (Tencent) Meshy Meshy's own text-to-3D model ComfyUI The text workflow you choose (the bundled text-to-3d uses FLUX.1 schnell and Hunyuan3D 2.1)"},{"p":"generate-3d.html","c":"Image and text to 3D","a":"services","h":"Services","t":"Service Cost and setup Good for Hugging Face - free models Free, no account. A free token raises the daily allowance Trying things out, personal work fal.ai - paid, your key Paid per generation, needs a fal.ai key Reliable capacity, newer models Meshy - paid, your key Paid, needs a Meshy key Meshy's own models ComfyUI - your server Free, runs on your own GPU or a studio server Privacy, custom workflows, studios My generator command Free, any program you run locally Your own model or a studio service Offline blockout (inflate silhouette) Free and instant, no network Simple shapes, a quick start"},{"p":"generate-3d.html","c":"Image and text to 3D","a":"hugging-face-free","h":"Hugging Face (free)","t":"This runs each model author's own public demo on Hugging Face's shared ZeroGPU hardware. Pick a Model: Model Notes Hunyuan3D 2.1 (Tencent) The default. Detailed shapes, about 20 seconds TRELLIS.2 (Microsoft) The most detail. Needs a Hugging Face token Hunyuan3D 2 mini Turbo (Tencent) The fastest, about 6 seconds Hunyuan3D 2 (Tencent) Stable Fast 3D (Stability AI) Quick and simple, removes the background itself 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 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. Warning: The Hunyuan3D models are under the Tencent Hunyuan Community License, which does not cover use in the European Union, the United Kingdom or South Korea. If you work there, choose TRELLIS.2, Stable Fast 3D or a paid service. Each model has its own licence; read it before using results commercially."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"falai-and-meshy-paid","h":"fal.ai and Meshy (paid)","t":"fal.ai: choose a Model (TRELLIS.2, Hunyuan3D 3.1 Pro, Hunyuan3D 3.1 Rapid or Meshy 6) or type any fal model id into Model id. Paste your key from fal.ai/dashboard/keys into API key, or set FAL_KEY. Meshy: paste your key from meshy.ai (API settings) into API key, or set MESHY_API_KEY. Generations are billed to your account with that service. Errors such as \"The API key was rejected\", \"Out of credits on this account\" or \"Rate limited\" come from the service."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"comfyui-your-own-server","h":"ComfyUI (your own server)","t":"Runs any ComfyUI workflow on your own computer or a studio GPU server, with whatever models it has. Nothing is sent anywhere else. Start ComfyUI. It listens on http://127.0.0.1:8188 by default. If SculptForge runs on another computer, start ComfyUI with --listen (only on a network you trust: ComfyUI has no login). Install the models your workflow needs. The bundled Hunyuan3D 2.1 workflow needs hunyuan_3d_v2.1.safetensors in ComfyUI/models/checkpoints. In Generate 3D, pick ComfyUI - your server, enter the Server address and click Test connection. A good answer looks like \"Connected: ComfyUI 0.42.0 - NVIDIA GeForce RTX 4090 (24.0 GB)\". Choose a Workflow: a bundled one, or Other file (API format)... for your own. Click Generate 3D model. The progress bar shows your place in ComfyUI's queue. Bundled workflows: Workflow Tab Needs hunyuan3d-image-to-3d From image The Hunyuan3D 2.1 checkpoint (7.4 GB) and a GPU with about 10 GB of memory text-to-3d From text FLUX.1 schnell, BiRefNet and Hunyuan3D 2.1 (about 25 GB of downloads) and a GPU sculptforge-inflate From image The ComfyUI-SculptForge node pack; no GPU. A quick blockout to check your setup Your own workflows must be saved in ComfyUI's API format (in ComfyUI: Workflow > Export (API)). To tell SculptForge where the inputs go, give nodes these titles: Node title What SculptForge does sf_image Puts the uploaded picture into this Load Image node. Without one, the first Load Image node is used sf_prompt Puts your description into this node's text, prompt or string input. Without one, the first CLIP Text Encode not titled \"negative\" is used sf_seed Sets the seed. Inputs named seed or noise_seed get it too SculptForge imports the first mesh file the workflow saves (Save GLB, Preview 3D and most 3D node packs work). For error messages and their fixes, see Troubleshooting."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"my-generator-command","h":"My generator command","t":"Runs any command line on your computer: a local open-source model, a studio service, or a script that calls a cloud API. Type the command into the box. It must contain {input} (replaced with the image path) and {output} (replaced with the path to write, ending in .glb). Both are quoted for you, so don't add quotes. The command must write a GLB file to {output} and exit with status 0. The box starts with a command that runs SculptForge's own silhouette inflation, which is a quick way to check that the pipeline works: sculptforge-cli --set input={input} --set output={output} -c 'image_inflate path=$input subdivisions=2; export_glb path=$output' A wrapper for your own model can be as small as this: # my_generator.py {input} {output} import sys image_path, output_path = sys.argv[1], sys.argv[2] # load your model, run it on image_path, write a .glb to output_path Keep API keys in environment variables that your script reads, not in the command line."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"offline-blockout","h":"Offline blockout","t":"Offline blockout (inflate silhouette) inflates the outline of the picture into a rounded, closed mesh. It is instant and needs no network, but it is a puffy blockout, not a reconstruction: fine for simple shapes, not for characters."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"save-your-settings","h":"Save your settings","t":"Save settings (the small button under Generate 3D model) stores the service, model, keys, token, ComfyUI address and generator command in your ai.json settings file, so they are set the next time you start SculptForge. Keys in ai.json are readable only by your user account. See where settings live."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"quick-shapes-from-an-image-offline","h":"Quick shapes from an image (offline)","t":"The From image tab also has three offline tools under Quick shapes (offline). They need no network and run instantly. The same tools are in the Generate palette as Relief, Inflate and Stamp. Tool What it makes Settings Silhouette blockout > Inflate A rounded, closed base mesh from the outline. Replaces the scene Thickness (0.2 to 2, lower is flatter), Detail (64 to 384) Relief > Make relief A height-field relief: light areas rise. For logos, coins, emblems, height maps and texture photos. Replaces the scene Depth (0.01 to 0.5 of the width), Detail (64 to 1024), Dark is high Stamp onto model > Stamp from this view Projects the image onto the current model from the current view as surface detail, into the active sculpt layer Depth (0.001 to 0.1 of the model size), Dark is high Tip: Stamp writes into the active sculpt layer, so add a layer first (Tool > Layers) if you want to dial the detail in and out afterwards. See Layers and blend shapes."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"after-generating","h":"After generating","t":"Generated meshes are a starting point. A typical next pass: Check the size of the remeshed result in the title strip (Verts, Tris). If the detail is too soft, generate again with a higher Resolution, or run Tool > Remesh > Voxel Remesh at a higher value on the result. Turn on X symmetry if the subject is symmetrical, and sculpt the forms with Clay Buildup, Move and Dam Standard (Sculpting and brushes). Save a project (Ctrl+S): generated scenes start untitled."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"from-scripts-and-agents","h":"From scripts and agents","t":"The same services are available as commands, in the console, sculptforge-cli, Python and MCP agents: # free (Hunyuan3D 2.1 on Hugging Face) sculptforge-cli -c 'image_to_3d path=hero.png; export_glb path=hero.glb' # TRELLIS.2 with a Hugging Face token HF_TOKEN=hf_... sculptforge-cli -c 'image_to_3d path=hero.png model=trellis-2; export_glb path=hero.glb' # fal.ai, keeping the raw (not remeshed) result FAL_KEY=... sculptforge-cli -c 'image_to_3d path=hero.png service=fal model=fal-ai/trellis-2 remesh=false; export_glb path=hero.glb' # text to 3D on your own ComfyUI, repeatable with a seed sculptforge-cli -c 'text_to_3d prompt=\"a carved stone owl\" service=comfyui url=http://gpu-box:8188 seed=42; export_usd path=owl.usdz' # is the ComfyUI server up? sculptforge-cli -c 'comfyui_check' # offline tools sculptforge-cli -c 'image_relief path=logo.png depth=0.08; export_stl path=logo.stl' sculptforge-cli -c 'image_inflate path=sketch.png thickness=0.7; save_project path=blockout.sfproj' Command Key parameters image_to_3d path (required), service (huggingface, fal, meshy, comfyui, command, inflate), model, workflow, url, seed, remesh (default true), resolution (64 to 512, default 256) text_to_3d prompt (required), service (huggingface, fal, meshy, comfyui), model, workflow, url, seed, remesh, resolution image_relief path (required), depth (default 0.12), resolution (default 384), invert image_inflate path (required), thickness (default 1), resolution (default 160), subdivisions (default 1) image_project path (required), depth (default 0.03), invert. Projects from the front (+Z) comfyui_check url Without service=, commands use the settings you saved in the app. See Scripting and automation."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"privacy-and-model-licences","h":"Privacy and model licences","t":"SculptForge has no servers of its own and no telemetry. A hosted service receives only the prepared image (or your text) and your key or token, if any. The free Hugging Face option runs the model authors' own demos; SculptForge does not host or bundle any model. Each model has its own licence: TRELLIS.2 is MIT; Hunyuan3D models use the Tencent Hunyuan Community License (not for use in the EU, UK or South Korea); Stable Fast 3D uses the Stability AI Community License (free under US $1M annual revenue). Read the licence before commercial use. With ComfyUI, the picture goes only to the server address you entered. The full table of what is sent where is in docs/ai-services.md in the SculptForge repository."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"see-also","h":"See also","t":"Sculpting and brushes: refine the generated model Subdivide, Remesh, Decimate and LODs: voxel remesh in detail Gaussian splats: start from a phone capture instead of a picture Scripting and automation: batch generation from the command line Troubleshooting: quota and connection messages"},{"p":"splats.html","c":"Gaussian splats","a":"","h":"Gaussian splats","t":"Gaussian splats are the format behind phone and photogrammetry captures from apps such as Polycam, Luma, Postshot, Scaniverse and KIRI. SculptForge uses them three ways: as a reference to sculpt against, as a source for a watertight base mesh, 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"},{"p":"splats.html","c":"Gaussian splats","a":"supported-files","h":"Supported files","t":"Format Open Save PLY (standard 3D Gaussian Splatting layout, spherical harmonics up to degree 3) Yes Yes .splat (compact web-viewer format) Yes Yes glTF / GLB with KHR_gaussian_splatting Yes Yes OpenUSD .usda / .usdz with a ParticleField3DGaussianSplat prim Yes Yes A PLY file can hold either a mesh or splats; SculptForge tells them apart by their contents."},{"p":"splats.html","c":"Gaussian splats","a":"load-a-capture-as-a-reference","h":"Load a capture as a reference","t":"Open the capture with File > Open... (Ctrl+O), drop it onto the window, or double-click it in the LightBox Splats tab. The splats load next to your sculpt: the current mesh stays, and the capture is drawn around it as a reference. The Splats palette moves into the right tray by itself, and a Splats button appears on the right shelf to show or hide the capture. Most captures arrive upside down, off-centre and at an arbitrary scale. Use the buttons in the Splats palette to place them: Button What it does Flip Turns the capture upside down (180 degrees about X). Most captures need this Turn 90 Turns it 90 degrees about the vertical axis Fit Centres it at the origin and scales it to the size of a new sphere Clean floaters Removes faint splats and stray outliers around the subject The palette also shows the number of splats and their spherical-harmonic degree (for example \"1250000 splats (SH 3)\"), and has: Show and Show mesh to show or hide the capture and the sculpt. An opacity slider (0.05 to 1) to see the sculpt through the capture. Tip: To sculpt a character over a scan, lower the opacity to about 0.4, turn on X symmetry and block in the forms on a sphere or a converted mesh with Clay Buildup and Move."},{"p":"splats.html","c":"Gaussian splats","a":"convert-a-capture-into-a-mesh","h":"Convert a capture into a mesh","t":"Convert to mesh builds a watertight, sculptable mesh from the capture: Trim the capture so only the subject remains: Clean floaters, and place it with Flip and Fit. Set the resolution slider next to Convert to mesh (64 to 400, default 192). Higher keeps more detail. Click Convert to mesh. The result replaces the sculpt; the splats stay as a reference, so you can compare. The conversion is one undo step (Ctrl+Z brings the old sculpt back). The converter keeps the largest solid piece, seals small holes and smooths the surface. It gives a clean base mesh for sculpting, not a textured scan: colour is not carried over."},{"p":"splats.html","c":"Gaussian splats","a":"turn-a-sculpt-into-splats","h":"Turn a sculpt into splats","t":"Sculpt to splats (in the Splats palette when no splats are loaded, or from the command palette) covers the visible SubTools with flat, oriented splats with soft clay shading baked in. Use it to show a sculpt in splat viewers, web scenes or engines that render 3D Gaussian splats. It replaces any loaded splats. From a script you can choose the number of splats and whether to bake shading: sculptforge-cli -c 'open path=bust.glb; mesh_to_splats count=500000 shading=true; splat_save path=bust.ply'"},{"p":"splats.html","c":"Gaussian splats","a":"save-splats","h":"Save splats","t":"Click Save splats... in the Splats palette, or File > Save Splats.... Choose the format by the file type: PLY (for SuperSplat, Postshot and most tools), glTF (.glb with KHR_gaussian_splatting) or OpenUSD (.usda / .usdz). The splat_save command also writes .splat. Placement you made with Flip, Turn 90 and Fit is kept exactly in glTF and USD. PLY has no placement, so it is baked into the splats; if the capture was rotated, view-dependent colour (spherical harmonics above degree 0) is dropped from the PLY, because it would point the wrong way. When you export USD (File > Export USD / USDZ...) with splats loaded, they are included in the same file as a ParticleField3DGaussianSplat prim next to the meshes. Projects (.sfproj) keep loaded splats and their placement. Clear in the Splats palette removes the capture."},{"p":"splats.html","c":"Gaussian splats","a":"from-scripts","h":"From scripts","t":"Command What it does Key parameters open Loads a capture as a reference next to the sculpt path splat_info Reports the loaded splats splat_transform Rotates and places the capture rotate_x, rotate_y, rotate_z (degrees), fit, reset splat_clean Removes faint splats and floaters min_opacity (default 0.05), keep (0.5 to 1, default 0.98) splat_to_mesh Builds a watertight mesh resolution (32 to 512, default 192), min_opacity (default 0.25), keep (default 0.97), close (0 to 8, default 2), smooth (0 to 50, default 6) mesh_to_splats Turns the visible SubTools into splats count (default 250000), shading (default true) splat_save Saves .ply, .splat, .glb, .usda or .usdz path splat_clear Removes the splats A complete phone-capture-to-base-mesh pipeline: sculptforge-cli -c 'open path=scan.ply; splat_transform rotate_x=180 fit=true; splat_clean; splat_to_mesh resolution=256; export_glb path=base.glb' To render only the splats headless, use sculptforge scan.ply --render scan.png --hide-mesh (see Scripting and automation)."},{"p":"splats.html","c":"Gaussian splats","a":"see-also","h":"See also","t":"Image and text to 3D: another way to get a base mesh Subdivide, Remesh, Decimate and LODs: clean up a converted mesh Exporting: USD and glTF exports that carry splats"},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"","h":"Exporting, Unreal and ZBrush","t":"This chapter covers getting your sculpt out of SculptForge: the export formats and what each one keeps, LOD chains for games, sending a mesh straight into a running Unreal Editor, and exchanging models with ZBrush through GoZ. To keep everything (SubTools, layers, mask, polypaint, brushes) use a project file instead; see Projects, autosave and QuickSave."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"export-formats-at-a-glance","h":"Export formats at a glance","t":"Exports write every visible SubTool. Hidden SubTools are left out. Exporting doesn't rename the document or mark it saved, so your next Ctrl+S still saves the project. Format Where in the app Keeps Use it for glTF binary (.glb) File > Export GLB... (Ctrl+E) One node per SubTool, sculpt layers as morph targets, polypaint as vertex colour Games, Blender, three.js, web viewers LOD chain (.glb per level) File > Export LOD Chain... As GLB, one file per level, blend shapes on every level Game engines OpenUSD (.usda, .usdz) File > Export USD / USDZ... One Mesh prim per SubTool, layers as UsdSkel blend shapes, polypaint as displayColor, loaded splats Film pipelines, Omniverse, Apple AR Quick Look FBX for Unreal (.fbx) File > Export FBX for Unreal... Unreal naming and scale, LOD group, layers as blend shapes Unreal Engine (by hand) Wavefront OBJ (.obj) File > Export OBJ... One o object per SubTool, polygroups as g groups, polypaint as vertex colour. Layers are baked into the current blend Any 3D app, ZBrush ZBrush GoZ (.GoZ) File > ZBrush (GoZ) > Export GoZ... Polygroups, mask, polypaint, UVs, quads that came from ZBrush ZBrush STL (.stl) File > ZBrush (GoZ) > Export STL... Geometry only, visible SubTools merged 3D printing PLY (.ply) export_ply command Geometry and polypaint, visible SubTools merged Scan tools, MeshLab, Blender FBX (general) export_fbx command One model per SubTool, blend shapes, optional LOD groups Other FBX pipelines The GLB, LOD chain and FBX for Unreal exports are also in the Tool palette under Export, together with the LOD and Unreal settings. The Tool > Export sub-palette with a generated LOD chain and the Unreal Engine settings Not yet: SculptForge has no UV unwrapping, so exported meshes carry no UVs unless they came in with them (GoZ and project files keep imported UVs). Texture baking (normal and displacement maps) is also on the roadmap. Engines that need lightmap UVs can generate them on import."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"scale-and-axes","h":"Scale and axes","t":"glTF, USD and OBJ are written Y-up with 1 unit = 1 metre, the same space you sculpt in. FBX uses centimetres: export_fbx multiplies positions by 100 by default (scale=), so 1 unit = 1 m. STL and PLY keep positions as they are (no unit conversion). For Unreal, Height sets the real-world size directly (see below)."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"export-a-model","h":"Export a model","t":"Show the SubTools you want to export and hide the others (the eye icon in Tool > SubTool). Choose the export in the File palette and pick a file name. The status line confirms the export (\"Exported ...\"). From a script, each format is one command: sculptforge-cli -c 'open path=bust.sfproj; export_glb path=bust.glb' sculptforge-cli -c 'open path=bust.sfproj; export_usd path=bust.usdz' sculptforge-cli -c 'open path=bust.sfproj; save_obj path=bust.obj' sculptforge-cli -c 'open path=bust.sfproj; export_fbx path=bust.fbx lods=3 ratio=0.5' sculptforge-cli -c 'open path=bust.sfproj; export_stl path=bust.stl; export_ply path=bust.ply'"},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"lod-chains-for-games","h":"LOD chains for games","t":"A LOD (level of detail) chain is the same model at decreasing triangle counts, so an engine can draw distant objects cheaply. SculptForge builds it with quadric decimation, keeping blend shapes on every level. Open Tool > Export. Set LODs (2 to 6 levels, including LOD0) and Reduction (0.1 to 0.9: the triangle ratio from one level to the next, default 0.5). Click Generate LOD chain. A table lists each level with its triangle count and its share of LOD0. Click a level (LOD0, LOD1 ...) to inspect it in the viewport; the wireframe turns on. Click Sculpt to go back to the editable mesh. Export with LOD chain (GLB per level), or send it to Unreal (below). Changing the sliders clears the preview; click Generate LOD chain to build it again. The LOD chain export writes _LOD0.glb, _LOD1.glb and so on next to the path you choose. With several visible SubTools, each SubTool is decimated on its own. sculptforge-cli -c 'open path=rock.obj; export_lods path=out/rock.glb levels=4 ratio=0.5' To reduce the sculpt itself instead of exporting copies, use Tool > Geometry > Decimate; see Subdivide, Remesh, Decimate and LODs."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"send-to-unreal","h":"Send to Unreal","t":"Send to Unreal exports an Unreal-ready FBX and imports it into a running Unreal Editor (5.x) on this computer or another one on your network. Nothing is installed into your project: it uses Unreal's built-in Python remote execution. Your sculpt What arrives in Unreal No sculpt layers A static mesh SM_ with the LOD chain from Tool > Export Sculpt layers A skeletal mesh SK_ with one morph target per layer (Unreal adds a single root bone) Several visible SubTools One FBX model per SubTool, combined into one asset on import Any A material slot M_Clay, and the real-world size from Height Sending the same asset again updates it in place (same name and folder), so references in your levels stay intact."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"one-time-setup-in-unreal","h":"One-time setup in Unreal","t":"Edit > Plugins: enable Python Editor Script Plugin, then restart the editor. Edit > Project Settings > Plugins > Python: tick Enable Remote Execution?. That's all when Unreal runs on the same computer."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"send","h":"Send","t":"Open Tool > Export and find the Unreal Engine section. Set Folder (the content folder, default /Game/SculptForge) and Height (the model's height in Unreal, in centimetres; it starts at the model's current height with 1 unit = 1 m). For a static mesh, set LODs and Reduction above (default 4 levels). Click Send to Unreal, or press Ctrl+U. The status line reports the result. The line under the buttons tells you what will be sent: \"Static mesh with 4 LODs\" or \"Skeletal mesh with 2 morph targets\"."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"unreal-on-another-computer","h":"Unreal on another computer","t":"On the Unreal machine, in Project Settings > Plugins > Python, open Advanced and set Multicast Time-To-Live to 1 and Multicast Bind Address to 0.0.0.0. In SculptForge, tick Unreal is on another computer. Both computers must be on the same network, and the SculptForge computer's firewall must allow incoming connections from the Unreal machine: the editor connects back to SculptForge to fetch the file."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"import-by-hand","h":"Import by hand","t":"Export FBX for Unreal... (in the File palette and in Tool > Export) writes the same file. The file name becomes the asset name. Drag it into the Content Browser: static meshes pick up their LODs from the file's LOD group; for skeletal meshes choose Skeletal Mesh and tick Import Morph Targets."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"from-scripts","h":"From scripts","t":"sculptforge-cli -c 'open path=statue.obj; unreal_send destination=/Game/Props height_cm=200 lods=4' sculptforge-cli -c 'unreal_editors network=true' # list editors on the network sculptforge-cli -c 'open path=statue.obj; export_unreal folder=out height_cm=200' unreal_send also takes name=, project= (pick one editor when several are open) and network=true. Note: Layered sculpts are sent as skeletal meshes without the LOD chain, because Unreal's morph targets need a skeletal mesh (Unreal can generate skeletal LODs itself). The Unreal link has been tested against a stand-in editor that speaks the same protocol but not yet against every Unreal version. If an import fails, Unreal's Output Log shows the importer's messages."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"exchange-models-with-zbrush-goz","h":"Exchange models with ZBrush (GoZ)","t":"SculptForge reads and writes ZBrush's GoZ format and can talk to a running ZBrush through the GoZ bridge on Windows and macOS. The commands are in File > ZBrush (GoZ): Item What it does Send to ZBrush Writes every visible SubTool to the shared GoZ folder and tells ZBrush (starting it if needed). Each SubTool arrives as its own ZBrush SubTool. Turns on Receive automatically Receive from ZBrush Loads what ZBrush last sent with GoZ. Each object updates the SubTool it was sent from (one undo step), or becomes a new SubTool Receive automatically Checks once a second for a new GoZ send from ZBrush and receives it Custom GoZ folder Use another GoZ folder, for example inside a Wine prefix Import GoZ... Opens a .GoZ file, replacing the scene Export GoZ... Writes a .GoZ file. With several visible SubTools, one file per SubTool next to the path Export STL... Writes a binary STL of the visible SubTools The default GoZ folder is C:\\Users\\Public\\Pixologic on Windows and /Users/Shared/Pixologic on macOS. ZBrush doesn't run on Linux, so there the bridge needs a custom folder; GoZ files still import and export."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"a-round-trip","h":"A round trip","t":"In SculptForge, choose File > ZBrush (GoZ) > Send to ZBrush. ZBrush starts or comes forward with the SubTools. If ZBrush was not running and does not import them, press GoZ in ZBrush. Work in ZBrush, then press GoZ there to send the model back. SculptForge receives it automatically and updates the matching SubTools. Each update is an undo step on that SubTool. GoZ keeps polygroups, mask, polypaint and UVs. Quads from ZBrush are split into triangle pairs for sculpting and rebuilt into quads when you send the mesh back. GoZ has no hidden-face flag, so hidden faces are sent like any others. ZBrush: SculptForge cannot open ZBrush's own .ZTL and .ZPR files (they are proprietary and undocumented). Bring models over with GoZ, or export OBJ or FBX from ZBrush. Subdivision levels don't come across: SculptForge receives the mesh at the level you sent. Note: The GoZ bridge follows the format of the open-source Blender GoZ add-on (GoB) and is tested with files, but has not yet been tested against a live ZBrush. If a send does not arrive, export a .GoZ file and import it in ZBrush by hand, and please report it (Help > Report a problem). From scripts: goz_export path=, goz_import path=, goz_send, goz_receive and export_stl path=."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"see-also","h":"See also","t":"Projects, autosave and QuickSave: save everything, not just the mesh SubTools: which SubTools are exported Layers and blend shapes: what becomes morph targets Subdivide, Remesh, Decimate and LODs: decimate before exporting Gaussian splats: saving splats For studios: formats in a pipeline"},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"","h":"Projects, autosave and QuickSave","t":"A SculptForge project (.sfproj) saves your whole scene in one file, so you can close the app and carry on exactly where you stopped. This chapter covers saving and opening projects, the unsaved-changes prompt, recent files, autosave and crash recovery, QuickSave, and the LightBox tabs that show your work."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"what-a-project-keeps","h":"What a project keeps","t":"A .sfproj file holds everything SculptForge knows about the scene: every SubTool, with its name, visibility, mesh, mask, polypaint, polygroups, hidden faces and UVs; every sculpt layer with its weight, and the active layer of each SubTool; loaded Gaussian splats and their placement; your custom brushes, so a project opened on another computer still has them; the camera, the material and display settings, the brush, Draw Size, Strength, paint colour and symmetry; a thumbnail, shown in the LightBox. Undo history isn't saved: an opened project starts with a clean history. Model formats such as OBJ, GLB or FBX can't hold all of this (masks, hidden faces, splats, brushes), so writing them is an export, not a save. See Exporting. ZBrush: A .sfproj is the equivalent of a ZBrush project (.ZPR), and saving a single SubTool scene is close to saving a .ZTL. SculptForge can't read .ZPR or .ZTL files: bring models over with GoZ or as OBJ, FBX or GLB."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"save-a-project","h":"Save a project","t":"File > Save (Ctrl+S) saves to the current project. The first time, it asks for a file name. File > Save As... (Ctrl+Shift+S) saves under a new name. Clicking the document name in the title strip also saves. The title strip shows the document name with * after it while there are unsaved changes, and the window title starts with *. Any edit in any SubTool counts, as do splat edits and layer weight changes. If you opened a model file (an OBJ, say) rather than a project, Save asks where to save a new .sfproj; the original model file is left alone."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"open-a-project-or-model","h":"Open a project or model","t":"File > Open... (Ctrl+O) opens a project, a model or a splat capture. Opening a project or model replaces the scene. File > Open Recent lists the last 10 files you opened or saved. Files that no longer exist are dropped from the list. Clear Recent empties it. Drop a file onto the window to open it. In the LightBox, double-click a project or model. File > New Sphere (Ctrl+N) and File > New Plane start a fresh scene. When you open a project, its saved camera, material and brush settings come back too."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"the-unsaved-changes-prompt","h":"The unsaved-changes prompt","t":"When the scene has unsaved changes, New Sphere, New Plane, Open..., Open Recent, dropping a model or project, Quit (Ctrl+Q) and closing the window first ask: Save saves the project (asking for a name if it has none), then carries on; Don't Save discards the changes and carries on; Cancel goes back to your work. Dropping an image or a .sfbrush file never asks, because it doesn't replace the scene."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"autosave-and-crash-recovery","h":"Autosave and crash recovery","t":"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). The recovery copy is autosave.sfproj in the SculptForge settings folder (see Troubleshooting for where that is on your system). It is deleted once your work is saved or you discard the changes. If SculptForge didn't close normally (a crash or power cut), the next start asks Restore Autosave?: Restore opens the autosaved scene as an untitled, unsaved document. Save it to keep it. Discard deletes the recovery copy. The autosave also appears first in the LightBox QuickSave tab while it exists. Note: Autosave is a safety net, not a substitute for saving. It keeps only the latest copy and is removed as soon as you save."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"quicksave","h":"QuickSave","t":"QuickSave in the title strip saves a timestamped copy of the whole scene, like ZBrush's QuickSave. Your project file, its name and its unsaved state are not changed, so QuickSave is safe to press before any risky step. Copies go to the QuickSave folder of your library (by default Documents/SculptForge/QuickSave), named like QuickSave 2026-10-21 23-15-04.sfproj. The last 10 QuickSaves are kept; older ones are deleted. They appear in the LightBox QuickSave tab, newest first, labelled with their date and time. Double-click one to open it. The tab also has a Save now button. QuickSave has no default shortcut. To give it one, hold Ctrl+Alt, click the QuickSave button and press a key (see The interface)."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"your-library-folder-and-the-lightbox","h":"Your library folder and the LightBox","t":"SculptForge keeps a library folder for your work, by default SculptForge in your Documents folder. It is created on first use with these sub-folders: Folder LightBox tab What goes there Projects Project Your .sfproj files Tools Tool Models to open or append as SubTools Brushes Brush .sfbrush files Alphas Alpha Grayscale images for brush alphas Images Image Sketches and concept art for Generate 3D Splats Splats Gaussian splat captures QuickSave QuickSave QuickSave copies Change it in Preferences > LightBox > Library folder, then Store Config (Ctrl+Shift+I) to keep the setting. Press , (comma) to show the LightBox. The tabs that matter for projects: Project: the projects in your Projects folder, plus any recent project saved elsewhere. Each shows the thumbnail saved with it. QuickSave: the autosave (when there is one) and your QuickSaves, newest first. Recent: everything in Open Recent, of every kind. Double-click a tile to open it (you are asked about unsaved changes first). In the Tool tab, Shift+double-click a model to append it as a SubTool instead. The LightBox showing project thumbnails"},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"scripting","h":"Scripting","t":"Command What it does save_project path=work/dragon.sfproj Save the project (without path, to the current project) open_project path=work/dragon.sfproj Open a project (open also recognises .sfproj) open path=scan.obj Open a model, splat capture or project new_sphere subdivisions=6 / new_plane resolution=128 Start a new scene Projects saved by sculptforge-cli or Python open in the app too. For the file layout, see docs/project-format.md."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"see-also","h":"See also","t":"The interface: LightBox, shortcuts and Store Config SubTools Exporting: formats for other applications Troubleshooting: where settings and the autosave live"},{"p":"scripting.html","c":"Scripting and automation","a":"","h":"Scripting and automation","t":"Every operation in SculptForge is a named command with parameters. The same commands run from the console inside the app, from script files, from the sculptforge-cli tool on a build farm, from Python, and from AI agents through the Model Context Protocol (MCP). This chapter explains the script language, the console, both command-line programs, the Python module and MCP setup. ZBrush: The console plays the role of ZBrush's ZScript window, and Copy session as script is a macro recorder. The language is much simpler than ZScript: one command per statement, with named parameters."},{"p":"scripting.html","c":"Scripting and automation","a":"the-script-language","h":"The script language","t":"A script is a list of statements. Each statement is a command name followed by name=value parameters: new_sphere subdivisions=5 subdivide levels=1 remesh resolution=256; decimate ratio=0.5 # two statements on one line export_glb path=\"My Sculpts/bust.glb\" The rules: Statements are separated by new lines or by ;. # starts a comment that runs to the end of the line (outside quotes). Parameters are name=value with no spaces around =. true and false are booleans; numbers are numbers; anything else is text. Put text in double quotes when it contains spaces, ;, # or \", or when it must stay text even though it looks like a number. Inside quotes only \\\" and \\\\ are escapes, so Windows paths such as \"C:\\Users\\me\\head.obj\" work as written. Colours with a # must be quoted: set_color color=\"#d9a07a\". Paths are UTF-8. Relative paths are relative to the current folder of the program running the script. Scripts stop at the first command that fails."},{"p":"scripting.html","c":"Scripting and automation","a":"the-console","h":"The console","t":"Press the backtick key (left of 1), or choose 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 Every command you run appears in the console as a script line, whether it came from a button, a shortcut, the command palette or the console itself, followed by its result. Failures show in red with the reason. Type a statement and press Enter to run it. Several statements separated by ; run in order and stop at the first failure. Tab completes command names, then parameter names. Press Tab again to list the candidates. Up and Down walk through the last 200 lines you typed. The history is kept between sessions. help (or ?) lists every command; help remesh explains one command and its parameters. clear empties the log. The console buttons (also in the Script palette): Button What it does Run script file... Runs a text file of statements (.sfscript or .txt), stopping at the first failure Copy session as script Puts every command run this session on the clipboard as a script you can save and run again Clear console Empties the log. The session script is kept Tip: To record a macro, work normally, then click Copy session as script, paste it into a text file and edit out what you don't need. Run it later with Run script file... or sculptforge-cli -f."},{"p":"scripting.html","c":"Scripting and automation","a":"the-command-palette","h":"The command palette","t":"Press F3 (or Ctrl+Shift+P, or click Search in the title strip) to search every command, brush and setting by name. Enter runs the highlighted entry; Shift+Enter opens it in the console so you can add parameters first. Commands that need parameters always open in the console. With an empty search, the palette lists what you used recently. See The interface. The command palette searching for a command Tip: Hold Ctrl+Alt and point at a button to see the scripting parameters of the command behind it."},{"p":"scripting.html","c":"Scripting and automation","a":"commonly-used-commands","h":"Commonly used commands","t":"sculptforge-cli --list (or help in the console) prints every command with all its parameters. These are the ones you will use most: Area Command Key parameters Scene new_sphere subdivisions (0 to 8, default 6) Scene new_plane resolution (cells per side, default 128) Files open path: models, projects, splats, GoZ Files save_project path (default: the current project) Files open_project path Geometry subdivide levels (1 to 4, default 1) Geometry remesh resolution (32 to 512, default 200) Geometry decimate ratio (default 0.5) or triangles Geometry mesh_info Sculpting stroke points (required), brush, radius, strength, invert, symmetry Brushes brush_set_alpha name (round, square, noise) or path, invert Brushes brush_ai prompt (required), provider, model, endpoint Brushes brush_install path, code or json Brushes brush_save path (required), name Layers layer_add name Layers layer_set_weight index, weight (both required) Masking mask_by_cavity strength, threshold Masking mask_invert, mask_clear, mask_blur, mask_grow iterations where it applies Polygroups polygroup_auto_by_normals angle (default 30) Visibility isolate_polygroup, hide_polygroup group (required) Visibility show_all, delete_hidden SubTools subtool_append type (sphere, cube, plane) or path, name, size SubTools subtool_select index or name Polypaint set_color, paint_fill color, area (unmasked, masked, all) Polypaint paint_from_cavity color, strength, smoothing AI image_to_3d path (required), service, model, remesh, resolution AI text_to_3d prompt (required), service, model Export export_glb, export_usd, export_stl, export_ply path (required) Export export_fbx path (required), lods, ratio, scale Export export_lods path (required), levels, ratio Unreal unreal_send destination, height_cm, lods, network Splats splat_to_mesh resolution, close, smooth Edit undo, redo A few commands exist only inside the app, because they change the view rather than the model: set_material (name= Studio or a MatCap) and new_cube."},{"p":"scripting.html","c":"Scripting and automation","a":"sculptforge-cli","h":"sculptforge-cli","t":"sculptforge-cli runs commands without a window: on a server, a render farm node or in a build pipeline. It keeps one scene for the whole run, loads your brush library (and studio brushes), and uses the same ai.json settings as the app. sculptforge-cli [options] -c, --command \"<script>\" Run commands, separated by ';' (can be given several times) -f, --file <script.txt> Run commands from a file ('-' reads standard input) --set NAME=VALUE Define a variable; script values written $NAME are replaced -l, --list List every command and its parameters --schema Print the commands as LLM tool definitions (JSON) --mcp Run as an MCP server on standard input and output -q, --quiet Only print errors -h, --help Show this help Each command prints its result on one line (export_glb: Exported out/rock.glb). The exit status is 0 when everything succeeded, 1 for a usage or script syntax error, and 2 when a command failed (the error names the line and the command). Variables make one script reusable. A value written $NAME (the whole value) is replaced with the --set value, so paths with spaces stay intact: cat > lods.sfscript <<'EOF' open path=$in remesh resolution=256 export_lods path=$out levels=4 ratio=0.5 EOF for f in rocks/*.obj; do sculptforge-cli --set in=\"$f\" --set out=\"lods/$(basename \"$f\" .obj).glb\" -f lods.sfscript done More examples: # Concept art -> sculptable model -> USDZ (free, via Hugging Face) sculptforge-cli -c 'image_to_3d path=hero.png; export_usd path=hero.usdz' # Design a brush (free, no key) and save it for the team sculptforge-cli -c 'brush_ai prompt=\"weathered stone edges\"; brush_save path=stone.sfbrush' # Cavity dirt on a sculpt, then a coloured PLY sculptforge-cli -c 'open path=bust.sfproj; paint_from_cavity color=\"#3a2a20\" strength=0.8; export_ply path=bust.ply' Warning: Without the quotes, #3a2a20 would start a comment. In a shell, put the whole script in single quotes so the double quotes reach SculptForge."},{"p":"scripting.html","c":"Scripting and automation","a":"the-sculptforge-app-on-the-command-line","h":"The SculptForge app on the command line","t":"The desktop app takes a few options too, for renders and start-up scripts: Option What it does sculptforge FILE Opens a model, project, splat capture or image at start-up --run \"\" Runs commands at start-up --render out.png Renders the scene to an image and exits --turntable N With --render: N frames around the model (out_000.png ...) --size WxH Render size (default 1024x1024) --view YAW,PITCH Camera angles in degrees (default -30,-15) --zoom F Move the camera F times closer than the framed view --wireframe, --polygroups Render with the wireframe or polygroup colours --hide-mesh Render only the Gaussian splats --fullscreen Start filling the screen (F11 toggles) --demo NAME, --record out.mp4 Play a scripted demo, and record it to a video (needs ffmpeg) --ui-test FILE.sfui, --ui-out DIR Run an interface test script (for developers) A review sheet for a model, eight frames around it: sculptforge model.glb --render review/model.png --turntable 8 --size 1024x1024 Rendering needs an OpenGL 3.3 capable GPU or software renderer and a display. On a headless Linux node, run it under a virtual display such as Xvfb (xvfb-run sculptforge ...)."},{"p":"scripting.html","c":"Scripting and automation","a":"python","h":"Python","t":"SculptForge has a Python module, sculptforge, with the same commands plus NumPy access to the mesh. It is included in the VFX Reference Platform builds and the Rez package (see For studios); when building from source, configure CMake with -DSCULPTFORGE_BUILD_PYTHON=ON. import sculptforge as sf doc = sf.Document() # loads your brush library, like the app sf.run(doc, \"open\", path=\"/show/troll/troll_base.fbx\") sf.run(doc, \"remesh\", resolution=320) sf.run_script(doc, \"decimate ratio=0.25; export_lods path=/out/troll.glb levels=4\") verts, tris = doc.vertices, doc.triangles # NumPy (N, 3) float32 and (M, 3) uint32 doc.set_mesh(verts * 1.1, tris) # bring in a mesh from your own tools (clears undo) print(doc.subtools) # [{'name': ..., 'visible': ..., 'triangles': ...}] doc.active_subtool = \"Helmet\" # select by index or name for name, weight in doc.layers: # sculpt layers (blend shapes) print(name, weight) print([c[\"name\"] for c in sf.commands()]) # every command with its parameters Function or property What it does sf.run(doc, command, **params) Runs one command and returns its message sf.run_script(doc, script) Runs a script in the syntax above and returns the messages sf.commands() Lists every command with its parameters sf.tool_schema() The commands as LLM tool definitions (JSON) doc.vertices, doc.base_vertices, doc.normals, doc.triangles Mesh arrays of the active SubTool (copies) doc.mask, doc.colors, doc.polygroups, doc.hidden Attribute arrays you can read and assign (None if absent) doc.layers, doc.layer_delta(i) Sculpt layers as (name, weight) and their per-vertex offsets doc.subtools, doc.active_subtool The SubTool list and the active SubTool doc.splat_count Number of loaded Gaussian splats Failures raise sculptforge.CommandError. Long operations release the GIL, so you can run them on worker threads."},{"p":"scripting.html","c":"Scripting and automation","a":"ai-agents-mcp","h":"AI agents (MCP)","t":"sculptforge-cli --mcp runs SculptForge as an MCP server. An AI agent (Claude Code, Claude Desktop or any MCP client) gets every command as a tool and works on one scene for the session: it can open files, generate models, sculpt strokes, remesh, paint and export. Claude Code: claude mcp add sculptforge -- /path/to/sculptforge-cli --mcp Claude Desktop or another client: add a stdio server whose command is the full path to sculptforge-cli and whose argument is --mcp. For Claude Desktop that is an entry in its configuration file like this: { \"mcpServers\": { \"sculptforge\": { \"command\": \"/path/to/sculptforge-cli\", \"args\": [\"--mcp\"] } } } Then ask for something like \"make a sphere, remesh it at 128 and export it to ~/Desktop/ball.glb\". File paths are on your machine. The agent works headless; to see the result, open the exported file in SculptForge. sculptforge-cli --schema prints the same tool definitions as JSON, for wiring SculptForge into your own agent."},{"p":"scripting.html","c":"Scripting and automation","a":"see-also","h":"See also","t":"The interface: the command palette and Ctrl-hover help For studios: Rez, the VFX builds and farm rendering Image and text to 3D and Exporting: the commands in context Keyboard and mouse reference"},{"p":"studios.html","c":"SculptForge for studios","a":"","h":"SculptForge for studios","t":"SculptForge is built to drop into animation, VFX and game studios that run their own pipelines: native on Linux, scriptable, standards-based, with no licence server and nothing that phones home. This chapter is for pipeline TDs and IT: the VFX Reference Platform builds, Rez deployment, shared brush libraries, environment variables, headless use and licensing."},{"p":"studios.html","c":"SculptForge for studios","a":"vfx-reference-platform-builds","h":"VFX Reference Platform builds","t":"SculptForge tracks the VFX Reference Platform. Every commit is built and tested in the platform's reference environments: CY2026 CY2027 SculptForge Linux compiler GCC 14.2 GCC 14.2 Built and tested with gcc-toolset-14 glibc 2.28 (EL8) 2.34 (EL9) Rocky Linux 8 and 9 builds; CI checks that no newer glibc symbols are used C++ C++20 C++20 C++20 Python 3.13 3.13 The sculptforge module is built and tested against 3.13 Windows VS 2022 17.6+ VS build tools 14.44+ Visual Studio 2022 macOS minimum 14.0 14.0 Universal binary with deployment target 11.0 FBX 2020.x 2020.x Writes FBX 7.4 binary, which FBX SDK 2020 reads SculptForge doesn't depend on Qt, OpenEXR, Boost, TBB or other platform libraries, so it can't conflict with the versions your other tools load. Its few dependencies (SDL3, Dear ImGui, GLM, ufbx) are linked into the binaries. Each release includes SculptForge--linux--vfx2026.tar.gz (Rocky 8, glibc 2.28) and ...-vfx2027.tar.gz (Rocky 9, glibc 2.34), for x86_64 and ARM64, with the Python module under lib/sculptforge/python."},{"p":"studios.html","c":"SculptForge for studios","a":"deploy-with-rez","h":"Deploy with Rez","t":"packaging/rez/package.py in the source tree builds and installs a Rez package: cd packaging/rez SCULPTFORGE_PYTHON=$(which python3.13) rez-build --install # or --release for your release repository rez-env sculptforge -- sculptforge # the app rez-env sculptforge -- sculptforge-cli --list # every pipeline command rez-env sculptforge python-3.13 -- python -c \"import sculptforge\" The package puts bin/ on PATH and the Python module on PYTHONPATH, and sets SCULPTFORGE_ROOT. The Python module is built for the first python3 found unless SCULPTFORGE_PYTHON names an interpreter."},{"p":"studios.html","c":"SculptForge for studios","a":"studio-brush-libraries","h":"Studio brush libraries","t":"Each artist's own brushes live in their user brush library, one .sfbrush file per brush (see Brush Lab and sharing brushes). To give a whole team the same brushes, put .sfbrush files on a share and list it in SCULPTFORGE_BRUSH_PATH: export SCULPTFORGE_BRUSH_PATH=/studio/brushes:/show/troll/brushes # ';' between folders on Windows sculptforge-cli -c 'brush_library' # every brush, where it comes from and its file, plus the folders The app, sculptforge-cli and the Python module load these folders at start-up, read-only: SculptForge never writes into them, so the share can be mounted read-only. Studio brushes show a studio tag in the Custom brushes list. When brushes share a name, the artist's own wins over a studio one, which wins over a built-in. Among studio folders, the first one listed wins. Refining a studio brush in Brush Lab saves the artist's own version (tagged yours) without touching the share. Deleting that version brings the studio brush back. To publish a brush, copy its .sfbrush file into the share: right-click it in the Custom brushes list > Save .sfbrush..., or take it from an artist's user library. With Rez, set the share once for everyone: when SCULPTFORGE_STUDIO_BRUSHES is set as the package resolves (in a site package, your rezconfig or the launcher), it is appended to SCULPTFORGE_BRUSH_PATH. export SCULPTFORGE_STUDIO_BRUSHES=/studio/brushes rez-env sculptforge -- sculptforge"},{"p":"studios.html","c":"SculptForge for studios","a":"environment-variables","h":"Environment variables","t":"Variable Effect SCULPTFORGE_BRUSH_PATH Read-only studio brush folders (:-separated, ; on Windows) SCULPTFORGE_STUDIO_BRUSHES With the Rez package: appended to SCULPTFORGE_BRUSH_PATH SCULPTFORGE_BRUSH_GALLERY Use another community brush gallery index (a URL or a folder), for example an in-house mirror HF_TOKEN (or HUGGING_FACE_HUB_TOKEN) Hugging Face token for the free image-to-3D models FAL_KEY, MESHY_API_KEY Keys for the paid generation services ANTHROPIC_API_KEY, OPENAI_API_KEY Keys for Brush Lab providers XDG_DATA_HOME (Linux), APPDATA (Windows) Move the settings folder (see where settings live) Keys from the environment are used when none is saved in the app, so a launcher can supply them without writing them to each artist's settings."},{"p":"studios.html","c":"SculptForge for studios","a":"headless-and-farm-use","h":"Headless and farm use","t":"sculptforge-cli runs every editing operation without a display: imports, remeshing, decimation, LOD chains, FBX, USD and glTF export, splat conversion and AI generation. See Scripting and automation. sculptforge --render out.png --turntable 8 renders review images and turntables offscreen. It needs an OpenGL 3.3 context; on a headless Linux node, run it under Xvfb. sculptforge-cli --mcp exposes the same operations to AI agents through the Model Context Protocol. import sculptforge gives Python the same commands plus NumPy arrays of the mesh, for your own tools. A typical farm job turns incoming scans into game-ready assets: sculptforge-cli --set in=/ingest/scan_042.ply --set usd=/assets/scan_042.usda --set glb=/assets/scan_042.glb -c ' open path=$in splat_transform rotate_x=180 fit=true splat_clean splat_to_mesh resolution=320 export_usd path=$usd export_lods path=$glb levels=4 ratio=0.5 ' A --set variable replaces a whole value, so pass complete paths (with their extensions) as variables."},{"p":"studios.html","c":"SculptForge for studios","a":"formats-in-a-pipeline","h":"Formats in a pipeline","t":"Format Read Write Notes OpenUSD (.usda, .usdz) Yes Yes Meshes, xform ops, Z-up stages, UsdSkel blend shapes, ParticleField Gaussian splats; checked with OpenUSD's usdchecker FBX Yes (any version) Yes (7.4 binary) LOD groups, blend shapes, centimetre units glTF / GLB Yes Yes Morph targets, vertex colours, KHR_gaussian_splatting; checked with the Khronos validator OBJ Yes Yes Objects as SubTools, groups as polygroups, vertex colours PLY Yes Yes Meshes with vertex colours, Gaussian splats STL Yes (binary and ASCII) Yes (binary) ZBrush GoZ Yes Yes Polygroups, mask, polypaint, UVs SculptForge project (.sfproj) Yes Yes Everything; a documented ZIP of JSON and binary arrays Binary .usdc files and USD references or payloads aren't read yet; convert with usdcat in.usd -o out.usda. The project format is described in docs/project-format.md in the source tree, so pipeline tools can read it without SculptForge."},{"p":"studios.html","c":"SculptForge for studios","a":"licensing","h":"Licensing","t":"SculptForge is free software under the GNU General Public License, version 3 or later. In practice: Using it is unrestricted, commercially or otherwise, on any number of machines. There are no seats, licence servers or accounts. Your artwork belongs to you. The GPL covers the program, not the models you make with it. You can modify it in-house. The GPL only requires you to share source if you distribute the modified program outside your organisation. Internal use, including across your own facilities and farm, is generally not considered distribution. (This is the common reading of the GPL, not legal advice; check with your counsel.) SculptForge has no telemetry and no servers of its own. AI features are optional and talk only to the service each artist chooses, or to your own ComfyUI server."},{"p":"studios.html","c":"SculptForge for studios","a":"not-yet","h":"Not yet","t":"Planned pipeline features, roughly in order: OpenColorIO viewport display, Alembic export, fuller USD authoring (layers, variants, references, .usdc), UVs and texture baking, multiresolution sculpting. Pipeline requests are welcome as issues on the project's GitHub page."},{"p":"studios.html","c":"SculptForge for studios","a":"see-also","h":"See also","t":"Scripting and automation Exporting, Send to Unreal and GoZ Brush Lab and sharing brushes Image and text to 3D: running models on your own ComfyUI server Troubleshooting"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"","h":"Keyboard and mouse","t":"This chapter is the reference for every default keyboard shortcut and mouse gesture in SculptForge. Inside the app, F1 opens the same list as the Controls window, showing your own keys if you've changed any."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"changing-shortcuts","h":"Changing shortcuts","t":"Every key below can be reassigned: hold Ctrl+Alt and click a button, then press the new key, or use Preferences > Hotkeys. Press Ctrl+Shift+I (Store Config) to keep your changes. See Customizing the interface. On macOS, Cmd works wherever a shortcut says Ctrl. Single-letter shortcuts don't fire while you type in a text field."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"keyboard-shortcuts","h":"Keyboard shortcuts","t":"The table lists the default shortcut of every action, grouped by palette. It is generated from SculptForge's action registry, the same source as the Controls window."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"brush","h":"Brush","t":"Action Keys What it does Brush picker B Pop up every brush under the cursor. Type the first letter of a brush, then the orange letter on its tile (B S T = Standard). Clay 2 Builds up clay that fills the hollows first. ClayBuildup 0 Square, flat-topped clay strokes for blocking in forms. Crease 6 Cuts a sharp crease; Alt raises a ridge. DamStandard 9 A sharp V-shaped crease with the sides pinched in (ZBrush DamStandard). Flatten 7 Presses the surface toward a plane. Inflate 5 Swells the surface outward along its normals. Move 4 Grabs the surface under the cursor and pulls it along. Paste brush Ctrl+V Add the brush on the clipboard: a brush code someone shared, or the text of a .sfbrush file. Pinch 8 Pulls the surface toward the stroke to tighten edges. Smooth 3 Relaxes the surface. Hold Shift to smooth with any brush. Standard 1 Raises the surface along the stroke; Alt digs in."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"color","h":"Color","t":"Action Keys What it does Pick colour C Take the paint colour from the model under the cursor."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"draw","h":"Draw","t":"Action Keys What it does Draw Size at cursor S A Draw Size slider under the cursor: drag it, or type a number and press Enter. Larger brush ] Make the brush 10% larger (hold to repeat). Paint P Paint colour without sculpting (ZBrush Rgb on, Zadd off). Alt paints back to white, Shift still smooths. Smaller brush [ Make the brush 10% smaller (hold to repeat). Strength at cursor I A Strength slider under the cursor: drag it, or type a number and press Enter."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"edit","h":"Edit","t":"Action Keys What it does Redo Ctrl+Shift+Z or Ctrl+Y Redo the last undone action. Undo Ctrl+Z Undo the last action."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"file","h":"File","t":"Action Keys What it does Export GLB... Ctrl+E Export the model as glTF binary, with sculpt layers as blend shapes (morph targets). New Sphere Ctrl+N Replace the scene with a new sphere ready for sculpting. Open... Ctrl+O Open a project (.sfproj), a model (.obj, .glb, .fbx, .stl, .ply, .usd ...) or splats. Quit Ctrl+Q Close SculptForge (asks to save changes first). Save Ctrl+S Save the project (.sfproj: every SubTool, layer, brush and setting). Asks for a name the first time. Save As... Ctrl+Shift+S Save the project under a new name. Send to Unreal Ctrl+U Export a game-ready FBX and import it into the running Unreal Editor (Python remote execution)."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"help","h":"Help","t":"Action Keys What it does Command palette F3 or Ctrl+Shift+P Search every command, brush and setting by name and run it. Commands that need parameters open in the console. Controls F1 Every shortcut and mouse gesture, generated from the commands themselves. User Guide Shift+F1 The SculptForge user guide: every tool explained, with search. Hold Ctrl over a control and press F1 to open the chapter about it."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"lightbox","h":"LightBox","t":"Action Keys What it does LightBox , Show or hide the LightBox: thumbnails of your projects, models, brushes, alphas, materials, images, splats and QuickSaves along the top of the canvas. Double-click to load."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"material","h":"Material","t":"Action Keys What it does Material picker M Pop up the materials under the cursor. Hover one to preview it on the model; click to keep it."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"preferences","h":"Preferences","t":"Action Keys What it does Load UI... Ctrl+L Load a layout file someone shared (or you saved with Save UI). Shelves Tab Hide or show the shelves and trays around the canvas. Store Config Ctrl+Shift+I Keep the current layout, shortcuts and interface preferences for future sessions. Like ZBrush, SculptForge never saves them on its own."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"render","h":"Render","t":"Action Keys What it does Fullscreen F11 Fill the screen with SculptForge (again: back to a window). Wireframe W or Shift+F Show the mesh's triangles over the surface (ZBrush PolyFrame)."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"script","h":"Script","t":"Action Keys What it does Console ` The script console: every command you run appears as a script line, and you can type commands yourself."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"tool","h":"Tool","t":"Action Keys What it does Subdivide Ctrl+D Smoothly subdivide the mesh (Loop subdivision). Each level multiplies the triangle count by 4."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"transform","h":"Transform","t":"Action Keys What it does Frame F Fit the whole model in the view. X X Mirror strokes across X (left and right)."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"mouse-and-pen-gestures","h":"Mouse and pen gestures","t":"Action Gesture Sculpt Left-drag on the model Invert the brush (subtract) Hold Alt while sculpting Smooth Hold Shift while sculpting (works with any brush, and with Paint) Rotate Left-drag on the background, or right-drag Pan Alt+left-drag on the background, middle-drag, or Shift+right-drag Zoom Mouse wheel, Ctrl+middle-drag, or Ctrl+left-drag on the background (when nothing is masked) Paint the mask Hold Ctrl while stroking on the model Erase the mask Hold Ctrl+Alt while stroking on the model Invert the mask Ctrl+click the background Clear the mask Ctrl+drag on the background Isolate a polygroup Ctrl+Shift+click it (again: invert the visibility) Hide a polygroup Ctrl+Shift+Alt+click it Show everything Ctrl+Shift+click the background Hide outside a rectangle Ctrl+Shift+drag (add Alt: hide inside) Select a SubTool Alt+click it in the view Pan, zoom or orbit with a button Drag on Move, Zoom or Rotate on the right shelf Help on any control Hold Ctrl and point at it (Ctrl+Alt: scripting parameters) Assign a shortcut Ctrl+Alt+click any button, then press the key Move or remove shelf items Ctrl+Alt+drag (with Enable Customize on) Tablet pressure Used automatically when a pen is detected (Pressure > Strength / Pressure > Size) Open files Drop a model (.obj, .glb ...), project, brush (.sfbrush), splat capture or image onto the window"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"keys-inside-pop-ups-and-panels","h":"Keys inside pop-ups and panels","t":"Some keys only mean something while a pop-up or panel has the keyboard."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"brush-picker-b","h":"Brush picker (B)","t":"Key Action A letter Keep the brushes whose names start with the letters typed so far The orange letter on a tile Pick that brush (B S T = Standard) Backspace Take back one letter Enter Pick the first match Esc Close"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"draw-size-and-strength-at-the-cursor-s-i","h":"Draw Size and Strength at the cursor (S, I)","t":"Key Action Digits and . Type a value Enter Apply the typed value and close Esc Close without applying a typed value"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"command-palette-f3","h":"Command palette (F3)","t":"Key Action Up / Down, Page Up / Page Down Choose a row Enter Run it Shift+Enter Open a command with parameters in the console to edit them Esc Close"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"console-","h":"Console (`)","t":"Key Action Enter Run the line (statements separated by ;) Tab Complete a command or parameter name; press again to list the candidates Up / Down Walk through earlier lines (the last 200 are remembered between sessions)"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"shortcut-capture-ctrlaltclick","h":"Shortcut capture (Ctrl+Alt+click)","t":"Key Action Any key or chord Becomes the new shortcut (taken from another action if it had it) Backspace or Delete Remove the shortcut Esc Cancel"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"zbrush-keys-that-work-differently","h":"ZBrush keys that work differently","t":"Most ZBrush shortcuts do the same thing in SculptForge. A few differ because the feature works differently or doesn't exist yet: ZBrush SculptForge D / Shift+D (subdivision level up / down) No subdivision levels yet; Ctrl+D subdivides once and can be undone Space (QuickMenu) No QuickMenu; use the left-shelf tiles, B, M, S and I O (Focal Shift) No focal shift setting Q W E R (Draw, Move, Scale, Rotate gizmo) No transform gizmo; W toggles the wireframe (PolyF) Ctrl+W (group masked) Tool > Polygroups > From mask Shift (snap the view while rotating) No view snapping yet H (hide the ZScript window) ` toggles the console"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"see-also","h":"See also","t":"The interface Navigating the view Masking Polygroups and visibility"},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"","h":"Troubleshooting and FAQ","t":"This chapter collects fixes for common problems: start-up and graphics errors, tablets, AI service messages, ComfyUI errors, the camera notch, first-launch warnings on macOS and Windows, where SculptForge keeps its settings, how to reset the interface, and how to report a bug."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"sculptforge-doesnt-start","h":"SculptForge doesn't start","t":"SculptForge draws with OpenGL 3.3 (core profile). Almost every GPU from the last decade supports it, but an old driver, a remote desktop session or a virtual machine without 3D acceleration may not. Update your graphics driver from the GPU maker (NVIDIA, AMD, Intel) or your Linux distribution. Virtual machines: turn on 3D acceleration in the VM settings. Remote desktop: some remote sessions only offer an older OpenGL. Run SculptForge locally, or use a remote tool that forwards the GPU. Linux: on a machine without a working GPU driver, Mesa's software renderer works (slowly): LIBGL_ALWAYS_SOFTWARE=1 sculptforge. To see why it stopped, start it from a terminal and read the messages. It prints the OpenGL version and GPU it found at start-up (for example OpenGL 4.6 (Core Profile) Mesa 26.1.8 on ...), or the error, such as OpenGL 3.3 context creation failed or Missing OpenGL function: .... Linux: run sculptforge in a terminal. macOS: run /Applications/SculptForge.app/Contents/MacOS/SculptForge in Terminal. Windows: the release build has no console window; if it closes straight away, update the driver first."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"first-launch-warnings-on-macos-and-windows","h":"First launch warnings on macOS and Windows","t":"The release builds aren't code-signed yet, so the operating system warns the first time. macOS (Gatekeeper): \"SculptForge can't be opened because it is from an unidentified developer\". In Finder, right-click (or Ctrl+click) SculptForge in Applications and choose Open, then Open again. macOS remembers the choice. On recent macOS versions you may instead need System Settings Privacy & Security > Open Anyway. Windows (SmartScreen): \"Windows protected your PC\". Click More info, then Run anyway. Download SculptForge only from the official releases page on GitHub (the website that Help > Website & documentation opens links to it)."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"the-viewport-is-slow","h":"The viewport is slow","t":"Check the triangle count in the title strip (Tris). Millions of triangles on a laptop GPU are heavy; Tool > Geometry > Decimate or a lower Voxel Remesh resolution brings it down. See Subdivide, Remesh, Decimate and LODs. Turn off Wireframe (W) on dense meshes. Hide SubTools you aren't working on, or Solo the active one. A large Gaussian splat capture costs GPU time too: lower the count with Clean floaters, or untick 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)."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"pen-tablets","h":"Pen tablets","t":"SculptForge reads pen pressure through the operating system's standard pen input, so most Wacom, XP-Pen, Huion and similar tablets, and pen displays, work without settings. Open the Draw palette. Under Tablet it shows \"Pen pressure: 0.42\" once the pen has come near the tablet, or \"No pen detected\". Pressure > strength (on by default) and Pressure > size choose what pressure controls. They are also on the top shelf. A custom brush can also set its own pressure response (pressureCurve in its recipe, see Brush Lab and sharing brushes). If no pen is detected or pressure doesn't change: Install or update the tablet maker's driver, then restart SculptForge. Windows: most drivers have a Windows Ink option. If pressure doesn't reach SculptForge, try switching it (on or off) in the tablet driver's settings for SculptForge or for all applications, then restart SculptForge. Linux: check that the system sees the pen as a tablet (for example in your desktop's tablet settings). If the cursor moves but strokes have no pressure, test in another application to see whether the driver reports pressure at all."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"hugging-face-free-image-and-text-to-3d","h":"Hugging Face (free image and text to 3D)","t":"Message What to do Hugging Face's free GPU time is used up for now The anonymous daily allowance ran out. Add a free token (huggingface.co/settings/tokens, read access) in HF token in the Generate 3D window, or set HF_TOKEN; or wait for it to refill (about a day); or pick another model The Hugging Face Space is asleep or restarting The model's demo is starting up. Try again in a minute, or pick another model Waiting in the queue for a long time The demos are shared. Try a faster model (Hunyuan3D 2 mini Turbo, Stable Fast 3D) or another time of day TRELLIS.2 fails without a token TRELLIS.2 needs a Hugging Face token"},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"falai-and-meshy","h":"fal.ai and Meshy","t":"Message What to do The API key was rejected Check the key in the Generate 3D window, or the FAL_KEY / MESHY_API_KEY variable Out of credits on this account Top up your account with that service Model or endpoint not found Check the fal model id Rate limited Wait a moment and try again"},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"brush-lab","h":"Brush Lab","t":"The default Free provider uses a hosted open model with no account. If it is unreachable and Ollama runs on your computer, SculptForge uses your local model instead. \"Rate limited by the provider\" means too many requests in a short time: wait a few seconds. For setup of local models, see Brush Lab and sharing brushes."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"no-connection-at-all","h":"No connection at all","t":"AI features need internet access (except a local Ollama, LM Studio or ComfyUI). Behind a company proxy or firewall, ask IT to allow the service you use: huggingface.co (and *.hf.space), fal.ai, meshy.ai, or the Pollinations.ai text endpoint for the free Brush Lab model."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"comfyui-errors","h":"ComfyUI errors","t":"Message What to do Nothing is answering at http://... ComfyUI isn't running at that address, or a firewall blocks it. Check the address and port (8188 by default). For another computer, start ComfyUI with --listen ...answered, but not like ComfyUI Something else uses that port, or a proxy is in the way. Use the address ComfyUI prints when it starts This workflow was saved in ComfyUI's editor format Export it again in ComfyUI with Workflow > Export (API) This ComfyUI does not have the node ... or ...is missing the nodes ... Install the custom nodes the workflow uses (ComfyUI Manager > Install Missing Custom Nodes) and restart ComfyUI ...names a model file this server doesn't have Download the model into the right subfolder of ComfyUI's models folder, for example models/checkpoints ComfyUI rejected the workflow: node N ... An input is out of range. Open the workflow in ComfyUI: it shows the same error on that node The workflow finished but saved no mesh file End the workflow with Save GLB or another node that saves a mesh ...the GPU ran out of memory The GPU ran out of memory. Lower the resolution or octree size, or use a smaller model The job disappeared from ComfyUI's queue Someone cleared the queue or ComfyUI restarted. Generate again The workflow has no Load Image node You chose a text workflow on the From image tab. Use it from From text See Image and text to 3D for setup."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"the-top-of-the-window-is-hidden-behind-the-camera-notch","h":"The top of the window is hidden behind the camera notch","t":"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 MacBook displays on Linux), Always reserve, or Off. F11 switches between fullscreen and a window."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"text-and-buttons-are-too-small-or-too-large","h":"Text and buttons are too small or too large","t":"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 (Ctrl+Shift+I)."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"my-layout-or-shortcuts-are-gone-after-a-restart","h":"My layout or shortcuts are gone after a restart","t":"Like ZBrush, SculptForge never saves the layout on its own. Press Store Config (Ctrl+Shift+I) to keep the current layout, shortcuts and interface preferences. See The interface."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"reset-the-interface","h":"Reset the interface","t":"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) and imgui.ini (positions of floating windows such as Brush Lab) from the settings folder below."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"a-key-does-nothing","h":"A key does nothing","t":"Shortcuts don't fire while you type in a text field: click the canvas first. Check the key in Help > Controls (F1), which shows every shortcut as currently assigned; a key you reassigned shows in orange in Preferences > Hotkeys, where Default shortcuts undoes every change."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"where-settings-live","h":"Where settings live","t":"SculptForge keeps its settings in one folder per user: System Settings folder Linux ~/.local/share/SculptForge/SculptForge/ (or $XDG_DATA_HOME/SculptForge/SculptForge/) macOS ~/Library/Application Support/SculptForge/SculptForge/ Windows %APPDATA%\\SculptForge\\SculptForge\\ (usually C:\\Users\\\\AppData\\Roaming\\SculptForge\\SculptForge\\) File or folder What it holds ui.json Layout, shortcut changes and interface preferences, written by Store Config imgui.ini Positions and sizes of floating windows ai.json AI settings: providers, models, keys, ComfyUI address (readable only by your account) project.json Recent files and the autosave interval autosave.sfproj The autosaved copy of unsaved work (removed once you save) clean_exit Marks a normal exit; without it, the autosave is offered for restore console_history.txt The console's command history recent_actions.txt Recently used entries of the command palette brushes/ Your brush library, one .sfbrush file per brush brush-gallery-cache/, brush-gallery.json Community brush gallery cache and its address thumbs/ Cached LightBox and picker thumbnails (safe to delete) Your library folder (projects, tools, alphas, images, splats and QuickSaves shown in the LightBox) is separate: Documents/SculptForge by default, changeable in Preferences > LightBox > 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."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"recovering-work-after-a-crash","h":"Recovering work after a crash","t":"SculptForge autosaves unsaved work every 5 minutes by default (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 QuickSave."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"frequently-asked-questions","h":"Frequently asked questions","t":"Can SculptForge open ZBrush files (.ZTL, .ZPR)? No. They are proprietary and undocumented. Use GoZ, or export OBJ or FBX from ZBrush. See Exporting, Send to Unreal and GoZ. Does it have subdivision levels, DynaMesh, ZRemesher or UVs? Voxel remesh works like DynaMesh. Multiresolution subdivision levels, dynamic topology, automatic retopology and UV unwrapping are not there yet; they are on the roadmap. Is it really free? Can I sell what I make? Yes and yes. SculptForge is GPL-3.0-or-later free software; the licence covers the program, not your models. The AI models have their own licences (see Image and text to 3D). Does SculptForge send anything about me anywhere? No. There is no telemetry and no account. AI features talk only to the service you choose, when you use them. Does it work offline? Yes. Everything except the hosted AI services works offline, and Brush Lab and image-to-3D can run on local models (Ollama, LM Studio, your own ComfyUI or generator command). Where are my brushes? In the brushes folder in the settings folder above. Brush Lab saves every brush you make or refine there."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"report-a-problem","h":"Report a problem","t":"Choose Help > Report a problem to open the issue tracker on GitHub (you need a free GitHub account). A good report includes: The SculptForge version (Help > About SculptForge) and your operating system. Your GPU and driver: the OpenGL ... on ... line SculptForge prints at start-up (see SculptForge doesn't start), or the GPU name from your system settings. Steps to reproduce: what you did, what you expected and what happened instead. The commands you ran: open the console (the backtick key, left of 1), click Copy session as script and paste it into the report. It often reproduces the problem exactly. A file if the problem is with a particular model (a small .sfproj or the original file), and a screenshot for display problems. For a security problem, don't open a public issue; follow SECURITY.md in the repository instead."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"see-also","h":"See also","t":"Installing SculptForge The interface Glossary"},{"p":"glossary.html","c":"Glossary","a":"","h":"Glossary","t":"This chapter maps ZBrush terms to their SculptForge equivalents, so you can find a familiar tool quickly, and explains the terms that only SculptForge uses. \"Not yet\" means SculptForge doesn't have it today; see the roadmap for what is planned."},{"p":"glossary.html","c":"Glossary","a":"zbrush-terms-in-sculptforge","h":"ZBrush terms in SculptForge","t":"ZBrush SculptForge Alpha Alpha: built-in round, square and noise, or any grayscale image. Left shelf, Alpha palette. See Sculpting Auto Groups Tool > Polygroups > By pieces (polygroup_by_connectivity) BPR render Not yet as a renderer. Headless renders and turntables with sculptforge --render (Scripting) Brush pop-up (B) Brush picker, B, then type letters (B S T = Standard) Clip brushes Not yet. The Trim brush shaves to a plane Curve brushes, IMM, ZModeler, ZSpheres Not yet Decimation Master Tool > Geometry > Decimate (decimate). See Geometry Del Hidden Tool > Visibility > Delete hidden (delete_hidden) Divide (Ctrl+D) Tool > Geometry > Subdivide, Ctrl+D Document, 2.5D canvas, pixols Not planned: SculptForge is a 3D sculpting app only Draw Size Draw Size (top shelf, S, [ / ]) DynaMesh Voxel Remesh (Tool > Remesh, remesh). See Geometry Focal Shift No slider for the built-in brushes. Custom brushes have Hardness and Tip sharpness in their recipe Ghost, Transp Not yet. Inactive SubTools are drawn slightly dimmed GoZ GoZ: .GoZ import and export and the GoZ bridge (File > ZBrush (GoZ)). See Exporting Group Masked Tool > Polygroups > From mask (polygroup_from_mask) Group Visible Tool > Polygroups > Merge visible (polygroup_merge_visible) Groups By Normals Tool > Polygroups > By normals with an angle (polygroup_auto_by_normals) Layers (sculpt layers) Tool > Layers: sculpt layers with weights, exported as blend shapes. See Layers LazyMouse LazyMouse stroke type (Stroke palette) LightBox LightBox, , (comma) Live Boolean Not yet Local symmetry, radial symmetry Not yet. Symmetry is X, Y and Z across the world axes Mask by Cavity Tool > Masking > By cavity (mask_by_cavity) Masking (Ctrl) Hold Ctrl to paint the mask, Ctrl+Alt to erase. See Masking Mask Lasso, Select Lasso Not yet. Rectangle hide works: Ctrl+Shift+drag MatCap Material: Studio plus six MatCaps (M). Custom MatCap images not yet. See Polypaint Morph target A sculpt layer; exported as glTF morph targets and FBX/USD blend shapes Mrgb, M (material channel) Not yet: there is no per-vertex material channel Polyframe (PolyF, Shift+F) PolyF on the right shelf, W or Shift+F Polygroups Polygroups: same idea, same Ctrl+Shift gestures. See Polygroups and visibility Polypaint Polypaint: Paint brush (P), Rgb, fills, cavity paint. See Polypaint Projection Master Not yet. Generate > Stamp projects an image onto the model from the view QuickSave QuickSave in the title strip; the last 10 are kept. See Projects Rgb Rgb on the top shelf (paint while sculpting) Rgb Intensity, Z Intensity Strength (top shelf, I) Sculptris Pro, dynamic topology Not yet SDiv, D / Shift+D (subdivision levels) Not yet: Subdivide is a single, destructive step Solo Solo on the right shelf or in Tool > SubTool Spotlight Not yet Store Config Store Config, Ctrl+Shift+I (Preferences > Config) Stroke (Dots, DragRect, Spray) Stroke types Dots, DragRect, Spray, LazyMouse SubTool SubTool: same idea, Alt+click to select. See SubTools Texture palette Not yet: there is no texture painting or texture slot Transpose, Gizmo 3D Not yet. Use the Move brush, or move the camera with the right-shelf buttons UV Master Not yet. UVs that come in with a GoZ model are kept (and saved in projects) Zadd / Zsub Zadd / Zsub on the top shelf; Alt flips for one stroke ZPlugin No in-app plugin system yet. Automate with the Python module, sculptforge-cli and MCP (Scripting) ZRemesher Not yet (quad retopology is on the roadmap) ZScript Script commands: the console (backtick key), script files, sculptforge-cli. See Scripting ZTL, ZPR files Not supported. Use GoZ, OBJ, FBX or GLB to bring models over; save work as .sfproj"},{"p":"glossary.html","c":"Glossary","a":"sculptforge-terms","h":"SculptForge terms","t":"Term Meaning Brush Lab The AI brush creator: describe a brush in words and it builds a recipe you can tweak. Opens from AI Brush. See Brush Lab Brush code One line of text (sfbrush1:...) that holds a whole brush, for sharing in chat or a forum. Paste with Ctrl+V Brush library Your saved custom brushes, loaded at every start Brush recipe The data that defines a custom brush (direction, depth, plane, pinch, pattern and so on): values, never code .sfbrush A file holding one brush recipe .sfproj A SculptForge project file: the whole scene. See Projects Command palette F3: search every command, brush and setting by name and run it Community gallery Shared CC0 brushes you can install in one click (Community brushes) Console The script console (backtick key): every action appears as a script line Ctrl help Hold Ctrl and point at a control to see what it does, its shortcut and its command Gaussian splat A 3D capture made of soft coloured blobs (from phone scanning apps). Load one as a reference, convert it to a mesh, or turn a sculpt into splats. See Gaussian splats Generate 3D Turn an image or a description into a sculptable model. See Image and text to 3D LOD chain A series of lighter copies of a model (LOD0, LOD1...) for game engines. See Geometry MCP Model Context Protocol: sculptforge-cli --mcp lets AI agents such as Claude run SculptForge commands Send to Unreal Export and import a model into a running Unreal Editor in one step (Ctrl+U) Shelves, palettes, trays The interface around the canvas: shelves hold the most-used controls, palettes hold everything, trays hold pinned palettes. See The interface Studio brush folder A shared, read-only brush folder for a team (SCULPTFORGE_BRUSH_PATH). See For studios"},{"p":"glossary.html","c":"Glossary","a":"see-also","h":"See also","t":"Welcome to SculptForge The interface Keyboard and mouse reference"}];+window.GUIDE_INDEX=[{"p":"index.html","c":"SculptForge User Guide","a":"","h":"SculptForge User Guide","t":"This guide explains every part of SculptForge, the free, open-source sculpting app for VFX, animation and games: how the interface is organised, how to sculpt, mask, paint and manage SubTools, how to generate models with AI, and how to get your work into a game engine, a film pipeline or ZBrush. It is written for SculptForge 0.3. You can read it inside SculptForge (Help > User Guide, or Shift+F1) or on the SculptForge website. If you're coming from ZBrush, start with The interface and keep the Glossary at hand: most ZBrush habits work as they are. The SculptForge window with its main regions labelled"},{"p":"index.html","c":"SculptForge User Guide","a":"getting-started","h":"Getting started","t":"Welcome to SculptForge Installing SculptForge The interface Navigating the view"},{"p":"index.html","c":"SculptForge User Guide","a":"sculpting","h":"Sculpting","t":"Sculpting and brushes Brush Lab and sharing brushes Masking Polygroups and visibility SubTools Polypaint and materials Sculpt layers and blend shapes Subdivide, remesh, decimate and LODs"},{"p":"index.html","c":"SculptForge User Guide","a":"ai-and-capture","h":"AI and capture","t":"Image and text to 3D Gaussian splats"},{"p":"index.html","c":"SculptForge User Guide","a":"files-and-pipelines","h":"Files and pipelines","t":"Exporting, Unreal and ZBrush Projects, autosave and QuickSave Scripting and automation SculptForge for studios"},{"p":"index.html","c":"SculptForge User Guide","a":"reference","h":"Reference","t":"Keyboard and mouse Troubleshooting and FAQ Glossary"},{"p":"index.html","c":"SculptForge User Guide","a":"getting-help","h":"Getting help","t":"Hold Ctrl and point at any button for what it does, its shortcut and its script command. Press F1 for every shortcut and mouse gesture, and F3 to find any command by name. Ask questions and report problems on the issue tracker (Help > Report a problem). SculptForge is free software under the GNU General Public License v3.0 or later. This guide is part of SculptForge and is covered by the same licence."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"","h":"Welcome to SculptForge","t":"SculptForge is a free, open-source digital sculpting application for VFX, animation and games. This chapter explains what it is, what it can and can't do yet, and how the rest of this guide is organised."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"what-sculptforge-is","h":"What SculptForge is","t":"SculptForge is a focused sculpting tool with the brushes, symmetry, masking and navigation that ZBrush artists already know, built around a ZBrush-style interface: shelves around a canvas, alphabetical palettes that hold every function, a LightBox of thumbnails and pop-up pickers. It runs natively on Windows, macOS and Linux, starts in a moment, works offline and costs nothing. There is no account, no subscription, no licence server and no telemetry. It is free software under the GNU General Public License v3.0 or later. You own everything you make with it: the GPL covers the program, not your models."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"what-you-can-do-with-it","h":"What you can do with it","t":"Sculpt with fourteen built-in brushes (Standard, Clay, Clay Buildup, Dam Standard, Move, Smooth, Inflate, Pinch, Flatten, Crease, Trim, Snake Hook, Layer and Nudge), four stroke types, brush alphas, X/Y/Z symmetry and tablet pressure. See Sculpting and brushes. Design brushes in words with Brush Lab: describe \"dry cracked mud\" and an AI builds a brush recipe you can tweak with sliders, keep in your library and share as a file or a one-line brush code. See Brush Lab and sharing brushes. Mask, group and hide parts of the model the ZBrush way: Ctrl to paint a mask, Ctrl+Shift to isolate a polygroup. See Masking and Polygroups and visibility. Keep separate meshes as SubTools (body, eyes, teeth, armour), each with its own undo history. See SubTools. Paint colour on the surface (polypaint) and look at the model through seven MatCap materials. See Polypaint and materials. Sculpt layers that double as blend shapes (morph targets), with live weights. See Sculpt layers and blend shapes. Rebuild the mesh: Loop subdivision, voxel remesh (similar to DynaMesh), decimation and one-click LOD chains. See Subdivide, remesh, decimate and LODs. Generate a model from a sketch, concept art or a description, free through Hugging Face or on your own ComfyUI server. See Image and text to 3D. Work with Gaussian splats from phone captures: sculpt against them or turn them into meshes. See Gaussian splats. Export to glTF/GLB, FBX, OpenUSD, OBJ, STL and PLY, send models straight into Unreal Engine, and exchange them with ZBrush through GoZ. See Exporting, Unreal and ZBrush. Automate everything: every action is a command you can type in the console, run headless with sculptforge-cli, script from Python or hand to an AI agent over MCP. See Scripting and automation."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"what-it-doesnt-do-yet","h":"What it doesn't do yet","t":"SculptForge is young (version 0.3). Some things ZBrush artists rely on are still on the roadmap: Multiresolution sculpting (subdivision levels you can step up and down). Subdivide works, but it is a one-way operation. Dynamic topology (Sculptris Pro style) and ZRemesher-class quad retopology. UV unwrapping, texture painting and map baking. Booleans, stencils, and lasso or marquee masking. Others are not on the roadmap: ZSpheres, ZModeler, the 2.5D canvas, and reading ZBrush's own .ZTL and .ZPR files (bring models over with GoZ or as OBJ, FBX or GLB instead). Not yet: where a chapter describes a ZBrush feature SculptForge doesn't have, it says so in a callout like this one. The project's ROADMAP.md lists what is planned and in which order."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"coming-from-zbrush","h":"Coming from ZBrush","t":"Most habits carry over. You sculpt with a left drag, hold Alt to subtract and Shift to smooth, drag on the background to rotate, Alt+drag to pan, and hold Ctrl to mask. The palettes have the names you expect (Alpha, Brush, Stroke, Tool, Transform...), the Tool palette holds the SubTool, Masking and Polygroups sub-palettes, B opens the brush pop-up with the same letter keys (B, S, T picks Standard), , opens the LightBox and Ctrl+Shift+I stores your interface. The Glossary maps ZBrush terms to SculptForge ones."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"how-this-guide-is-organised","h":"How this guide is organised","t":"Getting started: installing, the interface and navigating the view. Sculpting: brushes, Brush Lab, masking, polygroups, SubTools, polypaint, layers and mesh operations. AI and capture: generating models from images and text, and Gaussian splats. Files and pipelines: exporting, projects, scripting and studio deployment. Reference: keyboard and mouse, troubleshooting and the glossary. Inside SculptForge, Help > User Guide opens this guide in its own window with a table of contents, search and links between chapters. Two other kinds of help are always a keystroke away: Hold Ctrl and point at any button, slider or tile to see what it does, its shortcut and the script command behind it. Press F1 for the Controls sheet (every shortcut and mouse gesture) or F3 to search for any command by name."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"getting-help-and-reporting-problems","h":"Getting help and reporting problems","t":"Help > Report a problem opens the issue tracker on GitHub (github.com/islandmed/SculptForge/issues). Include your operating system, your graphics card and what you did just before the problem; see Troubleshooting and FAQ for what else helps. Help > Website & documentation opens the SculptForge website."},{"p":"welcome.html","c":"Welcome to SculptForge","a":"see-also","h":"See also","t":"Installing SculptForge The interface Glossary"},{"p":"installing.html","c":"Installing SculptForge","a":"","h":"Installing SculptForge","t":"This chapter covers what SculptForge needs, which package to download for your system, what to expect the first time you open it, and how to build it from source."},{"p":"installing.html","c":"Installing SculptForge","a":"system-requirements","h":"System requirements","t":"Operating system: Windows 10 or 11 (x64), macOS 11 or later (Apple Silicon or Intel), or a 64-bit Linux distribution (x86_64 or ARM64) with X11 or Wayland. Graphics: a GPU and driver that support OpenGL 3.3 (core profile). Any graphics card from the last ten years qualifies, including integrated Intel, AMD and Apple GPUs. SculptForge asks for 4x multisampling and falls back to none if the driver refuses it. Input: a three-button mouse works for everything. A pen tablet adds pressure (see Sculpting and brushes). Network: not needed for sculpting. The free AI features (Brush Lab and image or text to 3D) and the community brush gallery need an internet connection unless you run models on your own machine. Note: SculptForge is a 64-bit desktop application. There is no web, iPad or Android version."},{"p":"installing.html","c":"Installing SculptForge","a":"download","h":"Download","t":"Download the latest release from the releases page. Pick the file for your system: System File How to install Windows 10/11 (x64) SculptForge--windows-x86_64.exe Run the installer (adds a Start menu shortcut) Windows, portable SculptForge--windows-x86_64.zip Unzip anywhere and run bin\\sculptforge.exe macOS 11+ (Apple Silicon and Intel) SculptForge--darwin-universal.dmg Open the disk image and drag SculptForge to Applications Ubuntu, Debian, Mint, Pop!_OS sculptforge__amd64.deb or ..._arm64.deb sudo apt install ./sculptforge_*.deb Fedora, RHEL, Rocky, Alma 8+ sculptforge-...x86_64.rpm or ...aarch64.rpm sudo dnf install ./sculptforge-*.rpm Any Linux SculptForge--linux-x86_64.AppImage or ...-arm64.AppImage chmod +x the file, then run it Arch Linux packaging/arch/PKGBUILD in the source makepkg -si in that folder (an AUR package is planned) Studio pipelines SculptForge--...-vfx2026.tar.gz or ...-vfx2027.tar.gz See SculptForge for studios Every release also has a SHA256SUMS.txt file with the checksum of each download, so you can confirm a file arrived intact. Each package contains two programs: SculptForge, the desktop application, and sculptforge-cli, the headless command-line tool for scripts, build farms and AI agents (see Scripting and automation). On macOS the command-line tool sits inside the app bundle, at SculptForge.app/Contents/MacOS/sculptforge-cli."},{"p":"installing.html","c":"Installing SculptForge","a":"opening-sculptforge-for-the-first-time","h":"Opening SculptForge for the first time","t":"The builds are not code-signed yet, so your operating system may warn you the first time."},{"p":"installing.html","c":"Installing SculptForge","a":"macos-gatekeeper","h":"macOS: Gatekeeper","t":"macOS may say that SculptForge \"cannot be opened because the developer cannot be verified\". In Finder, open the Applications folder. Right-click (or Ctrl+click) SculptForge and choose Open. Click Open in the dialog that appears. You only need to do this once. On recent macOS versions you may instead have to go to System Settings > Privacy & Security and click Open Anyway next to the message about SculptForge."},{"p":"installing.html","c":"Installing SculptForge","a":"windows-smartscreen","h":"Windows: SmartScreen","t":"Windows may show \"Windows protected your PC\". Click More info. Click Run anyway."},{"p":"installing.html","c":"Installing SculptForge","a":"linux","h":"Linux","t":"The .deb and .rpm packages add SculptForge to your desktop's application menu. An AppImage needs to be made executable first (chmod +x SculptForge-*.AppImage, or tick \"Allow executing file as program\" in your file manager's properties)."},{"p":"installing.html","c":"Installing SculptForge","a":"what-you-see-at-start-up","h":"What you see at start-up","t":"SculptForge opens a 1600 x 960 window with a sphere ready to sculpt and the LightBox open along the top of the canvas on its Project tab, so you can reopen recent work with a double-click. Press , (comma) to close it, or turn off Preferences > LightBox > Show at startup. The first start also creates your library folder (Documents/SculptForge, with Projects, Tools, Brushes, Alphas, Images, Splats and QuickSave sub-folders), which the LightBox shows as User. You can open a file directly from the command line, too: sculptforge model.obj (or a .glb, .sfproj, splat capture or image). sculptforge --fullscreen starts filling the screen; sculptforge --help lists every option. The next chapter, The interface, explains what everything on screen does."},{"p":"installing.html","c":"Installing SculptForge","a":"updating-and-uninstalling","h":"Updating and uninstalling","t":"SculptForge doesn't update itself. To update, download the new release and install it over the old one. Your settings, brushes and library are kept: they live in your user folders, not next to the program (see Troubleshooting and FAQ for where). To uninstall, use your system's usual method (Settings > Apps on Windows, dragging the app to the Bin on macOS, sudo apt remove sculptforge or sudo dnf remove sculptforge on Linux, or delete the AppImage). Delete the settings and library folders as well if you want to remove everything."},{"p":"installing.html","c":"Installing SculptForge","a":"building-from-source","h":"Building from source","t":"You need CMake 3.24 or later and a C++20 compiler: GCC 11+, Clang 14+, Xcode 15+ or Visual Studio 2022. Dear ImGui, GLM and (if it isn't installed already) SDL3 are downloaded automatically. AI features use libcurl on Linux and macOS and the built-in WinHTTP on Windows. git clone https://github.com/islandmed/SculptForge.git cd SculptForge # Linux only: compilers and X11/Wayland/GL/curl headers (Debian/Ubuntu or Fedora/RHEL) sudo ./packaging/linux/install-build-deps.sh cmake -S . -B build -DCMAKE_BUILD_TYPE=Release cmake --build build --parallel ctest --test-dir build --output-on-failure ./build/sculptforge On Windows the program is build\\Release\\sculptforge.exe; on macOS run open build/SculptForge.app. Useful CMake options: Option Default What it does SCULPTFORGE_BUILD_APP ON Build the desktop application (turn off for a headless build of sculptforge-cli only) SCULPTFORGE_BUILD_PYTHON OFF Build the Python module (import sculptforge); needs Python development headers SCULPTFORGE_BUILD_TESTS ON Build the unit and UI tests SCULPTFORGE_USE_SYSTEM_SDL ON Use an installed SDL3 if one is found Running cpack in the build folder makes the platform's packages (.deb, .rpm and .tar.gz on Linux, a .dmg on macOS, an installer and a .zip on Windows)."},{"p":"installing.html","c":"Installing SculptForge","a":"see-also","h":"See also","t":"The interface Troubleshooting and FAQ SculptForge for studios"},{"p":"interface.html","c":"The interface","a":"","h":"The interface","t":"SculptForge's window is laid out like ZBrush's: a canvas in the middle, shelves of the most-used controls around it, a bar of alphabetical palettes that hold every function, and trays at the sides where palettes can stay open. This chapter walks through each region, the pop-up pickers, the LightBox, the built-in help, and how to rearrange the interface and keep your changes. The SculptForge window with its main regions labelled"},{"p":"interface.html","c":"The interface","a":"the-regions-at-a-glance","h":"The regions at a glance","t":"Region Where What it holds Title strip Top edge Document name, scene statistics, status messages, QuickSave, layout presets, Menus, Search Palette bar Under the title strip The 16 palettes, which hold every function Top shelf Above the canvas LightBox, Sculpt/Paint, Zadd/Zsub, Rgb, Draw Size, Strength, symmetry, pressure Left shelf Left of the canvas Brush, Stroke, Alpha and Material tiles, the colour picker Canvas Centre The 3D view; strokes and navigation start only here Right shelf Right of the canvas Frame, Move, Zoom and Rotate, display toggles, Solo Bottom shelf Below the canvas Your quick brushes Trays Far left and far right Palettes you keep open; the right tray holds the Tool palette by default Press Tab to hide the shelves and trays for a bigger canvas, and again to bring them back. The palette bar stays, so every function is still one click away."},{"p":"interface.html","c":"The interface","a":"the-title-strip","h":"The title strip","t":"From left to right: SculptForge and the document name (\"Untitled\" until you save). A * after the name means there are unsaved changes; click the name to save (Ctrl+S). Scene statistics: vertices and triangles across all SubTools, the active SubTool and its position (\"SubTool Body (2/5)\"), the active sculpt layer (\"Layer Base\" when you sculpt the base mesh), the number of Gaussian splats when a capture is loaded, and the frame rate. The status message: the result of the last command or action. Errors show in red for a few seconds. Point at a long message to read all of it. QuickSave: saves a timestamped copy of the whole scene to your library without touching your project file (see Projects, autosave and QuickSave). 1, 2, 3: the layout presets (see Layout presets). Menus: shows or hides the palette bar. Search (F3): opens the command palette. Minimize and Close at the far right. Close asks to save changes first, as Ctrl+Q does."},{"p":"interface.html","c":"The interface","a":"palettes","h":"Palettes","t":"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 Esc or click outside to close it. The Stroke palette open as a drop-down from the palette bar The palette bar lists File and Edit first and Help last, where other desktop applications put them, and the rest in alphabetical order. If you prefer ZBrush's strict A to Z order, turn on Preferences > Interface > Palettes strictly A-Z (ZBrush order). Palette What's in it File New Sphere, New Plane, Open, Open Recent, Save, Save As, autosave interval, Import and every export (OBJ, GLB, LOD chain, USD/USDZ, FBX for Unreal, Send to Unreal, splats), ZBrush (GoZ), Quit Edit Undo and Redo (with the name of the step), Paste brush Alpha The brush alphas: Round, Square, Noise, images from your library, Load image, Invert loaded image Brush AI Brush (Brush Lab), Community brushes, Paste brush, your custom brushes, Front faces only, Invert (Alt), the recipe editor for a custom brush, and every brush as a thumbnail grid with a filter Color The Paint brush, RGB while sculpting, the paint colour and swatches, Fill, Fill masked, Cavity, Clear, Show polypaint Draw Draw Size, Strength, Sculpt/Paint, Zadd/Zsub, Rgb, Front, and the tablet options (Pressure > strength, Pressure > size) with a pen readout Generate Generate 3D (image or text to 3D), Relief, Inflate and Stamp from an image, and the AI brush provider settings Material The seven MatCap materials (Sculpt, the default, first) and Studio, Base colour Preferences Config, Interface, Hotkeys, LightBox and Autosave sub-palettes (see Customizing the interface) Render Wireframe, Show Mesh, Show Polypaint, Show Mask, Show Polygroups, Show Splats, Frame, Fullscreen Script Console, Run script file, Copy session as script, Clear console Splats Gaussian splat tools: show, flip, turn, fit, clean floaters, convert to mesh, sculpt to splats, save, clear Stroke The stroke types (Dots, DragRect, Spray, LazyMouse) and their settings Tool The active SubTool with Open, Save and Import, and the SubTool, Layers, Geometry, Remesh, Masking, Polygroups, Visibility, Export and Display sub-palettes Transform Symmetry X, Y and Z, Frame, Solo, PolyF Help Controls, User Guide, Command palette, Website & documentation, Report a problem, About SculptForge"},{"p":"interface.html","c":"The interface","a":"sub-palettes","h":"Sub-palettes","t":"Large palettes are divided into sub-palettes: headers you click to open or close. The Tool palette is the main example (SubTool, 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. ZBrush: as in ZBrush, SubTool, Layers, Masking, Polygroups and Visibility are sub-palettes of the Tool palette rather than palettes of their own. SculptForge's Remesh sub-palette is where DynaMesh would be."},{"p":"interface.html","c":"The interface","a":"trays","h":"Trays","t":"The trays are columns at the far left and far right of the window where palettes stay open while you work. The right tray is open by default and holds the Tool palette; the left tray starts closed and empty. Put a palette in a tray: open it from the palette bar and click the tray icon at the left of its header. It goes into the right tray; Shift+click the icon to put it in the left tray. You can also drag the icon onto a tray. Take it out again: click the tray icon in its header inside the tray. The palette returns to the bar. Collapse it in place: click its title (or the arrow at the right of the header). Find it: a palette that is in a tray shows its name in orange in the palette bar. Clicking the name scrolls the tray to the palette and flashes its header. Open or close a tray: click its divider, the thin strip with a grip between the tray and the shelves. Drag the divider to make the tray wider or narrower (240 to 480 pixels). The Stroke palette kept in the right tray above the Tool palette When a tray holds several palettes, 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. 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 mouse wheel."},{"p":"interface.html","c":"The interface","a":"the-shelves","h":"The shelves","t":"Shelves surround the canvas and hold the controls you use all the time. Point at anything with Ctrl held to see what it does. Right-click an item for Remove from shelf; see Customizing the interface to add items."},{"p":"interface.html","c":"The interface","a":"top-shelf","h":"Top shelf","t":"First row: LightBox (,): shows or hides the LightBox. Sculpt / Paint (P): brushes change the shape, or paint colour without sculpting. Zadd / Zsub: brushes add to or subtract from the surface. Holding Alt flips it for one stroke. Rgb: sculpt brushes paint the colour at the same time. Draw Size: the brush radius in screen pixels (2 to 800). Strength: how strongly each dab changes the surface (0.01 to 1), ZBrush's Z Intensity. Second row: AI Brush: opens Brush Lab (see Brush Lab and sharing brushes). Front: front faces only, so brushes leave the far side of thin parts alone. X, Y, Z: symmetry across each axis (X toggles X). Pressure > Strength and Pressure > Size: what pen pressure controls. ActiveTris / TotalTris at the right: the triangles you can see and sculpt (visible SubTools, hidden parts left out) and the total in the scene. Draw Size and Strength are sliders with the label inside, as in ZBrush: drag along them, or Ctrl+click to type a value."},{"p":"interface.html","c":"The interface","a":"left-shelf","h":"Left shelf","t":"Four large tiles, each showing the current choice. Click one to open its pop-up picker: Brush: the active brush, with a rendered preview. Stroke: Dots, DragRect, Spray or LazyMouse. Alpha: the brush's stamp shape. Material: how the model is shaded in the view. Under them is the colour picker for polypaint (a saturation/value square and a hue strip), two swatches (the main and second colour; click either to swap them, like ZBrush's Alternate) and Fill, which fills the unmasked area with the main colour."},{"p":"interface.html","c":"The interface","a":"right-shelf","h":"Right shelf","t":"Frame (F): fits the model in the view. Move, Zoom, Rotate: drag on these buttons to pan, zoom and orbit the view, as in ZBrush. PolyF (W): shows the mesh's triangles. Groups: colours each polygroup. Mask: darkens masked areas (on by default). Paint: shows polypaint colours (on by default). Solo: shows only the active SubTool (available with two or more SubTools). Splats: shows or hides a Gaussian splat capture (only shown while one is loaded). Toggles that are on have an orange background. See Navigating the view for the camera."},{"p":"interface.html","c":"The interface","a":"bottom-shelf","h":"Bottom shelf","t":"A row of quick brushes: Standard, Clay, ClayBuildup, DamStandard, Move, Smooth, Inflate, Pinch, Flatten, Crease, Trim, SnakeHook, Layer, Nudge and Paint. The small digit in a tile's corner is its shortcut (1 to 9 and 0 select the first ten built-in brushes, P is Paint). The active brush has an orange outline. The bottom shelf of quick brushes Add a brush: click + at the end of the shelf and pick any brush, built-in or one of your own. Or right-click a brush in the brush picker and choose Add to bottom shelf. Custom brushes show a small sparkle in the corner. Remove a brush: right-click its tile and choose Remove from shelf."},{"p":"interface.html","c":"The interface","a":"pop-up-pickers","h":"Pop-up pickers","t":"Pickers are pop-up grids of thumbnails. They open beside the left-shelf tile you click, or under the mouse when you use a key. They close when you pick something, press Esc or click elsewhere. Pointing at a tile for a moment shows Quick Info: a large preview and a description."},{"p":"interface.html","c":"The interface","a":"brush-picker","h":"Brush picker","t":"Press B (or click the Brush tile). The picker shows a Recent row, then Built-in, Custom (your brushes and Brush Lab creations) and Library (.sfbrush files in your library that aren't loaded yet; picking one loads it). The brush picker after pressing B and typing S Choose a brush with the keyboard the ZBrush way: Press B. Type the first letter of the brush. Only the brushes starting with that letter stay, and each shows an orange letter: the next key that tells it apart. Press that orange letter to pick the brush. For example B S T picks Standard. Backspace takes back a letter and Enter picks the first match. If no name starts with what you typed, the picker falls back to names that contain it. The letter chips along the top (with a count for each letter) filter by a click as well. Right-click a brush for Add to bottom shelf and, for custom brushes, Copy brush code, Rename..., Save as .sfbrush..., Delete... and Reveal in folder (see Brush Lab and sharing brushes)."},{"p":"interface.html","c":"The interface","a":"stroke-alpha-and-material-pickers","h":"Stroke, Alpha and Material pickers","t":"Stroke (click the Stroke tile): Dots, DragRect, Spray and LazyMouse, with Scatter for Spray and Lazy radius for LazyMouse. See Sculpting and brushes. Alpha (click the Alpha tile): Round, Square and Noise, the image alpha you loaded, images in your library's Alphas folder, Load image... and Invert loaded image. Material (M, or click the Material tile): the MatCaps and Studio. Point at a material to preview it on the model; click to keep it. Closing the picker without clicking puts the old material back. See Polypaint and materials."},{"p":"interface.html","c":"The interface","a":"draw-size-and-strength-at-the-cursor","h":"Draw Size and Strength at the cursor","t":"Press S for a Draw Size slider under the mouse, or I for Strength. Drag the slider, or type a number and press Enter (Esc cancels). The pop-up closes when you release the slider. For Strength, typing a number above 1 is read as a percentage (50 means 0.50). [ and ] make the brush 10% smaller or larger at any time."},{"p":"interface.html","c":"The interface","a":"the-lightbox","h":"The LightBox","t":"The LightBox is a strip of thumbnails across the top of the canvas for browsing everything you can load. Press , (comma) or click LightBox on the top shelf to show or hide it. It opens on its own at start-up (see Preferences). The LightBox on the Tool tab Tab Shows Double-click Project Projects (.sfproj) in your library and recently opened projects Open the project Tool Sphere, Plane and Cube, and model files in your library Open (replaces the scene) Brush Every brush: built-in, custom and .sfbrush files Select or load the brush Alpha Round, Square, Noise and images in your Alphas folder Use as the brush alpha Material The MatCaps and Studio Use the material Image Reference images in your library A menu: Generate 3D, relief, inflate, project onto the model, use as alpha Splats Gaussian splat captures (.ply, .splat) Open the capture as a reference QuickSave The autosave and your QuickSaves, newest first Open it Recent Recently opened files of every kind Open it Working with the strip: Shift+double-click a model, project or primitive to append it to the scene as a new SubTool instead of replacing the scene. Drag sideways (or use the mouse wheel) to scroll through the strip. A drag of more than a few pixels scrubs, so a plain click still selects. Drag a tile down out of the LightBox onto the canvas to load it, like a double-click. Folders open with a double-click; the first tile inside a folder goes back up. The arrows at the top go back and forward through tabs and folders, and the breadcrumb shows where you are. Type in Filter to show only items whose names contain the text. Choose 1 to 4 rows of thumbnails. Open folder... adds a folder of your own to the root of every tab. On the QuickSave tab, Save now makes a QuickSave. Right-click a tile for Open, Append as SubTool, the image actions, Show in file manager and Refresh thumbnail. 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 > LightBox > Library folder. ZBrush: the LightBox works like ZBrush's: comma toggles it, double-click loads, and Built-in and User folders play the part of ZBrush's Maxon and User folders."},{"p":"interface.html","c":"The interface","a":"ctrl-hover-help","h":"Ctrl-hover help","t":"Hold Ctrl and point at any button, slider, tile or shelf item. A box shows the item's name, its shortcut as keycaps, what it does, where it lives (for example \"Tool > Geometry\") and the script command it runs. Ctrl-hover help on the Subdivide button Hold Ctrl+Alt instead to see the scripting reference for items that run a command: the command's usage line and each parameter with its type and description. This is the same information the console, sculptforge-cli and AI agents use. Without Ctrl, 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 Info (Ctrl+hover help), and make the box more or less see-through with Popup Info opacity."},{"p":"interface.html","c":"The interface","a":"the-controls-sheet","h":"The Controls sheet","t":"Press F1 (or Help > Controls) for the Controls window. The Keyboard tab lists every action that has a shortcut, grouped by palette and generated from the actions themselves, so it always shows your current keys. The Mouse & pen tab lists the gestures. Type in the filter field to search both. Double-click a row on the Keyboard tab to give that action a new key."},{"p":"interface.html","c":"The interface","a":"this-guide","h":"This guide","t":"Help > User Guide (Shift+F1) opens this guide in its own window: the contents on the left (the open chapter lists its sections), the chapter on the right, and links between chapters. The User Guide window on the Masking chapter Search: type in the search box (Ctrl+F) to find every section that mentions all of your words. Click a result to jump there; the words are marked on the page. Esc clears it. Back and forward: the arrow buttons, Alt+Left / Alt+Right, or the back and forward buttons of your mouse. From any control: while Ctrl-hover help is showing, press F1 (keep Ctrl held) to open the chapter about that control. The help box shows which chapter it is (\"Learn more: ...\"). Code blocks have a Copy button, and Open in browser shows the same page on the SculptForge website. The guide is built into SculptForge, so it works offline and always matches your version."},{"p":"interface.html","c":"The interface","a":"the-command-palette","h":"The command palette","t":"Press F3 (or Ctrl+Shift+P, or click Search in the title strip) to find any action or command by name and run it. It opens at the top centre of the canvas. The command palette searching for subdivide Type part of a name, a palette or a word from the description. The search is forgiving: letters in order are enough (\"sbdv\" finds Subdivide), and every word you type must match somewhere. Each row shows the action, its palette and its shortcut. Up and Down (or Page Up and Page Down) choose a row, Enter runs it and Esc closes the palette. With nothing typed, the palette lists the actions you used most recently. Commands with a required parameter (for example image_relief path=) open in the console with the name already typed. Other commands run with their default values; Shift+Enter sends a command with parameters to the console instead, so you can set them first. Everything scriptable is in the command palette, including commands that have no button in the interface."},{"p":"interface.html","c":"The interface","a":"the-console","h":"The console","t":"Press ` (the backtick key, left of 1 on US keyboards) to open the console, a strip between the canvas and the bottom shelf. It works like ZBrush's ZScript window: Every command you run, from a button, a key, the command palette, a script or an AI agent, appears as a script line followed by its result. Errors show in red. Type a command and press Enter: for example remesh resolution=200 or subdivide; decimate ratio=0.5. Tab completes command and parameter names, Up and Down recall earlier lines, and help (or help remesh) explains commands. Drag the console's top edge to make it taller or shorter. The Script palette has Run script file..., Copy session as script (every command you ran this session, ready to replay, which makes it a macro recorder) and Clear console. The console after a few commands See Scripting and automation for the command language, scripts and headless use."},{"p":"interface.html","c":"The interface","a":"customizing-the-interface","h":"Customizing the interface","t":"Everything about the layout can change: which palettes sit in the trays, what's on each shelf, and which keys do what. As in ZBrush, changes last until you quit unless you store them with Store Config."},{"p":"interface.html","c":"The interface","a":"move-add-and-remove-shelf-items","h":"Move, add and remove shelf items","t":"Open 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\". Hold Ctrl+Alt 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 from palettes to a shelf; along its shelf, or to another shelf, to move it; off the shelves (onto the canvas, for example) to remove it. Turn Enable Customize off when you're done, and press Ctrl+Shift+I to keep the result. Right-clicking a shelf item and choosing Remove from shelf works without Customize mode."},{"p":"interface.html","c":"The interface","a":"assign-shortcuts","h":"Assign shortcuts","t":"Hold Ctrl+Alt and click any button (with Customize off), then press the key you want. Esc cancels and Backspace removes the button's shortcut. Or open 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 (F1). If the key already belongs to another action, it moves to the new one (as in ZBrush) and the status line says which action lost it."},{"p":"interface.html","c":"The interface","a":"store-config-and-friends","h":"Store Config and friends","t":"All in Preferences > Config: Item What it does Store Config (Ctrl+Shift+I) Keeps the current layout, shortcuts and interface preferences for future sessions Restore Custom UI Goes back to what the last Store Config saved Restore Standard UI Goes back to the built-in layout and default shortcuts (Store Config afterwards to make it stick) Save UI... Saves the layout, shortcuts and preferences to a .json file you can share Load UI... (Ctrl+L) Loads such a file (Store Config afterwards to keep it) The first time you change the layout in a session, the status line reminds you once: \"Layout changed - Ctrl+Shift+I to keep it\". What a session changes by itself (the console and LightBox being open, the LightBox tab) doesn't count as a layout change. ZBrush: Store Config has the same shortcut as in ZBrush, and SculptForge never saves the layout on its own either."},{"p":"interface.html","c":"The interface","a":"layout-presets","h":"Layout presets","t":"The 1, 2 and 3 buttons in the title strip (also in Preferences > Config) switch between three layouts: Standard: the Tool palette in the right tray and shelves around the canvas. Sculpt: both trays closed, for the largest canvas. Wide: Brush, Stroke and Alpha in the left tray, Tool and Material in the right tray. A preset changes the layout only (the console, LightBox and left-handed setting stay as they are). Store Config keeps it."},{"p":"interface.html","c":"The interface","a":"interface-preferences","h":"Interface preferences","t":"Preferences > Interface: Setting Default What it does Popup Info (Ctrl+hover help) On Ctrl-hover help boxes Popup Info opacity 0.97 How solid the help box is Tooltip delay 0.5 s How long to point at an icon-only button before its name appears One sub-palette open On Opening a sub-palette closes the others in that palette Auto collapse left tray / right tray On / Off Collapse other palettes in the tray when one wouldn't fit Palettes strictly A-Z (ZBrush order) Off Strict alphabetical palette bar instead of File and Edit first, Help last Left-handed layout Off Mirrors the shelves and trays: tools on the right, navigation on the left UI scale Automatic Size of text and controls (100% to 200%); takes effect at the next start Camera notch Automatic Keeps the interface below a laptop's camera notch in fullscreen (see below) Preferences > LightBox 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 QuickSave). The Preferences palette with the Config and Interface sub-palettes"},{"p":"interface.html","c":"The interface","a":"fullscreen-the-palette-bar-and-the-camera-notch","h":"Fullscreen, the palette bar and the camera notch","t":"F11 (or Render > 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. Tab hides the shelves and trays. On MacBooks with a camera notch, SculptForge keeps the interface below the notch when it fills the screen and fills the band beside the notch with the shell colour. Automatic asks macOS for the safe area (on Linux it recognises a notched MacBook display); Always reserve always keeps a band free at the top, whatever the display; Off uses the full height."},{"p":"interface.html","c":"The interface","a":"see-also","h":"See also","t":"Navigating the view Keyboard and mouse Scripting and automation Troubleshooting and FAQ"},{"p":"navigation.html","c":"Navigating the view","a":"","h":"Navigating the view","t":"This chapter explains how to rotate, pan and zoom the camera with a mouse, a pen or the right-shelf buttons, how to frame the model, and which display toggles help while you sculpt."},{"p":"navigation.html","c":"Navigating the view","a":"how-the-camera-works","h":"How the camera works","t":"The camera orbits around a target point, like a turntable: dragging sideways turns the model around its vertical axis and dragging up or down tilts it, stopping just short of looking straight down or up so the view never flips over. Panning moves the target; zooming moves the camera closer to it or further away. The view is a perspective view with a 35 degree field of view. Navigation starts only on the canvas. A drag that begins on a shelf, a tray or a palette never moves the camera. ZBrush: dragging on the background rotates, Alt+drag pans and the right-shelf Move, Zoom and Rotate buttons work as in ZBrush. SculptForge's left-drag zoom uses Ctrl rather than ZBrush's Alt-then-release gesture."},{"p":"navigation.html","c":"Navigating the view","a":"mouse-and-pen","h":"Mouse and pen","t":"To Do this Rotate Left-drag on the background, or right-drag anywhere on the canvas Pan Alt+left-drag on the background, middle-drag, or Shift+right-drag Zoom Mouse wheel, Ctrl+middle-drag, or Ctrl+left-drag on the background Frame the model F, or Frame on the right shelf \"Background\" means any part of the canvas where the cursor isn't over the model. A left-drag that starts on the model sculpts instead, so with a pen or a one-button mouse, start rotations beside the model. When the model fills the view, zoom out a little or use the right-shelf buttons. Note: Ctrl+left-drag on the background clears the mask when something is masked (and Ctrl+click there inverts it); it zooms only while nothing is masked. Use the wheel or Ctrl+middle-drag to zoom on a masked model. See Masking. On macOS, Cmd works wherever this guide says Ctrl for these gestures, except Ctrl+middle-drag, which needs Ctrl itself."},{"p":"navigation.html","c":"Navigating the view","a":"the-right-shelf-navigation-buttons","h":"The right-shelf navigation buttons","t":"The right shelf has three buttons you drag on rather than click, as in ZBrush. They are handy with a pen, on a laptop trackpad, or when the model fills the canvas and there is no background to drag on. The right shelf: Frame, Move, Zoom and Rotate, then the display toggles Button Drag on it to Frame (click) Fit the whole scene in the view (F) Move Pan the view Zoom Zoom: drag up to come closer, down to move away Rotate Orbit the view The button stays orange while you drag. Frame is also in the Render and Transform palettes."},{"p":"navigation.html","c":"Navigating the view","a":"framing","h":"Framing","t":"Frame (F) points the camera at the centre of the scene and moves it back until everything fits: every visible SubTool, plus the Gaussian splats when they are shown. SculptForge frames the scene for you when you open a file or start from a new primitive. Use it after panning far away, or when a model comes in at an unusual scale."},{"p":"navigation.html","c":"Navigating the view","a":"display-toggles-that-help-navigation","h":"Display toggles that help navigation","t":"These live on the right shelf and in the Render palette: PolyF (W or Shift+F): shows the triangles of the active SubTool over the surface, ZBrush's PolyFrame. Useful for judging mesh density before you subdivide or remesh. Groups: colours each polygroup. Mask: darkens masked areas. Paint: shows polypaint colours (off shows the plain material). Solo: shows only the active SubTool, 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. Fullscreen (F11) and hiding the shelves (Tab) give the canvas the most room. See The interface."},{"p":"navigation.html","c":"Navigating the view","a":"not-yet","h":"Not yet","t":"Not yet: SculptForge has no orthographic view, no snapping to front, side or top views, no rotation around the point under the cursor (the camera always orbits its target, which Frame sets to the scene centre), no floor grid and no saved camera views. Pan the target onto the area you're working on to orbit around it."},{"p":"navigation.html","c":"Navigating the view","a":"see-also","h":"See also","t":"The interface Keyboard and mouse Sculpting and brushes"},{"p":"sculpting.html","c":"Sculpting and brushes","a":"","h":"Sculpting and brushes","t":"This chapter covers everything that happens when you drag a brush across a model: the built-in brushes and the custom brushes that ship with SculptForge, brush size and strength, modifier keys, stroke types, alphas, symmetry and pen pressure. To design your own brushes, see Brush Lab and sharing brushes. Sculpting the lion head with X symmetry"},{"p":"sculpting.html","c":"Sculpting and brushes","a":"your-first-stroke","h":"Your first stroke","t":"Pick a brush: click it on the bottom shelf, press its number key, or press B to open the brush picker. Left-drag on the model. The brush works on the surface under the cursor. Hold Alt while dragging to invert the brush (dig in instead of building up), or hold Shift to smooth. Press Ctrl+Z to undo a stroke, Ctrl+Shift+Z (or Ctrl+Y) to redo it. Each SubTool keeps its own history of up to about 1 GB; the oldest steps are dropped beyond that. Dragging on the background never sculpts: it rotates the view (see Navigation). The brush only works on the active SubTool, and only on parts that are visible and not masked. ZBrush: the modifiers are the ones you know. Alt flips Zadd and Zsub for one stroke, Shift smooths with any brush, Ctrl paints a mask (see Masking)."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"built-in-brushes","h":"Built-in brushes","t":"SculptForge has fourteen sculpting brushes plus the Paint brush. The first ten have number keys; all of them are on the bottom shelf by default and in the brush picker. Brush Key What it does With Alt Standard 1 Raises the surface along the stroke, the all-purpose brush. Digs in Clay 2 Builds up clay that fills the hollows first, with a slightly flat top. Carves away Smooth 3 Relaxes the surface, evening out bumps. The same brush Shift gives you. No change Move 4 Grabs the surface under the cursor and pulls it along, parallel to the screen. No change Inflate 5 Swells the surface outward along its normals. Deflates Crease 6 Cuts a sharp crease and pinches its sides in. Raises a ridge Flatten 7 Presses the surface toward a plane through the brush area. Pushes away from the plane Pinch 8 Pulls the surface toward the stroke to tighten edges. Spreads it apart DamStandard 9 A narrow, deep V-shaped crease with the sides pinched in. A sharp ridge ClayBuildup 0 Square, flat-topped clay strokes for blocking in forms. Carves flat-bottomed SnakeHook Pulls the surface out into horns and tendrils that taper as you drag. No change Trim Trim Dynamic: shaves away everything above a plane for hard surfaces. Fills up to the plane Layer Raises the surface to one fixed height per stroke; overlapping passes never stack. Lowers to a fixed depth Nudge Slides the surface sideways along the stroke without lifting it. No change Paint P Paints colour without sculpting. See Polypaint and materials. Paints back to white Notes on particular brushes: Move and SnakeHook move the surface with the cursor instead of placing dabs, so stroke types (Dots, Spray and so on) don't apply to them. Layer sets its height from the brush size and Strength. Pen pressure lowers the height when Pressure > Strength is on, so you can feather the edge of a layer. Trim gives crisp planes on cylinders and edges. Use it with Front on when you work on thin shapes. ZBrush: DamStandard, ClayBuildup, SnakeHook, Trim (Dynamic), Layer and Nudge behave like their ZBrush namesakes. Brushes such as hPolish, ClayTubes, Slash or the IMM and curve brushes are not built in; you can get close to several of them with a custom brush in Brush Lab."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"custom-brushes-that-ship-with-sculptforge","h":"Custom brushes that ship with SculptForge","t":"Besides the built-in brushes, SculptForge ships seven custom brushes. They are recipes: data that you can open and change in Brush Lab. They appear in the Custom section of the brush picker and in Brush > Custom brushes. Brush What it does Wrinkle Fine, sharp creases for skin folds and fabric wrinkles. Palette Knife Flattens and drags clay sideways like a sculptor's knife. Dragon Scales Stamps rounded overlapping scales along the stroke. Stone Chisel Scrapes hard planes and breaks them up with cracks for rocks and ruins. Skin Pores Sprinkles tiny pores for close-up skin detail. Clay Buildup Builds up flat-topped strokes of clay for blocking in forms. Edge Wear Chips and softens only the sharp edges and ridges, for weathered props. Custom brushes respond to Alt, Shift, the mask, symmetry and the stroke settings just like built-in ones. Their thumbnails carry a small sparkle when you put them on the bottom shelf."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"pick-a-brush","h":"Pick a brush","t":"You can choose a brush in several places: Bottom shelf: click a tile. The active brush has an orange outline and the number key is shown in the corner of each tile. Number keys: 1 to 9 and 0 pick the first ten built-in brushes (see the table above); P 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. Command palette (F3): type the brush name and press Enter."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"the-brush-picker","h":"The brush picker","t":"Press B to open the brush picker under the mouse. It shows a Recent row (once you have picked brushes), then Built-in, Custom and Library sections. The Library section lists .sfbrush files in the Brushes folder of your LightBox library that aren't loaded yet; picking one loads it. The brush picker after pressing B, with letter badges The picker works the ZBrush way, by typing letters: Press B. Type the first letter of the brush. Only brushes starting with that letter stay, and each shows an orange key badge: the next letter that tells it apart from the others. Press the letter on the badge to pick that brush. For example B, S, T picks Standard, and with the brushes that ship, B, C, L picks Clay. If no brush name starts with what you typed, the picker falls back to names that contain it. Backspace removes the last letter, Enter picks the first match, and Esc or a click outside closes the picker. The letter chips along the top (A 2, C 4 ...) show how many brushes start with each letter; click one to filter by it. Hover a tile for a large preview and the brush's description. Right-click a tile for Add to bottom shelf, and on custom brushes also Copy brush code, Rename..., Save as .sfbrush..., Delete... and Reveal in folder (see Brush Lab and sharing brushes). ZBrush: B then two letters is the same muscle memory. Holding Ctrl while picking to choose a masking brush is not supported; mask strokes always use Ctrl with the current settings."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"draw-size-and-strength","h":"Draw Size and Strength","t":"Two values control every brush. Both are on the top shelf and in the Draw palette. Setting Range Default How to change it Draw Size 2 to 800 60 Brush radius in screen pixels. [ and ] make it 10% smaller or larger (hold to repeat). S opens a slider at the cursor. Strength 0.01 to 1 0.50 How strongly each dab changes the surface (ZBrush Z Intensity). I opens a slider at the cursor. Because Draw Size is measured on screen, the brush covers less of the model as you zoom in, which is what you want for detail work. The S and I pop-ups take the mouse or the keyboard: drag the slider and release to close it, or type a number and press Enter. For Strength you can type either 0.35 or 35. Esc closes the pop-up without typing anything new. The Draw palette"},{"p":"sculpting.html","c":"Sculpting and brushes","a":"sculpt-paint-zadd-zsub-rgb-and-front","h":"Sculpt, Paint, Zadd, Zsub, Rgb and Front","t":"These toggles sit on the top shelf and in the Draw palette: Control What it does Sculpt / Paint Sculpt makes brushes change the shape. Paint (P) paints colour only. Zadd / Zsub Zadd makes brushes add (the default), Zsub makes them subtract. Alt flips the current choice for one stroke. Rgb Sculpt brushes also paint the current colour as they sculpt (ZBrush Rgb with Zadd). Front Front faces only: brushes leave the far side of thin parts alone, such as the back of an ear or a cape. The Brush palette has the same Front and invert settings as the checkboxes Front faces only and Invert (Alt)."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"modifier-keys-while-sculpting","h":"Modifier keys while sculpting","t":"Hold Effect Alt Inverts the brush for this stroke (see the table of brushes). Shift Smooths with the Smooth brush, whatever brush is active. With the Paint brush active, Shift still smooths the shape. Ctrl Paints a mask instead of sculpting; Ctrl+Alt erases it. See Masking. Ctrl+Shift Visibility gestures: isolate, hide and show polygroups. See Polygroups and visibility. Smoothing uses the current Strength, so lower Strength gives a gentler smooth."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"strokes","h":"Strokes","t":"The stroke type decides how cursor movement becomes brush dabs. Choose it from the Stroke tile on the left shelf, which opens the stroke picker, or from the Stroke palette. The stroke picker Stroke What it does Setting Dots Even dabs along the path: the classic brush stroke (default). None; spacing comes from the brush. DragRect Click and drag one stamp: the drag length sets its size and its direction the rotation. Great with alphas. None Spray Scattered dabs of random size, strength and rotation, for organic texture. Scatter (0 to 2, default 1): how far dabs land from the cursor, as a fraction of the brush size. LazyMouse The brush trails the cursor on a string, for smooth, steady lines. Lazy radius (1 to 300 px, default 40): longer is steadier. The setting slider appears under the stroke tiles when Spray or LazyMouse is selected. With LazyMouse, the viewport draws the string between the cursor and the brush point. Notes: With DragRect, the stamp is placed where you first click. While you drag, it is redrawn at the new size and angle, and it is committed when you release. Mask strokes (Ctrl) always use dots, even when DragRect is selected. Custom brushes set their own dab spacing and can add jitter (see Brush Lab). ZBrush: DragRect, Spray and LazyMouse match ZBrush's DragRect, Spray and LazyMouse. Freehand and Dots are the same thing here. DragDot, Roll and curve strokes are not available yet."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"alphas","h":"Alphas","t":"An alpha is a grayscale stamp that shapes the brush tip: white is full effect, black is none. It affects every brush, built-in or custom. Choose one from the Alpha tile on the left shelf (the alpha picker) or the Alpha palette, which also shows a large preview of the current alpha. The alpha picker Alpha What it does Round The plain round falloff (no alpha). The default. Square A square stamp with soft edges. Noise A noisy stamp for rough, organic texture. To use your own image: Click Load image... in the alpha picker or the Alpha palette. Choose a PNG, JPG, BMP, TGA, PSD or GIF. Colour images are converted to grayscale. Turn on Invert loaded image before loading if your image is white where it should have no effect. Images you keep in the Alphas folder of your LightBox library (Documents/SculptForge/Alphas by default) appear in the picker's Images section, so you can switch between them with one click. The alpha's top edge points up the screen; with DragRect it follows the drag direction instead. From a script: brush_set_alpha name=square, or brush_set_alpha path=bark.png invert=true. ZBrush: there is no alpha library browser with hundreds of alphas yet, and alpha options such as MidValue, Rf (radial fade) or tiling are not available. Any grayscale image works, including alphas you already have as PNG."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"symmetry","h":"Symmetry","t":"Symmetry mirrors every stroke, including mask and paint strokes. X mirrors left and right. It is on by default; press X to toggle it. Y mirrors top and bottom, and Z mirrors front and back. They have no default key (you can assign one; see The interface). The X, Y and Z buttons are on the top shelf and in the Transform palette. You can combine them: X and Z together give four-way symmetry. Symmetry mirrors across the scene's axes through the origin. Models that are centred on the origin, such as SculptForge's primitives and most character exports, mirror correctly. If a stroke lands in the wrong place on the other side, the model is off-centre. ZBrush: this is ZBrush's world symmetry with the >X< axis on. Local symmetry, radial symmetry and topological (poseable) symmetry are not available yet."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"pen-pressure-and-tablets","h":"Pen pressure and tablets","t":"SculptForge reads pen pressure from graphics tablets and pen displays through the operating system. When it 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: Toggle Default Effect Pressure > Strength On Pen pressure scales the brush strength. Pressure > Size Off Pen pressure scales the brush size (down to 5% at the lightest touch). Pressure applies only to strokes made with the pen; mouse strokes always use full pressure. Custom brushes also have a Pressure curve setting that makes them respond to a light or a firm touch (see Brush Lab). If the pen moves the cursor but pressure does nothing, see Troubleshooting. 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 Alt) and the side buttons (default: lower button right-click to rotate the view, upper button Invert, third button Pan view). Store Config (Ctrl+Shift+I) keeps these settings. Setup notes for Windows Ink, macOS and Linux are in docs/tablet.md."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"customize-the-bottom-shelf","h":"Customize the bottom shelf","t":"The bottom shelf holds your most-used brushes. By default it shows Standard, Clay, ClayBuildup, DamStandard, Move, Smooth, Inflate, Pinch, Flatten, Crease, Trim, SnakeHook, Layer, Nudge and Paint. The bottom shelf 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 Ctrl+Alt+drag a tile to a new place. Change a brush's key: Ctrl+Alt+click its tile, then press the new key. Shelf changes last until you quit. Press Ctrl+Shift+I (Store Config) to keep them. See The interface for more on customizing."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"sculpt-from-a-script","h":"Sculpt from a script","t":"The stroke command applies a brush along a path on the active SubTool, as one undo step. It is useful for scripted detailing and for AI agents: sculptforge-cli -c 'new_sphere subdivisions=6; stroke brush=Crease points=\"-0.6,0.2,0 0,0.4,0 0.6,0.2,0\" symmetry=x; export_glb path=out.glb' Points are projected onto the surface along view (default 0,0,-1, the front view). radius (world units), strength, pressure, invert, spacing, curve and seed work as in the viewport. See Scripting and automation."},{"p":"sculpting.html","c":"Sculpting and brushes","a":"see-also","h":"See also","t":"Brush Lab and sharing brushes: design brushes with AI, the brush library and brush codes Masking: protect areas from every brush Polypaint and materials: Paint brush, Rgb and colour Sculpt layers and blend shapes: sculpt into a layer you can dial in and out Keyboard and mouse reference"},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"","h":"Brush Lab and sharing brushes","t":"Brush Lab designs sculpting brushes from a description: type \"dry cracked mud\" and an AI model builds the brush, then you refine it in words or with sliders. This chapter covers Brush Lab, the AI providers it can use, the recipe settings, your brush library, and the ways to share brushes: .sfbrush files, one-line brush codes, studio folders and the community gallery. Brush Lab with a brush designed from a description"},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"what-a-custom-brush-is","h":"What a custom brush is","t":"A custom brush is a recipe: about twenty named values that describe how the brush moves the surface, the shape of its tip, a surface pattern, stroke spacing and masking. A recipe is data, never code, so brushes are safe to download and share. The AI only fills in these values; you can see and change every one of them. Custom brushes work everywhere built-in brushes do: on the bottom shelf, in the brush picker (B), with Alt, Shift, masks, symmetry, strokes and alphas."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"open-brush-lab","h":"Open Brush Lab","t":"Click AI Brush on the top shelf, or AI Brush at the top of the Brush palette. Brush Lab is a floating window; it opens at the top-left corner of the canvas the first time, and you can drag it anywhere. Click the button again, or the window's close box, to hide it."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"design-a-brush","h":"Design a brush","t":"Open Brush Lab. Type a description in the field at the bottom, the way you'd describe the brush to another sculptor, for example bark of an old oak tree or soft folds in heavy cloth. Or click one of the starter ideas, such as Overlapping dragon scales or Dry cracked mud. Press Enter or click Create. While the model works, the conversation shows \"Designing brush\". When the brush is ready, it becomes the active brush and the status bar says so. Try it on the model. The model replies with the brush name in brackets and a sentence on what the brush does and what to try next. Errors (no connection, rate limits, a model that didn't return a recipe) appear in red in the same conversation."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"refine-a-brush-in-words","h":"Refine a brush in words","t":"With Refine the selected brush ticked, your next message changes the active custom brush instead of creating a new one: \"sharper\", \"less buildup\", \"make the scales smaller\". The model sees the current recipe and your conversation so far. Clear chat starts a new conversation."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"tune-a-brush-with-sliders","h":"Tune a brush with sliders","t":"Open the Recipe section of Brush Lab to see every value of the active custom brush. The same editor appears in the Brush palette as Edit recipe: NAME when a custom brush is active. Hover a slider for a description. Setting Range What it does Direction normal, inflate, view, stroke Which way the surface moves: out of the surface, outward in every direction, toward the camera, or along the stroke. Depth -1 to 1 Adds material (positive) or carves it away (negative). Plane none, clay, flatten, fill, scrape Planar behaviour: flat-topped clay layers, levelling, raising only low spots, or cutting only high spots. Plane amount 0 to 1 Strength of the plane behaviour. Pinch -1 to 1 Pulls the surface toward the stroke for crisp creases (negative spreads it apart). Drag 0 to 1 Smears the surface along the stroke, like a palette knife. Auto smooth 0 to 1 Relaxes the surface after each dab for softer, cleaner results. Hardness 0 to 1 Soft airbrush edge (0) to hard-edged stamp (1). Tip sharpness 0 to 1 Round, broad tip (0) to a narrow needle point (1). Pattern none, noise, scales, ridges, pores, cracks A surface texture stamped by the brush. Pattern size 0.03 to 2 Size of the pattern relative to the brush size. Pattern amount 0 to 1 How strongly the pattern shows. Spacing 0.02 to 2 Distance between dabs, relative to the brush size. Jitter 0 to 1 Random scatter of dabs around the stroke. Pressure curve 0.3 to 3 Tablet response: above 1 needs a firmer press, below 1 responds to a light touch. Front faces only on / off Only affects surfaces facing the camera, protecting thin parts. Cavity mask -1 to 1 Positive: only cavities. Negative: only ridges and peaks (as Edge Wear does). The name field at the top of the editor renames the brush when you press Enter. Tip: to adapt a built-in recipe such as Dragon Scales, select it and move the sliders. Your version is saved to your library and replaces the built-in one; delete it to get the original back."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"choose-an-ai-provider","h":"Choose an AI provider","t":"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. Provider What you need Notes Free - no account or key (default) Nothing An open model (GPT-OSS 20B) hosted by Pollinations.ai. Only your description and settings are sent. Rate limited to about one request every few seconds. If it can't be reached, a running local Ollama is used instead. Anthropic (Claude) - your key An Anthropic API key Uses claude-opus-5-5 by default. Effort (low, medium, high) trades speed for more considered brushes. OpenAI-compatible (OpenAI, Ollama, LM Studio...) An endpoint, a model name and, for hosted services, a key Any server that speaks the OpenAI chat completions API, including local models. For Anthropic and OpenAI-compatible providers you can edit the Endpoint, Model and API key fields. Leave the key empty to use the ANTHROPIC_API_KEY or OPENAI_API_KEY environment variable. Click Save settings to keep your choice; settings and keys are stored only on your computer, in ai.json in the SculptForge settings folder (readable only by you). Requests go only to the endpoint you set."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"run-a-model-on-your-own-computer","h":"Run a model on your own computer","t":"For private, offline use with no rate limits, run a local model with Ollama or LM Studio: Install Ollama and download the recommended model: ollama pull qwen3:4b-instruct (2.5 GB, works without a graphics card). In AI provider, choose OpenAI-compatible (OpenAI, Ollama, LM Studio...). Click Ollama (or LM Studio) to fill in the local endpoint. Click Find models. SculptForge checks the connection, shows \"Connected\" with the number of installed models, and lets you pick one from the Model list. Click Save settings. The Run a model on this computer section in the panel shows the install steps for your operating system. The model needs about 4 GB of free memory; expect 10-20 seconds per brush on a laptop CPU and a few seconds with a GPU. The full walkthrough for Windows, macOS, Linux and LM Studio is in docs/local-ai.md."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"your-brush-library","h":"Your brush library","t":"Every brush you create or refine in Brush Lab is saved to your brush library automatically, a moment after your last change (slider edits save when you release the slider). The library loads at every start, in the app, in sculptforge-cli and in the Python module, so your brushes are always there. The library is a folder of .sfbrush files in the SculptForge settings folder: System Brush library Linux ~/.local/share/SculptForge/SculptForge/brushes 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"},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"the-custom-brushes-list","h":"The Custom brushes list","t":"The Brush palette lists every custom brush under Custom brushes. A small tag after a name says where the brush comes from when it isn't simply yours or built in: Tag Meaning (none) A built-in brush, or a brush in your library yours Your version, which replaces a built-in or studio brush of the same name studio From a shared studio folder (read-only) gallery Installed from the community gallery (kept in your library) project Came with the open project and isn't in your library unsaved Made this session (for example picked from the picker's Library section, or loaded by a script) and not in your library Hover a brush for its description, origin and file. Right-click it for: Copy brush code: one line of text to share (see below). Save .sfbrush...: write the brush to a file. Rename...: rename it. Renaming a built-in or studio brush saves a renamed copy and keeps the original. Delete...: remove it from your library, after a confirmation. Only brushes in your own library can be deleted. If your brush replaced a built-in or studio brush, that one is used again. Reveal in folder: open the folder that holds its file. The same menu is available when you right-click a custom brush in the brush picker. When brushes share a name, your library wins over studio folders, and studio folders win over built-in brushes."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"brush-codes","h":"Brush codes","t":"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 brush code. Paste: copy a code, then press Ctrl+V over the viewport, click Paste brush in Brush Lab, or choose Edit > Paste brush. The brush is installed in your library and becomes active. Pasting also accepts the text of a .sfbrush file. Codes are validated like files: values outside their range are clamped, and anything that isn't a recipe is refused."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"brush-files-sfbrush","h":"Brush files (.sfbrush)","t":"A .sfbrush file is a small JSON file holding one recipe. Save: right-click the brush and choose Save .sfbrush..., or click Save .sfbrush... under the recipe sliders. Install: click Install .sfbrush... under the recipe sliders, or drop the file onto the SculptForge window. The brush goes into your library. Library folder: .sfbrush files in the Brushes folder of your LightBox library (Documents/SculptForge by default) appear in the Library section of the brush picker and in LightBox's Brush tab. Picking one loads it for the session. The file format and every key are documented in docs/brushes.md."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"studio-brush-folders","h":"Studio brush folders","t":"A studio can share brushes read-only from network folders. Set the environment variable SCULPTFORGE_BRUSH_PATH to one or more folders (separated by : on Linux and macOS, ; on Windows). Every .sfbrush file in them loads at start-up, tagged studio. Artists can't change or delete studio brushes; if they edit one, their own version is saved in their library under the same name. The Rez package adds the folder in SCULPTFORGE_STUDIO_BRUSHES to this path. See For studios. Projects (.sfproj) also store the brushes they use, so a scene opens with its brushes on any machine."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"the-community-gallery","h":"The community gallery","t":"The community gallery is a public collection of free (CC0) brushes shared by other sculptors. Click Community brushes at the top of the Brush palette. Search by name or description (scales, skin, stone...), or pick a tag from the All tags list. Click Install under a brush. It is downloaded, checked against its SHA-256 checksum, installed in your library and made active. Installed brushes show Installed. The Community brushes window The gallery is cached, so the window still opens offline (with a notice) showing the brushes from your last visit. Refresh fetches the latest list. Share yours opens the gallery's page on GitHub, where you can submit a brush you saved as .sfbrush with a pull request. You can also browse the gallery on the website at islandmed.github.io/SculptForge/brushes.html. Studios can mirror the gallery or run their own. Enter a URL or folder in the Gallery field at the bottom of the window and click Use, or set SCULPTFORGE_BRUSH_GALLERY (which then takes precedence and hides the field). See docs/brushes.md for the gallery format."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"brushes-from-scripts","h":"Brushes from scripts","t":"Every brush operation is also a command, for sculptforge-cli, the console, Python and AI agents: Command What it does brush_ai prompt=... Design a brush from a description (optional provider, endpoint, model). brush_create name=... depth=... Create or update a brush from recipe values. brush_list / brush_library List custom brushes (with their source and file, and the library folders). brush_save path=... Save a brush as .sfbrush (name defaults to the active brush). brush_load path=... Load a .sfbrush file for this session only. brush_install path=... / code=... / json=... Install a brush into your library and make it active. brush_code Print a brush as a brush code. brush_rename to=... / brush_delete name=... Rename or delete a brush. brush_gallery_search / brush_gallery_install name=... Search and install from the community gallery. # Design a brush for free and save it for the team sculptforge-cli -c 'brush_ai prompt=\"weathered stone edges\"; brush_save path=stone.sfbrush' # Install a gallery brush and try it on a sphere sculptforge-cli -c 'brush_gallery_install name=\"Snake Scales\"; new_sphere subdivisions=6; stroke points=\"-0.5,0,0 0.5,0.2,0\"' See Scripting and automation for running commands."},{"p":"brush-lab.html","c":"Brush Lab and sharing brushes","a":"see-also","h":"See also","t":"Sculpting and brushes: built-in brushes, strokes, alphas and pressure For studios: shared brush folders and pipelines Troubleshooting: AI provider errors and rate limits"},{"p":"masking.html","c":"Masking","a":"","h":"Masking","t":"A mask protects part of the model from change. Masked areas are drawn darker, and every brush, the Paint brush and colour fills leave them alone. This chapter covers painting masks with Ctrl, the background gestures, and the Tool > Masking controls for inverting, blurring, growing and building masks from cavities or polygroups. A mask painted on the lion's mane, with the Masking sub-palette"},{"p":"masking.html","c":"Masking","a":"how-masks-work","h":"How masks work","t":"A mask is a value per vertex from 0 (free) to 1 (fully masked). Values in between give partial protection, so a soft mask edge blends sculpting into the protected area. Masks belong to a SubTool: each SubTool has its own mask. Masks are saved in projects (.sfproj) and in .GoZ files, so they survive a round trip to ZBrush. Masking is not a layer and isn't affected by sculpt layers: a mask stroke always works on the model itself. Mask strokes and mask commands are undoable like any other change. To see the mask, keep Mask on in the right shelf (it is on by default). The same toggle is Show mask in Tool > Masking, and Show Mask in the Render palette. Turning it off hides the darkening; the mask still protects the surface."},{"p":"masking.html","c":"Masking","a":"paint-a-mask","h":"Paint a mask","t":"Hold Ctrl and drag on the model. The area under the brush becomes masked. Hold Ctrl+Alt and drag to erase the mask. Mask strokes use the current Draw Size, symmetry and, with a pen, pressure (when Pressure > Strength is on). How much each stroke masks is set by Mask Strength in Tool > Masking (0.01 to 1, default 1): lower values build up a soft, partial mask over several strokes. Mask strokes always use a round tip, whatever alpha you have selected, and a DragRect stroke masks with dabs along the path instead of one stamp. On macOS, Cmd works wherever this guide says Ctrl. ZBrush: this is ZBrush's Ctrl-masking with the MaskPen behaviour. Selecting a different masking brush (MaskLasso, MaskRect, MaskCurve) is not available yet."},{"p":"masking.html","c":"Masking","a":"background-gestures","h":"Background gestures","t":"With Ctrl held, clicks and drags on the empty background act on the whole mask: Gesture Effect Ctrl + click the background Invert the mask Ctrl + drag on the background Clear the mask Ctrl + drag on the background, with nothing masked Zoom the view A drag starts after the cursor moves a few pixels, so a slightly shaky click still inverts."},{"p":"masking.html","c":"Masking","a":"the-masking-sub-palette","h":"The Masking sub-palette","t":"Open Tool > Masking (the Tool palette is in the right tray by default). Every button is one undo step. Control What it does Command Show mask Darken masked areas in the viewport. Mask Strength How much each mask stroke masks (0.01 to 1), and the mask value By cavity gives the deepest cavities. Clear Unmask everything. mask_clear Invert Masked becomes free and free becomes masked. mask_invert All Mask every visible vertex. mask_all Blur Soften the mask edges by averaging with neighbouring vertices. mask_blur Sharpen Tighten soft edges, pushing values toward fully masked or free. mask_sharpen Grow Expand the masked region by one ring of edges per pass. mask_grow Shrink Contract the masked region by one ring of edges per pass. mask_shrink passes How many times Blur, Sharpen, Grow and Shrink run (1 to 20 here, default 1). iterations= By cavity Mask concave areas (creases, folds, pores), replacing the current mask. mask_by_cavity threshold How concave a spot must be for By cavity (-0.2 to 0.5, default 0.02). 0 masks anything concave; higher values keep only deep creases. threshold= By polygroup Mask one polygroup, replacing the current mask. The number field next to it is the polygroup id. mask_by_polygroup Mask operations only change visible parts of the model; hidden parts keep their mask. Clear is the exception and frees everything."},{"p":"masking.html","c":"Masking","a":"protect-detail-while-smoothing","h":"Protect detail while smoothing","t":"Click By cavity to mask the creases and pores. Smooth with Shift. The cavities keep their sharpness while the surface between them relaxes. Ctrl + drag on the background to clear the mask when you're done. Raise threshold if too much is masked; lower Mask Strength for partial protection."},{"p":"masking.html","c":"Masking","a":"sculpt-one-part-only","h":"Sculpt one part only","t":"Paint a mask over the part you want to work on with Ctrl. Ctrl + click the background to invert it. Now everything except that part is protected. Sculpt freely; strokes that cross the edge stop at the mask."},{"p":"masking.html","c":"Masking","a":"mask-a-whole-polygroup","h":"Mask a whole polygroup","t":"The quickest way works without knowing the group's number: Ctrl+Shift + click the group to isolate it (see Polygroups and visibility). Click All: only visible vertices are masked. Ctrl+Shift + click the background to show everything again. The mask stays. By polygroup masks a group by its id. The viewport doesn't show ids, but the console does: isolate the group, then open the console (`) and read the isolate_polygroup group=N line. Enter that number in the field next to By polygroup and click it."},{"p":"masking.html","c":"Masking","a":"a-soft-edged-mask","h":"A soft-edged mask","t":"Paint the mask, then click Blur a few times (or set passes to 3-5 first). Sharpen does the opposite."},{"p":"masking.html","c":"Masking","a":"turn-a-mask-into-a-polygroup","h":"Turn a mask into a polygroup","t":"Click From mask in Tool > Polygroups: the masked triangles become a new polygroup. See Polygroups and visibility."},{"p":"masking.html","c":"Masking","a":"masks-and-painting","h":"Masks and painting","t":"Polypaint respects the mask too: the Paint brush, Rgb strokes and Fill leave masked areas alone, so you can mask an area and fill the rest with a colour. See Polypaint and materials."},{"p":"masking.html","c":"Masking","a":"masking-from-a-script","h":"Masking from a script","t":"Command Options mask_clear, mask_all, mask_invert mask_blur, mask_sharpen, mask_grow, mask_shrink iterations (1-100, default 1) mask_by_cavity strength (0-1, default 1), threshold (-1 to 1, default 0.02) mask_by_polygroup group (required), add=true to add to the current mask instead of replacing it sculptforge-cli -c 'open path=head.obj; mask_by_cavity threshold=0.05; mask_blur iterations=2; save_project path=head.sfproj' Not yet: masking by topology, by normals or by alpha, Mask By Smoothness, and lasso, rectangle or curve mask selections are not available yet."},{"p":"masking.html","c":"Masking","a":"see-also","h":"See also","t":"Polygroups and visibility: groups, isolating and hiding parts Sculpting and brushes: modifier keys and brush settings Polypaint and materials: fills that respect the mask"},{"p":"polygroups.html","c":"Polygroups and visibility","a":"","h":"Polygroups and visibility","t":"Polygroups divide a SubTool's surface into named regions, shown as flat colours when you turn them on. You use them to hide and isolate parts of a model so you can reach what you want to sculpt, to build masks, and to split a model into SubTools. This chapter covers creating polygroups, the Ctrl+Shift visibility gestures and the Tool > Polygroups and Tool > Visibility controls. Polygroups shown as colours, with the Polygroups sub-palette"},{"p":"polygroups.html","c":"Polygroups and visibility","a":"show-polygroups","h":"Show polygroups","t":"Click Groups in the right shelf to colour each polygroup of the active SubTool. The same toggle is Show polygroups in Tool > Polygroups and Show Polygroups in the Render palette. The grouping buttons turn the colours on for you, so you see the result straight away. The number next to Show polygroups is how many polygroups are visible right now. A mesh without polygroups is one group. Polygroups come from: the grouping buttons below; OBJ files: each g group becomes a polygroup, as ZBrush writes them (SculptForge also writes polygroups as g groups when it exports OBJ); .GoZ files from ZBrush and SculptForge projects, which keep polygroups."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"create-polygroups","h":"Create polygroups","t":"Open Tool > Polygroups. Grouping works on the visible part of the SubTool only; hidden parts keep their groups. So you can isolate one part and regroup just that part. Control What it does Command By normals A new group wherever the surface turns more than the angle next to it (1 to 90 degrees, default 30). Each flat side of a box becomes its own group. polygroup_auto_by_normals By pieces One group per disconnected piece, such as separate eyes or buttons in one mesh. polygroup_by_connectivity From mask Masked triangles move into a new group. polygroup_from_mask Merge visible Everything visible becomes one group. polygroup_merge_visible Clear groups Remove all polygroups; the whole SubTool becomes one group again. polygroup_clear Each button is one undo step. ZBrush: By normals is Auto Groups / Groups By Normals, By pieces is Auto Groups on a mesh with separate parts, From mask is Group Masked (Ctrl+W in ZBrush; it has no shortcut here, but you can assign one), and Merge visible is Group Visible."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"group-a-region-you-painted","h":"Group a region you painted","t":"Paint a mask over the region with Ctrl (see Masking). Click From mask in Tool > Polygroups. Ctrl + drag on the background to clear the mask."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"hide-and-show-parts","h":"Hide and show parts","t":"Visibility is the main reason to have polygroups: hide what is in the way, sculpt what's left, then show everything again. Hidden parts can't be sculpted, painted or masked, so hiding also protects them. All of the gestures use Ctrl+Shift in the viewport (Cmd+Shift on macOS): Gesture Effect Ctrl+Shift + click a polygroup Isolate it: show only that group. Ctrl+Shift + click the isolated group again Invert the visibility: show everything else instead. Ctrl+Shift+Alt + click a polygroup Hide that group. Ctrl+Shift + click the background Show everything. Ctrl+Shift + drag a rectangle Keep what's inside the rectangle, hide the rest. The rectangle is drawn green. Ctrl+Shift+Alt + drag a rectangle Hide what's inside the rectangle. The rectangle is drawn red. The rectangle works in screen space: a triangle counts as inside when its centre falls inside the rectangle as you see it, including triangles on the far side of the model. You can press or release Alt while dragging; what counts is whether it is held when you let go. SculptForge refuses a change that would hide everything, as ZBrush does. Every visibility change is one undo step, so Ctrl+Z brings back what you just hid. ZBrush: the gestures are the same as ZBrush's SelectRect with polygroups. SelectLasso, Grow and Shrink visibility and hiding by clicking with the rectangle brush are not available yet."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"the-visibility-sub-palette","h":"The Visibility sub-palette","t":"Open Tool > Visibility: Control What it does Command Show all Show every hidden part again. Available when something is hidden. show_all Invert visible Hide what is visible and show what is hidden. invert_visibility Delete hidden Permanently remove the hidden triangles from the mesh. Undoable. delete_hidden Delete hidden keeps every attribute of what remains (mask, polypaint, polygroups, UVs and sculpt layers). Use it to cut away parts of a scan or a generated model, or to remove the inside of a mesh after you isolated the outside."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"work-on-one-part-of-a-character","h":"Work on one part of a character","t":"Click By pieces (for a mesh made of separate parts) or By normals. Ctrl+Shift + click the part you want, for example the head. Sculpt. The rest of the body is hidden and can't be touched. Ctrl+Shift + click the background to show everything."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"clean-up-a-scan-or-a-generated-model","h":"Clean up a scan or a generated model","t":"Turn the model so the unwanted piece is on screen. Ctrl+Shift+Alt + drag a rectangle over it to hide it. Click Delete hidden in Tool > Visibility."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"split-a-model-into-subtools","h":"Split a model into SubTools","t":"Group the model, then click Split groups in Tool > SubTool: each polygroup becomes its own SubTool. Split parts does the same by disconnected piece. See SubTools."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"polygroups-and-other-tools","h":"Polygroups and other tools","t":"Masking: By polygroup in Tool > Masking masks one group (see Masking). Brushes and polypaint skip hidden faces. Projects save polygroups and what's hidden; GoZ and OBJ carry polygroups to and from ZBrush. Each SubTool has its own polygroups and visibility. To show and hide whole SubTools, use the eye icons and Solo in Tool > SubTool."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"polygroups-from-a-script","h":"Polygroups from a script","t":"Command Options polygroup_auto_by_normals angle (1-180 degrees, default 30) polygroup_by_connectivity, polygroup_from_mask, polygroup_merge_visible, polygroup_clear isolate_polygroup, hide_polygroup group (required): the polygroup id show_all, invert_visibility, delete_hidden hide_rect x0 y0 x1 y1 (-1 to 1, y up), inside, optional view_proj matrix; without a view the rectangle spans the mesh seen from the front When you isolate or hide a group in the viewport, the console (`) shows the command with the group's id, for example isolate_polygroup group=3, which you can reuse in scripts. sculptforge-cli -c 'open path=robot.obj; polygroup_by_connectivity; subtool_split_groups; save_project path=robot.sfproj' Not yet: a polygroup paint brush, Group Front, polygroups from UV islands or PolyPaint, and polygroup-based crease edges are not available yet."},{"p":"polygroups.html","c":"Polygroups and visibility","a":"see-also","h":"See also","t":"Masking: build masks from polygroups and polygroups from masks SubTools: split by groups, show, hide and solo whole SubTools Keyboard and mouse reference"},{"p":"subtools.html","c":"SubTools","a":"","h":"SubTools","t":"A scene in SculptForge can hold several separate meshes, called SubTools, just as in ZBrush: a body, eyes, teeth, a helmet and a sword can each live in their own SubTool. This chapter covers the SubTool list, selecting, adding, hiding, reordering, merging and splitting SubTools, and how they travel through files."},{"p":"subtools.html","c":"SubTools","a":"how-subtools-work","h":"How SubTools work","t":"Only the active SubTool is sculpted, painted, masked or changed by a command. The others are drawn slightly darker and greyer so you can see which one you are working on. Each SubTool keeps its own mesh, mask, polypaint, polygroups, hidden faces, UVs and sculpt layers. Each SubTool has its own undo history. Ctrl+Z undoes the last change in the active SubTool, and switching SubTools doesn't lose the history of the others. Adding, deleting, reordering, merging and splitting SubTools are not undoable, as in ZBrush. Merges and deletes ask for confirmation first. The title strip shows the active SubTool and its place in the list, for example SubTool Helmet (2/5). ZBrush: SubTools work the way you expect: one active SubTool, the rest dimmed, Alt+click in the viewport to switch. There is no folder grouping of SubTools yet."},{"p":"subtools.html","c":"SubTools","a":"the-subtool-list","h":"The SubTool list","t":"The list is in Tool > SubTool, which is open in the right tray by default. The SubTool sub-palette with several SubTools, the active one highlighted Each row shows the SubTool's name, its triangle count and an eye. To Do this Select a SubTool Click its row, or Alt+click it in the viewport Rename it Double-click the row (or right-click > Rename), type, press Enter Hide or show it Click the eye at the end of the row Duplicate or delete it Right-click the row > Duplicate or Delete... See its vertex and triangle counts Point at the row for a moment The list shows six rows and scrolls when there are more. Names are kept unique: renaming a SubTool to a name that is already taken adds a number. Selecting a hidden SubTool shows it again, because you can't sculpt what you can't see."},{"p":"subtools.html","c":"SubTools","a":"select-a-subtool-in-the-viewport","h":"Select a SubTool in the viewport","t":"Hold Alt and click another SubTool on the canvas. It becomes the active one and the list scrolls to it. Alt+click only selects when you click a SubTool other than the active one and release without moving. If you drag instead, Alt keeps its usual meaning: an inverted stroke on the active SubTool, or a pan when you start off the model."},{"p":"subtools.html","c":"SubTools","a":"add-a-subtool","h":"Add a SubTool","t":"Click Append and choose: Sphere, Cube or Plane: a new primitive placed beside the visible model (to the right, on +X), sized to about a third of the largest visible SubTool. From file...: a model (.obj, .fbx, .glb, .gltf, .ply, .stl, .GoZ, .usda, .usd, .usdz) or a project (.sfproj). A file with several objects adds one SubTool per object. The new SubTool becomes the active one. You can also add files as SubTools from elsewhere: Import in the Tool palette header (or File > Import) adds a model file as a new SubTool. In the LightBox Tool tab, Shift+double-click a model, or right-click it and choose Append as SubTool. Tip: Duplicate copies the active SubTool with its layers and attributes, names it copy and puts it right under the original. Use it to keep a safe copy before a destructive step such as a remesh."},{"p":"subtools.html","c":"SubTools","a":"show-hide-and-solo","h":"Show, hide and solo","t":"The eye on each row shows or hides that SubTool. Solo shows only the active SubTool. Click it again to bring the others back. The Solo button on the right shelf does the same. Unhide all shows every SubTool. Hidden SubTools aren't drawn, can't be selected with Alt+click, and are left out of exports. Note: SubTool visibility is different from hiding part of a mesh with polygroups or a rectangle. That hides faces inside one SubTool; see Polygroups and visibility."},{"p":"subtools.html","c":"SubTools","a":"reorder-subtools","h":"Reorder SubTools","t":"The up and down arrow buttons under the list move the active SubTool one place up or down. The order matters for Merge down and is the order objects are written to files."},{"p":"subtools.html","c":"SubTools","a":"merge-subtools","h":"Merge SubTools","t":"Merge down... merges the active SubTool with the one below it. Merge visible... merges every visible SubTool into one new SubTool called Merged. Hidden SubTools stay as they are. Merging keeps every attribute, gives each original mesh its own polygroups (so you can split them again later) and matches sculpt layers by name. The merged SubTool starts with an empty undo history. Tip: Merge first when you want one voxel remesh to fuse several pieces into a single watertight surface."},{"p":"subtools.html","c":"SubTools","a":"split-a-subtool","h":"Split a SubTool","t":"Split groups makes one SubTool per polygroup. It is available when the active SubTool has more than one polygroup. Split parts makes one SubTool per disconnected piece, largest first. Both replace the active SubTool with the pieces. Because a merge keeps each original mesh in its own polygroup, Split groups undoes a merge."},{"p":"subtools.html","c":"SubTools","a":"delete-a-subtool","h":"Delete a SubTool","t":"Click Delete... (or right-click a row > Delete...) and confirm. The last SubTool can't be deleted, and a delete can't be undone."},{"p":"subtools.html","c":"SubTools","a":"subtools-in-files","h":"SubTools in files","t":"Format What happens to SubTools Project (.sfproj) Every SubTool is saved with its name, visibility, attributes, layers and active layer OBJ Each visible SubTool is an o object; on import, o objects become SubTools and g groups become polygroups glTF / GLB One node and mesh per visible SubTool, both ways FBX One model per visible SubTool (with LODs, an LOD group each), both ways USD One Mesh prim per visible SubTool, both ways GoZ Each visible SubTool is sent to ZBrush as its own SubTool PLY, STL, splat conversion The visible SubTools are merged into one mesh Opening a multi-object file replaces the scene with one SubTool per object. See Exporting for the details of each format."},{"p":"subtools.html","c":"SubTools","a":"scripting","h":"Scripting","t":"Every SubTool action is a command, so you can use them in the console, scripts, Python and MCP agents. SubTools are addressed by index (0 is the top of the list) or name; without either, the active one is used. Command What it does subtool_list List the SubTools subtool_select index=1 Make a SubTool active subtool_append type=cube Add a primitive (sphere, cube, plane); path= adds a file; size= (0.05-2, default 0.35) subtool_duplicate Copy a SubTool subtool_delete name=Helmet Delete a SubTool subtool_rename to=Body Rename a SubTool subtool_visibility visible=false Show or hide (toggles when visible is left out) subtool_solo / subtool_show_all Solo the active SubTool / show every SubTool subtool_move direction=up Move a SubTool up or down the list subtool_merge_down / subtool_merge_visible Merge subtool_split_groups / subtool_split_parts Split subtool_append type=sphere name=EyeL size=0.12; subtool_duplicate; subtool_rename to=EyeR"},{"p":"subtools.html","c":"SubTools","a":"see-also","h":"See also","t":"Polygroups and visibility: hide parts of one SubTool Sculpt layers and blend shapes: layers belong to each SubTool Exporting: how SubTools reach other applications Projects, autosave and QuickSave"},{"p":"polypaint.html","c":"Polypaint and materials","a":"","h":"Polypaint and materials","t":"Polypaint stores a colour on every vertex of the mesh, so you can paint a sculpt without UVs or textures, as in ZBrush. This chapter covers the Paint brush, painting while you sculpt, fills and cavity paint, picking colours, and the MatCap materials that change how the model is shaded in the viewport."},{"p":"polypaint.html","c":"Polypaint and materials","a":"how-polypaint-works","h":"How polypaint works","t":"Colour is stored per vertex. The detail you can paint is limited by how dense the mesh is: on a light mesh, colour edges look soft. Subdivide or remesh at a higher resolution before fine painting. Painting respects the mask (masked areas keep their colour) and skips hidden faces. Symmetry works for painting as it does for sculpting. Polypaint is per SubTool and is saved in projects. It is exported as vertex colours to PLY, glTF/GLB, OBJ, USD (displayColor) and GoZ. FBX export doesn't include it. A mesh starts without polypaint. The first paint stroke or fill adds it (white everywhere you haven't painted). Not yet: texture painting on UVs, layers of paint, and baking polypaint to a texture map. See the roadmap."},{"p":"polypaint.html","c":"Polypaint and materials","a":"paint-with-the-paint-brush","h":"Paint with the Paint brush","t":"Press P, click Paint on the top shelf, or pick Paint on the bottom shelf. Choose a colour (see below). Stroke over the model. Draw Size, Strength, the stroke type and the alpha work as they do for sculpting. While the Paint brush is active: Alt paints back towards white. Shift still smooths the shape, as in ZBrush. The surface isn't changed. Press P again, or click Sculpt on the top shelf, to go back to sculpting. Polypaint on a sculpt with the Color palette open 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."},{"p":"polypaint.html","c":"Polypaint and materials","a":"paint-while-sculpting","h":"Paint while sculpting","t":"Turn on Rgb on the top shelf (or RGB while sculpting in the Color palette). Every sculpt brush then also paints the current colour along its stroke. The Smooth brush and Shift-smoothing never paint."},{"p":"polypaint.html","c":"Polypaint and materials","a":"choose-a-colour","h":"Choose a colour","t":"The left shelf has a colour picker (a square plus a hue strip), two swatches and a Fill button. Clicking the second swatch swaps it with the main colour, like ZBrush's Alternate. The Color palette has a larger hue wheel with a hex value, ten preset swatches (white, near black, red, orange, yellow, green, blue, purple, skin and brown) and the fill buttons. Press C with the cursor over the model to pick the colour under it (the mesh needs polypaint for this)."},{"p":"polypaint.html","c":"Polypaint and materials","a":"fill-cavity-paint-and-clear","h":"Fill, cavity paint and clear","t":"The Color palette has four buttons: Button What it does Fill Fills the unmasked area with the colour (the whole mesh when nothing is masked). Same as Fill on the left shelf Fill masked Fills only the masked area. Available when the mesh has a mask Cavity Darkens the creases and cavities with a dark brown, respecting the mask. A quick way to bring out detail Clear Removes all polypaint from the active SubTool All of them are undoable. Show polypaint in the same palette (or Paint on the right shelf) turns the colours off in the viewport without deleting them. Tip: To paint a base colour and then dirt in the creases: Fill with the base colour, then Cavity. For a different cavity colour or strength, use the command (below)."},{"p":"polypaint.html","c":"Polypaint and materials","a":"materials-matcaps","h":"Materials (MatCaps)","t":"Materials change only how the model is shaded in the viewport. They aren't exported and don't change polypaint. Material Look Sculpt The default, made for sculpting: neutral warm clay under a strong key light from the upper left, a crisp highlight and deep cavity shading, so small strokes and undulations stay readable Red Wax Glossy deep red wax, the classic sculpting look Clay Matte grey-brown clay Skin Warm, soft skin tones 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 To choose one: Press M for the material picker under the cursor, or click the Material tile on the left shelf. Point at a material to preview it on the model, click to keep it. Esc or clicking away puts the previous material back. Open the Material palette, or the Material tab of the LightBox. The material picker with the seven MatCaps and Studio Polypaint multiplies the material, and cavity shading stays on with every material (strongest with Sculpt). The material is saved with the project: projects saved with Studio open with Studio. Tip: Sculpt is the material to judge strokes with. The prettier ones (Skin, Red Wax) soften small detail; switch to them for presenting. Not yet: loading your own MatCap images, and physically based materials or BPR-style renders."},{"p":"polypaint.html","c":"Polypaint and materials","a":"scripting","h":"Scripting","t":"Command What it does set_color color=#c08060 Set the paint colour: rrggbb, #rrggbb (quote it in scripts), r,g,b or a name such as white, skin, bone paint_fill area=unmasked Fill; area is unmasked (default), masked or all; strength 0-1 paint_from_cavity color=#202020 strength=0.7 smoothing=2 Cavity paint (defaults: dark brown, 0.7, 2 blur passes) paint_clear Remove all polypaint set_material name=Chrome Viewport material: a MatCap name (Sculpt is the default) or studio (desktop app only) set_color color=\"#d9b38c\"; paint_fill; paint_from_cavity strength=0.5"},{"p":"polypaint.html","c":"Polypaint and materials","a":"see-also","h":"See also","t":"Masking: protect areas from painting Sculpting and brushes: Draw Size, Strength, strokes and alphas also apply to painting Exporting: which formats carry vertex colours"},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"","h":"Sculpt layers and blend shapes","t":"Sculpt layers hold changes on top of the base mesh, each with its own weight: a smile, a blink, a corrective shape or a variation you want to dial in and out. Because a layer is a set of per-vertex offsets, it exports straight to game engines and DCC tools as a blend shape (morph target). This chapter covers creating, sculpting into, weighting, playing and exporting layers."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"how-layers-work","h":"How layers work","t":"Each layer stores how far every vertex moves from the base. The shape you see is the base plus every layer times its weight. New strokes go into the active layer, or into the base mesh when Base mesh is selected. Layers belong to a SubTool: each SubTool has its own list of layers. A weight of 0 turns a layer off, 1 shows it as sculpted. Scripts can also set negative weights or weights above 1 to exaggerate a shape. Layers survive subdividing, decimating and LOD chains. A voxel remesh bakes them into the surface (the layers are gone afterwards). Note: Sculpt layers are not the Layer brush. The Layer brush raises the surface to a fixed height; sculpt layers are the blend-shape stack described here."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"the-layers-sub-palette","h":"The Layers sub-palette","t":"Open Tool > Layers in the right tray. The Layers sub-palette with a base mesh and two blend shapes From top to bottom: Base mesh: select it to sculpt the base shape. One block per layer: a radio button with the layer's name (select it to sculpt into that layer), Play, X (delete) and a weight slider from 0 to 1. A name field and + Add at the bottom. The title strip shows the active layer (Layer Smile, or Layer Base)."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"add-a-layer-and-sculpt-into-it","h":"Add a layer and sculpt into it","t":"Type a name in the field at the bottom of Tool > Layers, for example Smile or BlinkL. Click + Add (or press Enter in the field). The new layer becomes the active one. Sculpt. Every stroke goes into the layer until you select another layer or Base mesh. A layer whose weight is 0 can't be sculpted into: SculptForge tells you to raise the weight first. Tip: Name layers the way your engine or rig expects (jawOpen, BlinkL): the names become the blend shape and morph target names in exported files."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"adjust-and-preview-weights","h":"Adjust and preview weights","t":"Drag a layer's weight slider to blend it in and out. Play animates the layer from 0 to 1 and back, over and over, so you can judge the motion. Click Stop to end it; the weight returns to 1. Starting a stroke also stops playback. Weights are saved with the project and used by exports that keep weights (USD writes the current weights)."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"delete-a-layer","h":"Delete a layer","t":"Click X next to the layer. Its offsets are removed from the mesh and the base mesh becomes the active target. Deleting a layer is undoable."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"export-blend-shapes","h":"Export blend shapes","t":"Format What layers become glTF / GLB (File > Export GLB..., Ctrl+E) Morph targets FBX Blend shapes USD / USDZ UsdSkel blend shapes, with their current weights Send to Unreal / Export FBX for Unreal A skeletal mesh with morph targets LOD chain Blend shapes are kept on every LOD Project (.sfproj) Everything: layers, weights and the active layer OBJ, PLY, STL The current blended shape only Importing works the other way: glTF morph targets and FBX or USD blend shapes open as sculpt layers. See Exporting. ZBrush: Layers here are close to ZBrush's sculpt layers with the slider used as a morph. There is no record/eye toggle per layer, no layer folders and no per-layer mask yet."},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"scripting","h":"Scripting","t":"Command What it does layer_add name=Smile Add a layer and make it active layer_set_active index=0 Choose the layer strokes go into (-1 = base mesh) layer_set_weight index=0 weight=0.5 Set a layer's weight (negative or above 1 exaggerates) layer_remove index=0 Delete a layer Layers are addressed by index, starting at 0 for the top layer. layer_add name=jawOpen; stroke points=\"0,-0.3,1 0,-0.5,1\" brush=Inflate; export_glb path=head.glb"},{"p":"layers.html","c":"Sculpt layers and blend shapes","a":"see-also","h":"See also","t":"SubTools Subdivide, remesh, decimate and LODs Exporting: glTF morph targets, FBX blend shapes, Send to Unreal"},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"","h":"Subdivide, remesh, decimate and LODs","t":"These tools change the topology of the active SubTool: add resolution for detail, rebuild an even surface, reduce the triangle count, or make a chain of levels of detail for a game engine. This chapter explains what each one does to your mesh and its attributes, and when to use it. All of them work on the active SubTool and, except the LOD preview, are undoable with Ctrl+Z."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"at-a-glance","h":"At a glance","t":"Tool Where Triangles Keeps sculpt layers Keeps mask and polypaint Keeps polygroups, hidden faces, UVs Subdivide Tool > Geometry > Subdivide, Ctrl+D x4 per level Yes Yes (interpolated) Yes Voxel Remesh Tool > Remesh > Voxel Remesh Set by resolution Baked in Yes (transferred) No (reset) Decimate Tool > Geometry > Decimate Reduced Yes Yes Yes LOD chain Tool > Export One level per ratio step Yes, on every level Yes Yes"},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"subdivide","h":"Subdivide","t":"Tool > Geometry > Subdivide (Ctrl+D) smooths the mesh with Loop subdivision. Each level multiplies the triangle count by four and rounds off the shape slightly, like ZBrush's Divide with Smt on. Sculpt layers are subdivided with the mesh, so blend shapes keep working. Mask, polypaint and UVs are interpolated; polygroups and hidden faces carry over. SculptForge refuses to subdivide past 50 million triangles. Not yet: multiresolution sculpting. Subdivide replaces the mesh with a denser one; there are no subdivision levels to step down to (ZBrush's SDiv, D / Shift+D) and no reconstruct. Use undo or a duplicate SubTool to keep the lighter version. Multiresolution and dynamic topology are on the roadmap. Tip: The title strip shows the vertex and triangle counts of the whole scene. A few million triangles sculpt smoothly on a recent GPU; go up a level only when you need finer detail."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"voxel-remesh","h":"Voxel remesh","t":"Tool > Remesh > Voxel Remesh rebuilds the active SubTool as an even, watertight surface, like ZBrush's DynaMesh. Use it to: fuse overlapping pieces into one surface (append a sphere, overlap it, merge, remesh); even out stretched triangles after heavy Move or Snake Hook work; clean up scans, splat conversions and AI-generated models before sculpting. The Resolution slider next to the button sets how many voxels span the longest side of the model (64 to 400 in the palette, default 200). Higher keeps more detail and makes more triangles. Wireframe of a model before and after a voxel remesh What happens to your data: Sculpt layers are baked into the surface: the result has no layers. Mask and polypaint are transferred from the nearest original vertex. Polygroups, hidden faces and UVs are reset (everything becomes visible, one polygroup, no UVs). Hidden parts are remeshed too. Separate pieces that don't touch stay separate pieces; overlapping ones are merged. To remesh several SubTools into one, first combine them with Merge visible... or Merge down... in SubTools. ZBrush: There is no Project option, Groups-aware remesh or Blur slider yet, and the remesh produces triangles, not quads. For quad retopology (ZRemesher) see the roadmap: it is not available yet."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"decimate","h":"Decimate","t":"Tool > Geometry > Decimate reduces the triangle count while keeping the shape, using quadric edge collapse (the same family of algorithm as ZBrush's Decimation Master). The Keep slider next to the button sets the fraction of triangles to keep (0.05 to 0.95, default 0.50). Decimation keeps open borders in place, and because it only removes vertices, every remaining vertex keeps its exact sculpt layer offsets, mask and polypaint. Polygroups, hidden flags and UVs survive on the remaining triangles. Use it to make a lighter version of a finished sculpt for export, 3D printing or a review, or to bring a dense scan down to something you can work with. Tip: Decimate a duplicate SubTool (Tool > SubTool > Duplicate) when you want to keep the full-resolution sculpt in the same project."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"lod-chains","h":"LOD chains","t":"A level-of-detail chain is a series of lighter copies of the model for game engines: LOD0 is the full sculpt, and each level after it has a fixed fraction of the triangles of the one before. Open Tool > Export. Set LODs (2 to 6 levels, including LOD0) and Reduction (the triangle ratio from one level to the next, 0.1 to 0.9, default 0.50). Click Generate LOD chain. The Export sub-palette with a generated LOD chain A table lists each level with its triangle count and its budget as a percentage of LOD0. Click a level to preview it on the canvas (wireframe turns on and sculpting pauses); click Sculpt in the table to go back to the editable mesh. The next stroke, or a change to LODs or Reduction, clears the chain; click Generate LOD chain again to rebuild it. Blend shapes (sculpt layers) are kept on every level, so morph targets work at every LOD. To write the chain to disk: LOD chain (GLB per level) in the same sub-palette, or File > Export LOD Chain..., writes one GLB per level named _LOD0.glb, _LOD1.glb and so on. Send to Unreal and Export FBX for Unreal... pack the LODs into one FBX for Unreal's automatic LOD import. See Exporting for these exports and their options. Note: The preview in Tool > Export is of the active SubTool. The exports themselves build a chain for every visible SubTool."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"undo-and-safety","h":"Undo and safety","t":"Subdivide, remesh, decimate and delete hidden are single undo steps on the active SubTool. They can use a lot of memory on dense meshes, and undo keeps a full copy of the previous mesh for each of them. Before a big change on a heavy sculpt: QuickSave (title strip) keeps a timestamped copy of the scene without touching your project file; see Projects. Duplicate the SubTool to keep the old version side by side."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"scripting","h":"Scripting","t":"Command Options subdivide levels 1-4 (default 1) remesh resolution 32-512 voxels across the longest side (default 200) decimate ratio 0.01-1 of the triangles to keep (default 0.5), or triangles for an exact target export_lods path (base name), levels 1-8 including LOD0 (default 4), ratio 0.1-0.9 (default 0.5) sculptforge-cli -c 'open path=scan.obj; remesh resolution=256; decimate triangles=200000; export_lods path=out/rock.glb levels=4 ratio=0.5' The command line accepts a wider remesh range (32-512) than the palette slider."},{"p":"geometry.html","c":"Subdivide, remesh, decimate and LODs","a":"see-also","h":"See also","t":"SubTools: merge pieces before a remesh, duplicate before a decimate Sculpt layers and blend shapes Exporting: LOD chains, FBX for Unreal, Send to Unreal Image and text to 3D: generated models are voxel-remeshed for sculpting"},{"p":"generate-3d.html","c":"Image and text to 3D","a":"","h":"Image and text to 3D","t":"SculptForge can turn a picture or a written description into a full 3D model that you can sculpt straight away. This chapter covers the Generate 3D window, the services it can use (free Hugging Face models, your own ComfyUI server, paid fal.ai or Meshy, your own command line, or an offline blockout) and the offline image tools: relief, inflate and stamp. The Generate 3D window with a sketch loaded and the Hugging Face service selected"},{"p":"generate-3d.html","c":"Image and text to 3D","a":"how-it-works","h":"How it works","t":"You give SculptForge an image (a sketch, concept art, a photo of a figurine) or a short description. The service you picked reconstructs a complete mesh: front, back, limbs and all. SculptForge opens the result as a new scene and, unless you turn it off, voxel-remeshes it into one even, watertight surface, so the brushes behave the same as on any other sculpt. Nothing leaves your computer until you choose a hosted service and press Generate 3D model. For exactly what is sent where, see AI services and privacy below. ZBrush: ZBrush has no built-in image-to-3D. The closest workflow is blocking out a base mesh by hand with DynaMesh or ZSpheres; here you get a starting shape in seconds and refine it with the usual brushes."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"open-the-generate-3d-window","h":"Open the Generate 3D window","t":"Any of these opens it: Drop an image file (PNG, JPG, BMP, TGA, PSD or GIF) onto the SculptForge window. The image is loaded as the picture for the From image tab and the window opens. Open the Generate palette and click Generate 3D. Press F3, type generate and press Enter. The window has two tabs, From image and From text. Warning: A generated model replaces the current scene without asking, and arrives as a new, untitled scene. Save your work (Ctrl+S) before you generate."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"generate-from-an-image","h":"Generate from an image","t":"On the From image tab, click Choose image... (or drop a file onto the window). A preview and the image size appear. Pick a service in the drop-down under Full 3D model (AI reconstruction). The default is Hugging Face free models. Set the service's options (model, token or key, see below). Leave Remesh for sculpting on and set its Resolution (96 to 400, default 256). Higher keeps more detail and makes more triangles. Click Generate 3D model. A progress bar shows the queue position and progress; Cancel stops the job. When it finishes, the status line reports the triangle count before and after remeshing, for example \"Generated model imported (412000 tris, remeshed to 180000) - ready to sculpt\"."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"pictures-that-work-well","h":"Pictures that work well","t":"One character or object per image. A plain or transparent background. SculptForge crops the subject out of a transparent background, centres it on a square and scales it to at most 1024 pixels before sending it. The whole subject in frame, seen from the front or a three-quarter view. A clean concept turnaround pose works better than a busy illustration with scenery."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"generate-from-text","h":"Generate from text","t":"On the From text tab, type one object into the box, for example \"a stylised dragon head with curled horns\" or \"a cartoon fox sitting\". Pick Hugging Face - free models, fal.ai, Meshy or ComfyUI - your server. Text to 3D does not work with My generator command or Offline blockout. Click Generate 3D model. Which model runs depends on the service: Service Text-to-3D model Hugging Face Hunyuan3D 2 mini Turbo (Tencent), or Hunyuan3D 2 if you chose it in Model. Any other choice uses Turbo fal.ai Hunyuan3D 3.1 Rapid (Tencent) Meshy Meshy's own text-to-3D model ComfyUI The text workflow you choose (the bundled text-to-3d uses FLUX.1 schnell and Hunyuan3D 2.1)"},{"p":"generate-3d.html","c":"Image and text to 3D","a":"services","h":"Services","t":"Service Cost and setup Good for Hugging Face - free models Free, no account. A free token raises the daily allowance Trying things out, personal work fal.ai - paid, your key Paid per generation, needs a fal.ai key Reliable capacity, newer models Meshy - paid, your key Paid, needs a Meshy key Meshy's own models ComfyUI - your server Free, runs on your own GPU or a studio server Privacy, custom workflows, studios My generator command Free, any program you run locally Your own model or a studio service Offline blockout (inflate silhouette) Free and instant, no network Simple shapes, a quick start"},{"p":"generate-3d.html","c":"Image and text to 3D","a":"hugging-face-free","h":"Hugging Face (free)","t":"This runs each model author's own public demo on Hugging Face's shared ZeroGPU hardware. Pick a Model: Model Notes Hunyuan3D 2.1 (Tencent) The default. Detailed shapes, about 20 seconds TRELLIS.2 (Microsoft) The most detail. Needs a Hugging Face token Hunyuan3D 2 mini Turbo (Tencent) The fastest, about 6 seconds Hunyuan3D 2 (Tencent) Stable Fast 3D (Stability AI) Quick and simple, removes the background itself 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 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. Warning: The Hunyuan3D models are under the Tencent Hunyuan Community License, which does not cover use in the European Union, the United Kingdom or South Korea. If you work there, choose TRELLIS.2, Stable Fast 3D or a paid service. Each model has its own licence; read it before using results commercially."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"falai-and-meshy-paid","h":"fal.ai and Meshy (paid)","t":"fal.ai: choose a Model (TRELLIS.2, Hunyuan3D 3.1 Pro, Hunyuan3D 3.1 Rapid or Meshy 6) or type any fal model id into Model id. Paste your key from fal.ai/dashboard/keys into API key, or set FAL_KEY. Meshy: paste your key from meshy.ai (API settings) into API key, or set MESHY_API_KEY. Generations are billed to your account with that service. Errors such as \"The API key was rejected\", \"Out of credits on this account\" or \"Rate limited\" come from the service."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"comfyui-your-own-server","h":"ComfyUI (your own server)","t":"Runs any ComfyUI workflow on your own computer or a studio GPU server, with whatever models it has. Nothing is sent anywhere else. Start ComfyUI. It listens on http://127.0.0.1:8188 by default. If SculptForge runs on another computer, start ComfyUI with --listen (only on a network you trust: ComfyUI has no login). Install the models your workflow needs. The bundled Hunyuan3D 2.1 workflow needs hunyuan_3d_v2.1.safetensors in ComfyUI/models/checkpoints. In Generate 3D, pick ComfyUI - your server, enter the Server address and click Test connection. A good answer looks like \"Connected: ComfyUI 0.42.0 - NVIDIA GeForce RTX 4090 (24.0 GB)\". Choose a Workflow: a bundled one, or Other file (API format)... for your own. Click Generate 3D model. The progress bar shows your place in ComfyUI's queue. Bundled workflows: Workflow Tab Needs hunyuan3d-image-to-3d From image The Hunyuan3D 2.1 checkpoint (7.4 GB) and a GPU with about 10 GB of memory text-to-3d From text FLUX.1 schnell, BiRefNet and Hunyuan3D 2.1 (about 25 GB of downloads) and a GPU sculptforge-inflate From image The ComfyUI-SculptForge node pack; no GPU. A quick blockout to check your setup Your own workflows must be saved in ComfyUI's API format (in ComfyUI: Workflow > Export (API)). To tell SculptForge where the inputs go, give nodes these titles: Node title What SculptForge does sf_image Puts the uploaded picture into this Load Image node. Without one, the first Load Image node is used sf_prompt Puts your description into this node's text, prompt or string input. Without one, the first CLIP Text Encode not titled \"negative\" is used sf_seed Sets the seed. Inputs named seed or noise_seed get it too SculptForge imports the first mesh file the workflow saves (Save GLB, Preview 3D and most 3D node packs work). For error messages and their fixes, see Troubleshooting."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"my-generator-command","h":"My generator command","t":"Runs any command line on your computer: a local open-source model, a studio service, or a script that calls a cloud API. Type the command into the box. It must contain {input} (replaced with the image path) and {output} (replaced with the path to write, ending in .glb). Both are quoted for you, so don't add quotes. The command must write a GLB file to {output} and exit with status 0. The box starts with a command that runs SculptForge's own silhouette inflation, which is a quick way to check that the pipeline works: sculptforge-cli --set input={input} --set output={output} -c 'image_inflate path=$input subdivisions=2; export_glb path=$output' A wrapper for your own model can be as small as this: # my_generator.py {input} {output} import sys image_path, output_path = sys.argv[1], sys.argv[2] # load your model, run it on image_path, write a .glb to output_path Keep API keys in environment variables that your script reads, not in the command line."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"offline-blockout","h":"Offline blockout","t":"Offline blockout (inflate silhouette) inflates the outline of the picture into a rounded, closed mesh. It is instant and needs no network, but it is a puffy blockout, not a reconstruction: fine for simple shapes, not for characters."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"save-your-settings","h":"Save your settings","t":"Save settings (the small button under Generate 3D model) stores the service, model, keys, token, ComfyUI address and generator command in your ai.json settings file, so they are set the next time you start SculptForge. Keys in ai.json are readable only by your user account. See where settings live."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"quick-shapes-from-an-image-offline","h":"Quick shapes from an image (offline)","t":"The From image tab also has three offline tools under Quick shapes (offline). They need no network and run instantly. The same tools are in the Generate palette as Relief, Inflate and Stamp. Tool What it makes Settings Silhouette blockout > Inflate A rounded, closed base mesh from the outline. Replaces the scene Thickness (0.2 to 2, lower is flatter), Detail (64 to 384) Relief > Make relief A height-field relief: light areas rise. For logos, coins, emblems, height maps and texture photos. Replaces the scene Depth (0.01 to 0.5 of the width), Detail (64 to 1024), Dark is high Stamp onto model > Stamp from this view Projects the image onto the current model from the current view as surface detail, into the active sculpt layer Depth (0.001 to 0.1 of the model size), Dark is high Tip: Stamp writes into the active sculpt layer, so add a layer first (Tool > Layers) if you want to dial the detail in and out afterwards. See Layers and blend shapes."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"after-generating","h":"After generating","t":"Generated meshes are a starting point. A typical next pass: Check the size of the remeshed result in the title strip (Verts, Tris). If the detail is too soft, generate again with a higher Resolution, or run Tool > Remesh > Voxel Remesh at a higher value on the result. Turn on X symmetry if the subject is symmetrical, and sculpt the forms with Clay Buildup, Move and Dam Standard (Sculpting and brushes). Save a project (Ctrl+S): generated scenes start untitled."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"from-scripts-and-agents","h":"From scripts and agents","t":"The same services are available as commands, in the console, sculptforge-cli, Python and MCP agents: # free (Hunyuan3D 2.1 on Hugging Face) sculptforge-cli -c 'image_to_3d path=hero.png; export_glb path=hero.glb' # TRELLIS.2 with a Hugging Face token HF_TOKEN=hf_... sculptforge-cli -c 'image_to_3d path=hero.png model=trellis-2; export_glb path=hero.glb' # fal.ai, keeping the raw (not remeshed) result FAL_KEY=... sculptforge-cli -c 'image_to_3d path=hero.png service=fal model=fal-ai/trellis-2 remesh=false; export_glb path=hero.glb' # text to 3D on your own ComfyUI, repeatable with a seed sculptforge-cli -c 'text_to_3d prompt=\"a carved stone owl\" service=comfyui url=http://gpu-box:8188 seed=42; export_usd path=owl.usdz' # is the ComfyUI server up? sculptforge-cli -c 'comfyui_check' # offline tools sculptforge-cli -c 'image_relief path=logo.png depth=0.08; export_stl path=logo.stl' sculptforge-cli -c 'image_inflate path=sketch.png thickness=0.7; save_project path=blockout.sfproj' Command Key parameters image_to_3d path (required), service (huggingface, fal, meshy, comfyui, command, inflate), model, workflow, url, seed, remesh (default true), resolution (64 to 512, default 256) text_to_3d prompt (required), service (huggingface, fal, meshy, comfyui), model, workflow, url, seed, remesh, resolution image_relief path (required), depth (default 0.12), resolution (default 384), invert image_inflate path (required), thickness (default 1), resolution (default 160), subdivisions (default 1) image_project path (required), depth (default 0.03), invert. Projects from the front (+Z) comfyui_check url Without service=, commands use the settings you saved in the app. See Scripting and automation."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"privacy-and-model-licences","h":"Privacy and model licences","t":"SculptForge has no servers of its own and no telemetry. A hosted service receives only the prepared image (or your text) and your key or token, if any. The free Hugging Face option runs the model authors' own demos; SculptForge does not host or bundle any model. Each model has its own licence: TRELLIS.2 is MIT; Hunyuan3D models use the Tencent Hunyuan Community License (not for use in the EU, UK or South Korea); Stable Fast 3D uses the Stability AI Community License (free under US $1M annual revenue). Read the licence before commercial use. With ComfyUI, the picture goes only to the server address you entered. The full table of what is sent where is in docs/ai-services.md in the SculptForge repository."},{"p":"generate-3d.html","c":"Image and text to 3D","a":"see-also","h":"See also","t":"Sculpting and brushes: refine the generated model Subdivide, Remesh, Decimate and LODs: voxel remesh in detail Gaussian splats: start from a phone capture instead of a picture Scripting and automation: batch generation from the command line Troubleshooting: quota and connection messages"},{"p":"splats.html","c":"Gaussian splats","a":"","h":"Gaussian splats","t":"Gaussian splats are the format behind phone and photogrammetry captures from apps such as Polycam, Luma, Postshot, Scaniverse and KIRI. SculptForge uses them three ways: as a reference to sculpt against, as a source for a watertight base mesh, 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"},{"p":"splats.html","c":"Gaussian splats","a":"supported-files","h":"Supported files","t":"Format Open Save PLY (standard 3D Gaussian Splatting layout, spherical harmonics up to degree 3) Yes Yes .splat (compact web-viewer format) Yes Yes glTF / GLB with KHR_gaussian_splatting Yes Yes OpenUSD .usda / .usdz with a ParticleField3DGaussianSplat prim Yes Yes A PLY file can hold either a mesh or splats; SculptForge tells them apart by their contents."},{"p":"splats.html","c":"Gaussian splats","a":"load-a-capture-as-a-reference","h":"Load a capture as a reference","t":"Open the capture with File > Open... (Ctrl+O), drop it onto the window, or double-click it in the LightBox Splats tab. The splats load next to your sculpt: the current mesh stays, and the capture is drawn around it as a reference. The Splats palette moves into the right tray by itself, and a Splats button appears on the right shelf to show or hide the capture. Most captures arrive upside down, off-centre and at an arbitrary scale. Use the buttons in the Splats palette to place them: Button What it does Flip Turns the capture upside down (180 degrees about X). Most captures need this Turn 90 Turns it 90 degrees about the vertical axis Fit Centres it at the origin and scales it to the size of a new sphere Clean floaters Removes faint splats and stray outliers around the subject The palette also shows the number of splats and their spherical-harmonic degree (for example \"1250000 splats (SH 3)\"), and has: Show and Show mesh to show or hide the capture and the sculpt. An opacity slider (0.05 to 1) to see the sculpt through the capture. Tip: To sculpt a character over a scan, lower the opacity to about 0.4, turn on X symmetry and block in the forms on a sphere or a converted mesh with Clay Buildup and Move."},{"p":"splats.html","c":"Gaussian splats","a":"convert-a-capture-into-a-mesh","h":"Convert a capture into a mesh","t":"Convert to mesh builds a watertight, sculptable mesh from the capture: Trim the capture so only the subject remains: Clean floaters, and place it with Flip and Fit. Set the resolution slider next to Convert to mesh (64 to 400, default 192). Higher keeps more detail. Click Convert to mesh. The result replaces the sculpt; the splats stay as a reference, so you can compare. The conversion is one undo step (Ctrl+Z brings the old sculpt back). The converter keeps the largest solid piece, seals small holes and smooths the surface. It gives a clean base mesh for sculpting, not a textured scan: colour is not carried over."},{"p":"splats.html","c":"Gaussian splats","a":"turn-a-sculpt-into-splats","h":"Turn a sculpt into splats","t":"Sculpt to splats (in the Splats palette when no splats are loaded, or from the command palette) covers the visible SubTools with flat, oriented splats with soft clay shading baked in. Use it to show a sculpt in splat viewers, web scenes or engines that render 3D Gaussian splats. It replaces any loaded splats. From a script you can choose the number of splats and whether to bake shading: sculptforge-cli -c 'open path=bust.glb; mesh_to_splats count=500000 shading=true; splat_save path=bust.ply'"},{"p":"splats.html","c":"Gaussian splats","a":"save-splats","h":"Save splats","t":"Click Save splats... in the Splats palette, or File > Save Splats.... Choose the format by the file type: PLY (for SuperSplat, Postshot and most tools), glTF (.glb with KHR_gaussian_splatting) or OpenUSD (.usda / .usdz). The splat_save command also writes .splat. Placement you made with Flip, Turn 90 and Fit is kept exactly in glTF and USD. PLY has no placement, so it is baked into the splats; if the capture was rotated, view-dependent colour (spherical harmonics above degree 0) is dropped from the PLY, because it would point the wrong way. When you export USD (File > Export USD / USDZ...) with splats loaded, they are included in the same file as a ParticleField3DGaussianSplat prim next to the meshes. Projects (.sfproj) keep loaded splats and their placement. Clear in the Splats palette removes the capture."},{"p":"splats.html","c":"Gaussian splats","a":"from-scripts","h":"From scripts","t":"Command What it does Key parameters open Loads a capture as a reference next to the sculpt path splat_info Reports the loaded splats splat_transform Rotates and places the capture rotate_x, rotate_y, rotate_z (degrees), fit, reset splat_clean Removes faint splats and floaters min_opacity (default 0.05), keep (0.5 to 1, default 0.98) splat_to_mesh Builds a watertight mesh resolution (32 to 512, default 192), min_opacity (default 0.25), keep (default 0.97), close (0 to 8, default 2), smooth (0 to 50, default 6) mesh_to_splats Turns the visible SubTools into splats count (default 250000), shading (default true) splat_save Saves .ply, .splat, .glb, .usda or .usdz path splat_clear Removes the splats A complete phone-capture-to-base-mesh pipeline: sculptforge-cli -c 'open path=scan.ply; splat_transform rotate_x=180 fit=true; splat_clean; splat_to_mesh resolution=256; export_glb path=base.glb' To render only the splats headless, use sculptforge scan.ply --render scan.png --hide-mesh (see Scripting and automation)."},{"p":"splats.html","c":"Gaussian splats","a":"see-also","h":"See also","t":"Image and text to 3D: another way to get a base mesh Subdivide, Remesh, Decimate and LODs: clean up a converted mesh Exporting: USD and glTF exports that carry splats"},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"","h":"Exporting, Unreal and ZBrush","t":"This chapter covers getting your sculpt out of SculptForge: the export formats and what each one keeps, LOD chains for games, sending a mesh straight into a running Unreal Editor, and exchanging models with ZBrush through GoZ. To keep everything (SubTools, layers, mask, polypaint, brushes) use a project file instead; see Projects, autosave and QuickSave."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"export-formats-at-a-glance","h":"Export formats at a glance","t":"Exports write every visible SubTool. Hidden SubTools are left out. Exporting doesn't rename the document or mark it saved, so your next Ctrl+S still saves the project. Format Where in the app Keeps Use it for glTF binary (.glb) File > Export GLB... (Ctrl+E) One node per SubTool, sculpt layers as morph targets, polypaint as vertex colour Games, Blender, three.js, web viewers LOD chain (.glb per level) File > Export LOD Chain... As GLB, one file per level, blend shapes on every level Game engines OpenUSD (.usda, .usdz) File > Export USD / USDZ... One Mesh prim per SubTool, layers as UsdSkel blend shapes, polypaint as displayColor, loaded splats Film pipelines, Omniverse, Apple AR Quick Look FBX for Unreal (.fbx) File > Export FBX for Unreal... Unreal naming and scale, LOD group, layers as blend shapes Unreal Engine (by hand) Wavefront OBJ (.obj) File > Export OBJ... One o object per SubTool, polygroups as g groups, polypaint as vertex colour. Layers are baked into the current blend Any 3D app, ZBrush ZBrush GoZ (.GoZ) File > ZBrush (GoZ) > Export GoZ... Polygroups, mask, polypaint, UVs, quads that came from ZBrush ZBrush STL (.stl) File > ZBrush (GoZ) > Export STL... Geometry only, visible SubTools merged 3D printing PLY (.ply) export_ply command Geometry and polypaint, visible SubTools merged Scan tools, MeshLab, Blender FBX (general) export_fbx command One model per SubTool, blend shapes, optional LOD groups Other FBX pipelines The GLB, LOD chain and FBX for Unreal exports are also in the Tool palette under Export, together with the LOD and Unreal settings. The Tool > Export sub-palette with a generated LOD chain and the Unreal Engine settings Not yet: SculptForge has no UV unwrapping, so exported meshes carry no UVs unless they came in with them (GoZ and project files keep imported UVs). Texture baking (normal and displacement maps) is also on the roadmap. Engines that need lightmap UVs can generate them on import."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"scale-and-axes","h":"Scale and axes","t":"glTF, USD and OBJ are written Y-up with 1 unit = 1 metre, the same space you sculpt in. FBX uses centimetres: export_fbx multiplies positions by 100 by default (scale=), so 1 unit = 1 m. STL and PLY keep positions as they are (no unit conversion). For Unreal, Height sets the real-world size directly (see below)."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"export-a-model","h":"Export a model","t":"Show the SubTools you want to export and hide the others (the eye icon in Tool > SubTool). Choose the export in the File palette and pick a file name. The status line confirms the export (\"Exported ...\"). From a script, each format is one command: sculptforge-cli -c 'open path=bust.sfproj; export_glb path=bust.glb' sculptforge-cli -c 'open path=bust.sfproj; export_usd path=bust.usdz' sculptforge-cli -c 'open path=bust.sfproj; save_obj path=bust.obj' sculptforge-cli -c 'open path=bust.sfproj; export_fbx path=bust.fbx lods=3 ratio=0.5' sculptforge-cli -c 'open path=bust.sfproj; export_stl path=bust.stl; export_ply path=bust.ply'"},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"lod-chains-for-games","h":"LOD chains for games","t":"A LOD (level of detail) chain is the same model at decreasing triangle counts, so an engine can draw distant objects cheaply. SculptForge builds it with quadric decimation, keeping blend shapes on every level. Open Tool > Export. Set LODs (2 to 6 levels, including LOD0) and Reduction (0.1 to 0.9: the triangle ratio from one level to the next, default 0.5). Click Generate LOD chain. A table lists each level with its triangle count and its share of LOD0. Click a level (LOD0, LOD1 ...) to inspect it in the viewport; the wireframe turns on. Click Sculpt to go back to the editable mesh. Export with LOD chain (GLB per level), or send it to Unreal (below). Changing the sliders clears the preview; click Generate LOD chain to build it again. The LOD chain export writes _LOD0.glb, _LOD1.glb and so on next to the path you choose. With several visible SubTools, each SubTool is decimated on its own. sculptforge-cli -c 'open path=rock.obj; export_lods path=out/rock.glb levels=4 ratio=0.5' To reduce the sculpt itself instead of exporting copies, use Tool > Geometry > Decimate; see Subdivide, Remesh, Decimate and LODs."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"send-to-unreal","h":"Send to Unreal","t":"Send to Unreal exports an Unreal-ready FBX and imports it into a running Unreal Editor (5.x) on this computer or another one on your network. Nothing is installed into your project: it uses Unreal's built-in Python remote execution. Your sculpt What arrives in Unreal No sculpt layers A static mesh SM_ with the LOD chain from Tool > Export Sculpt layers A skeletal mesh SK_ with one morph target per layer (Unreal adds a single root bone) Several visible SubTools One FBX model per SubTool, combined into one asset on import Any A material slot M_Clay, and the real-world size from Height Sending the same asset again updates it in place (same name and folder), so references in your levels stay intact."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"one-time-setup-in-unreal","h":"One-time setup in Unreal","t":"Edit > Plugins: enable Python Editor Script Plugin, then restart the editor. Edit > Project Settings > Plugins > Python: tick Enable Remote Execution?. That's all when Unreal runs on the same computer."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"send","h":"Send","t":"Open Tool > Export and find the Unreal Engine section. Set Folder (the content folder, default /Game/SculptForge) and Height (the model's height in Unreal, in centimetres; it starts at the model's current height with 1 unit = 1 m). For a static mesh, set LODs and Reduction above (default 4 levels). Click Send to Unreal, or press Ctrl+U. The status line reports the result. The line under the buttons tells you what will be sent: \"Static mesh with 4 LODs\" or \"Skeletal mesh with 2 morph targets\"."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"unreal-on-another-computer","h":"Unreal on another computer","t":"On the Unreal machine, in Project Settings > Plugins > Python, open Advanced and set Multicast Time-To-Live to 1 and Multicast Bind Address to 0.0.0.0. In SculptForge, tick Unreal is on another computer. Both computers must be on the same network, and the SculptForge computer's firewall must allow incoming connections from the Unreal machine: the editor connects back to SculptForge to fetch the file."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"import-by-hand","h":"Import by hand","t":"Export FBX for Unreal... (in the File palette and in Tool > Export) writes the same file. The file name becomes the asset name. Drag it into the Content Browser: static meshes pick up their LODs from the file's LOD group; for skeletal meshes choose Skeletal Mesh and tick Import Morph Targets."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"from-scripts","h":"From scripts","t":"sculptforge-cli -c 'open path=statue.obj; unreal_send destination=/Game/Props height_cm=200 lods=4' sculptforge-cli -c 'unreal_editors network=true' # list editors on the network sculptforge-cli -c 'open path=statue.obj; export_unreal folder=out height_cm=200' unreal_send also takes name=, project= (pick one editor when several are open) and network=true. Note: Layered sculpts are sent as skeletal meshes without the LOD chain, because Unreal's morph targets need a skeletal mesh (Unreal can generate skeletal LODs itself). The Unreal link has been tested against a stand-in editor that speaks the same protocol but not yet against every Unreal version. If an import fails, Unreal's Output Log shows the importer's messages."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"exchange-models-with-zbrush-goz","h":"Exchange models with ZBrush (GoZ)","t":"SculptForge reads and writes ZBrush's GoZ format and can talk to a running ZBrush through the GoZ bridge on Windows and macOS. The commands are in File > ZBrush (GoZ): Item What it does Send to ZBrush Writes every visible SubTool to the shared GoZ folder and tells ZBrush (starting it if needed). Each SubTool arrives as its own ZBrush SubTool. Turns on Receive automatically Receive from ZBrush Loads what ZBrush last sent with GoZ. Each object updates the SubTool it was sent from (one undo step), or becomes a new SubTool Receive automatically Checks once a second for a new GoZ send from ZBrush and receives it Custom GoZ folder Use another GoZ folder, for example inside a Wine prefix Import GoZ... Opens a .GoZ file, replacing the scene Export GoZ... Writes a .GoZ file. With several visible SubTools, one file per SubTool next to the path Export STL... Writes a binary STL of the visible SubTools The default GoZ folder is C:\\Users\\Public\\Pixologic on Windows and /Users/Shared/Pixologic on macOS. ZBrush doesn't run on Linux, so there the bridge needs a custom folder; GoZ files still import and export."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"a-round-trip","h":"A round trip","t":"In SculptForge, choose File > ZBrush (GoZ) > Send to ZBrush. ZBrush starts or comes forward with the SubTools. If ZBrush was not running and does not import them, press GoZ in ZBrush. Work in ZBrush, then press GoZ there to send the model back. SculptForge receives it automatically and updates the matching SubTools. Each update is an undo step on that SubTool. GoZ keeps polygroups, mask, polypaint and UVs. Quads from ZBrush are split into triangle pairs for sculpting and rebuilt into quads when you send the mesh back. GoZ has no hidden-face flag, so hidden faces are sent like any others. ZBrush: SculptForge cannot open ZBrush's own .ZTL and .ZPR files (they are proprietary and undocumented). Bring models over with GoZ, or export OBJ or FBX from ZBrush. Subdivision levels don't come across: SculptForge receives the mesh at the level you sent. Note: The GoZ bridge follows the format of the open-source Blender GoZ add-on (GoB) and is tested with files, but has not yet been tested against a live ZBrush. If a send does not arrive, export a .GoZ file and import it in ZBrush by hand, and please report it (Help > Report a problem). From scripts: goz_export path=, goz_import path=, goz_send, goz_receive and export_stl path=."},{"p":"exporting.html","c":"Exporting, Unreal and ZBrush","a":"see-also","h":"See also","t":"Projects, autosave and QuickSave: save everything, not just the mesh SubTools: which SubTools are exported Layers and blend shapes: what becomes morph targets Subdivide, Remesh, Decimate and LODs: decimate before exporting Gaussian splats: saving splats For studios: formats in a pipeline"},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"","h":"Projects, autosave and QuickSave","t":"A SculptForge project (.sfproj) saves your whole scene in one file, so you can close the app and carry on exactly where you stopped. This chapter covers saving and opening projects, the unsaved-changes prompt, recent files, autosave and crash recovery, QuickSave, and the LightBox tabs that show your work."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"what-a-project-keeps","h":"What a project keeps","t":"A .sfproj file holds everything SculptForge knows about the scene: every SubTool, with its name, visibility, mesh, mask, polypaint, polygroups, hidden faces and UVs; every sculpt layer with its weight, and the active layer of each SubTool; loaded Gaussian splats and their placement; your custom brushes, so a project opened on another computer still has them; the camera, the material and display settings, the brush, Draw Size, Strength, paint colour and symmetry; a thumbnail, shown in the LightBox. Undo history isn't saved: an opened project starts with a clean history. Model formats such as OBJ, GLB or FBX can't hold all of this (masks, hidden faces, splats, brushes), so writing them is an export, not a save. See Exporting. ZBrush: A .sfproj is the equivalent of a ZBrush project (.ZPR), and saving a single SubTool scene is close to saving a .ZTL. SculptForge can't read .ZPR or .ZTL files: bring models over with GoZ or as OBJ, FBX or GLB."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"save-a-project","h":"Save a project","t":"File > Save (Ctrl+S) saves to the current project. The first time, it asks for a file name. File > Save As... (Ctrl+Shift+S) saves under a new name. Clicking the document name in the title strip also saves. The title strip shows the document name with * after it while there are unsaved changes, and the window title starts with *. Any edit in any SubTool counts, as do splat edits and layer weight changes. If you opened a model file (an OBJ, say) rather than a project, Save asks where to save a new .sfproj; the original model file is left alone."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"open-a-project-or-model","h":"Open a project or model","t":"File > Open... (Ctrl+O) opens a project, a model or a splat capture. Opening a project or model replaces the scene. File > Open Recent lists the last 10 files you opened or saved. Files that no longer exist are dropped from the list. Clear Recent empties it. Drop a file onto the window to open it. In the LightBox, double-click a project or model. File > New Sphere (Ctrl+N) and File > New Plane start a fresh scene. When you open a project, its saved camera, material and brush settings come back too."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"the-unsaved-changes-prompt","h":"The unsaved-changes prompt","t":"When the scene has unsaved changes, New Sphere, New Plane, Open..., Open Recent, dropping a model or project, Quit (Ctrl+Q) and closing the window first ask: Save saves the project (asking for a name if it has none), then carries on; Don't Save discards the changes and carries on; Cancel goes back to your work. Dropping an image or a .sfbrush file never asks, because it doesn't replace the scene."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"autosave-and-crash-recovery","h":"Autosave and crash recovery","t":"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). The recovery copy is autosave.sfproj in the SculptForge settings folder (see Troubleshooting for where that is on your system). It is deleted once your work is saved or you discard the changes. If SculptForge didn't close normally (a crash or power cut), the next start asks Restore Autosave?: Restore opens the autosaved scene as an untitled, unsaved document. Save it to keep it. Discard deletes the recovery copy. The autosave also appears first in the LightBox QuickSave tab while it exists. Note: Autosave is a safety net, not a substitute for saving. It keeps only the latest copy and is removed as soon as you save."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"quicksave","h":"QuickSave","t":"QuickSave in the title strip saves a timestamped copy of the whole scene, like ZBrush's QuickSave. Your project file, its name and its unsaved state are not changed, so QuickSave is safe to press before any risky step. Copies go to the QuickSave folder of your library (by default Documents/SculptForge/QuickSave), named like QuickSave 2026-10-21 23-15-04.sfproj. The last 10 QuickSaves are kept; older ones are deleted. They appear in the LightBox QuickSave tab, newest first, labelled with their date and time. Double-click one to open it. The tab also has a Save now button. QuickSave has no default shortcut. To give it one, hold Ctrl+Alt, click the QuickSave button and press a key (see The interface)."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"your-library-folder-and-the-lightbox","h":"Your library folder and the LightBox","t":"SculptForge keeps a library folder for your work, by default SculptForge in your Documents folder. It is created on first use with these sub-folders: Folder LightBox tab What goes there Projects Project Your .sfproj files Tools Tool Models to open or append as SubTools Brushes Brush .sfbrush files Alphas Alpha Grayscale images for brush alphas Images Image Sketches and concept art for Generate 3D Splats Splats Gaussian splat captures QuickSave QuickSave QuickSave copies Change it in Preferences > LightBox > Library folder, then Store Config (Ctrl+Shift+I) to keep the setting. Press , (comma) to show the LightBox. The tabs that matter for projects: Project: the projects in your Projects folder, plus any recent project saved elsewhere. Each shows the thumbnail saved with it. QuickSave: the autosave (when there is one) and your QuickSaves, newest first. Recent: everything in Open Recent, of every kind. Double-click a tile to open it (you are asked about unsaved changes first). In the Tool tab, Shift+double-click a model to append it as a SubTool instead. The LightBox showing project thumbnails"},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"scripting","h":"Scripting","t":"Command What it does save_project path=work/dragon.sfproj Save the project (without path, to the current project) open_project path=work/dragon.sfproj Open a project (open also recognises .sfproj) open path=scan.obj Open a model, splat capture or project new_sphere subdivisions=6 / new_plane resolution=128 Start a new scene Projects saved by sculptforge-cli or Python open in the app too. For the file layout, see docs/project-format.md."},{"p":"projects.html","c":"Projects, autosave and QuickSave","a":"see-also","h":"See also","t":"The interface: LightBox, shortcuts and Store Config SubTools Exporting: formats for other applications Troubleshooting: where settings and the autosave live"},{"p":"scripting.html","c":"Scripting and automation","a":"","h":"Scripting and automation","t":"Every operation in SculptForge is a named command with parameters. The same commands run from the console inside the app, from script files, from the sculptforge-cli tool on a build farm, from Python, and from AI agents through the Model Context Protocol (MCP). This chapter explains the script language, the console, both command-line programs, the Python module and MCP setup. ZBrush: The console plays the role of ZBrush's ZScript window, and Copy session as script is a macro recorder. The language is much simpler than ZScript: one command per statement, with named parameters."},{"p":"scripting.html","c":"Scripting and automation","a":"the-script-language","h":"The script language","t":"A script is a list of statements. Each statement is a command name followed by name=value parameters: new_sphere subdivisions=5 subdivide levels=1 remesh resolution=256; decimate ratio=0.5 # two statements on one line export_glb path=\"My Sculpts/bust.glb\" The rules: Statements are separated by new lines or by ;. # starts a comment that runs to the end of the line (outside quotes). Parameters are name=value with no spaces around =. true and false are booleans; numbers are numbers; anything else is text. Put text in double quotes when it contains spaces, ;, # or \", or when it must stay text even though it looks like a number. Inside quotes only \\\" and \\\\ are escapes, so Windows paths such as \"C:\\Users\\me\\head.obj\" work as written. Colours with a # must be quoted: set_color color=\"#d9a07a\". Paths are UTF-8. Relative paths are relative to the current folder of the program running the script. Scripts stop at the first command that fails."},{"p":"scripting.html","c":"Scripting and automation","a":"the-console","h":"The console","t":"Press the backtick key (left of 1), or choose 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 Every command you run appears in the console as a script line, whether it came from a button, a shortcut, the command palette or the console itself, followed by its result. Failures show in red with the reason. Type a statement and press Enter to run it. Several statements separated by ; run in order and stop at the first failure. Tab completes command names, then parameter names. Press Tab again to list the candidates. Up and Down walk through the last 200 lines you typed. The history is kept between sessions. help (or ?) lists every command; help remesh explains one command and its parameters. clear empties the log. The console buttons (also in the Script palette): Button What it does Run script file... Runs a text file of statements (.sfscript or .txt), stopping at the first failure Copy session as script Puts every command run this session on the clipboard as a script you can save and run again Clear console Empties the log. The session script is kept Tip: To record a macro, work normally, then click Copy session as script, paste it into a text file and edit out what you don't need. Run it later with Run script file... or sculptforge-cli -f."},{"p":"scripting.html","c":"Scripting and automation","a":"the-command-palette","h":"The command palette","t":"Press F3 (or Ctrl+Shift+P, or click Search in the title strip) to search every command, brush and setting by name. Enter runs the highlighted entry; Shift+Enter opens it in the console so you can add parameters first. Commands that need parameters always open in the console. With an empty search, the palette lists what you used recently. See The interface. The command palette searching for a command Tip: Hold Ctrl+Alt and point at a button to see the scripting parameters of the command behind it."},{"p":"scripting.html","c":"Scripting and automation","a":"commonly-used-commands","h":"Commonly used commands","t":"sculptforge-cli --list (or help in the console) prints every command with all its parameters. These are the ones you will use most: Area Command Key parameters Scene new_sphere subdivisions (0 to 8, default 6) Scene new_plane resolution (cells per side, default 128) Files open path: models, projects, splats, GoZ Files save_project path (default: the current project) Files open_project path Geometry subdivide levels (1 to 4, default 1) Geometry remesh resolution (32 to 512, default 200) Geometry decimate ratio (default 0.5) or triangles Geometry mesh_info Sculpting stroke points (required), brush, radius, strength, invert, symmetry Brushes brush_set_alpha name (round, square, noise) or path, invert Brushes brush_ai prompt (required), provider, model, endpoint Brushes brush_install path, code or json Brushes brush_save path (required), name Layers layer_add name Layers layer_set_weight index, weight (both required) Masking mask_by_cavity strength, threshold Masking mask_invert, mask_clear, mask_blur, mask_grow iterations where it applies Polygroups polygroup_auto_by_normals angle (default 30) Visibility isolate_polygroup, hide_polygroup group (required) Visibility show_all, delete_hidden SubTools subtool_append type (sphere, cube, plane) or path, name, size SubTools subtool_select index or name Polypaint set_color, paint_fill color, area (unmasked, masked, all) Polypaint paint_from_cavity color, strength, smoothing AI image_to_3d path (required), service, model, remesh, resolution AI text_to_3d prompt (required), service, model Export export_glb, export_usd, export_stl, export_ply path (required) Export export_fbx path (required), lods, ratio, scale Export export_lods path (required), levels, ratio Unreal unreal_send destination, height_cm, lods, network Splats splat_to_mesh resolution, close, smooth Edit undo, redo A few commands exist only inside the app, because they change the view rather than the model: set_material (name= a MatCap such as Sculpt, or Studio) and new_cube."},{"p":"scripting.html","c":"Scripting and automation","a":"sculptforge-cli","h":"sculptforge-cli","t":"sculptforge-cli runs commands without a window: on a server, a render farm node or in a build pipeline. It keeps one scene for the whole run, loads your brush library (and studio brushes), and uses the same ai.json settings as the app. sculptforge-cli [options] -c, --command \"<script>\" Run commands, separated by ';' (can be given several times) -f, --file <script.txt> Run commands from a file ('-' reads standard input) --set NAME=VALUE Define a variable; script values written $NAME are replaced -l, --list List every command and its parameters --schema Print the commands as LLM tool definitions (JSON) --mcp Run as an MCP server on standard input and output -q, --quiet Only print errors -h, --help Show this help Each command prints its result on one line (export_glb: Exported out/rock.glb). The exit status is 0 when everything succeeded, 1 for a usage or script syntax error, and 2 when a command failed (the error names the line and the command). Variables make one script reusable. A value written $NAME (the whole value) is replaced with the --set value, so paths with spaces stay intact: cat > lods.sfscript <<'EOF' open path=$in remesh resolution=256 export_lods path=$out levels=4 ratio=0.5 EOF for f in rocks/*.obj; do sculptforge-cli --set in=\"$f\" --set out=\"lods/$(basename \"$f\" .obj).glb\" -f lods.sfscript done More examples: # Concept art -> sculptable model -> USDZ (free, via Hugging Face) sculptforge-cli -c 'image_to_3d path=hero.png; export_usd path=hero.usdz' # Design a brush (free, no key) and save it for the team sculptforge-cli -c 'brush_ai prompt=\"weathered stone edges\"; brush_save path=stone.sfbrush' # Cavity dirt on a sculpt, then a coloured PLY sculptforge-cli -c 'open path=bust.sfproj; paint_from_cavity color=\"#3a2a20\" strength=0.8; export_ply path=bust.ply' Warning: Without the quotes, #3a2a20 would start a comment. In a shell, put the whole script in single quotes so the double quotes reach SculptForge."},{"p":"scripting.html","c":"Scripting and automation","a":"the-sculptforge-app-on-the-command-line","h":"The SculptForge app on the command line","t":"The desktop app takes a few options too, for renders and start-up scripts: Option What it does sculptforge FILE Opens a model, project, splat capture or image at start-up --run \"\" Runs commands at start-up --render out.png Renders the scene to an image and exits --turntable N With --render: N frames around the model (out_000.png ...) --size WxH Render size (default 1024x1024) --view YAW,PITCH Camera angles in degrees (default -30,-15) --zoom F Move the camera F times closer than the framed view --wireframe, --polygroups Render with the wireframe or polygroup colours --hide-mesh Render only the Gaussian splats --fullscreen Start filling the screen (F11 toggles) --demo NAME, --record out.mp4 Play a scripted demo, and record it to a video (needs ffmpeg) --ui-test FILE.sfui, --ui-out DIR Run an interface test script (for developers) A review sheet for a model, eight frames around it: sculptforge model.glb --render review/model.png --turntable 8 --size 1024x1024 Rendering needs an OpenGL 3.3 capable GPU or software renderer and a display. On a headless Linux node, run it under a virtual display such as Xvfb (xvfb-run sculptforge ...)."},{"p":"scripting.html","c":"Scripting and automation","a":"python","h":"Python","t":"SculptForge has a Python module, sculptforge, with the same commands plus NumPy access to the mesh. It is included in the VFX Reference Platform builds and the Rez package (see For studios); when building from source, configure CMake with -DSCULPTFORGE_BUILD_PYTHON=ON. import sculptforge as sf doc = sf.Document() # loads your brush library, like the app sf.run(doc, \"open\", path=\"/show/troll/troll_base.fbx\") sf.run(doc, \"remesh\", resolution=320) sf.run_script(doc, \"decimate ratio=0.25; export_lods path=/out/troll.glb levels=4\") verts, tris = doc.vertices, doc.triangles # NumPy (N, 3) float32 and (M, 3) uint32 doc.set_mesh(verts * 1.1, tris) # bring in a mesh from your own tools (clears undo) print(doc.subtools) # [{'name': ..., 'visible': ..., 'triangles': ...}] doc.active_subtool = \"Helmet\" # select by index or name for name, weight in doc.layers: # sculpt layers (blend shapes) print(name, weight) print([c[\"name\"] for c in sf.commands()]) # every command with its parameters Function or property What it does sf.run(doc, command, **params) Runs one command and returns its message sf.run_script(doc, script) Runs a script in the syntax above and returns the messages sf.commands() Lists every command with its parameters sf.tool_schema() The commands as LLM tool definitions (JSON) doc.vertices, doc.base_vertices, doc.normals, doc.triangles Mesh arrays of the active SubTool (copies) doc.mask, doc.colors, doc.polygroups, doc.hidden Attribute arrays you can read and assign (None if absent) doc.layers, doc.layer_delta(i) Sculpt layers as (name, weight) and their per-vertex offsets doc.subtools, doc.active_subtool The SubTool list and the active SubTool doc.splat_count Number of loaded Gaussian splats Failures raise sculptforge.CommandError. Long operations release the GIL, so you can run them on worker threads."},{"p":"scripting.html","c":"Scripting and automation","a":"ai-agents-mcp","h":"AI agents (MCP)","t":"sculptforge-cli --mcp runs SculptForge as an MCP server. An AI agent (Claude Code, Claude Desktop or any MCP client) gets every command as a tool and works on one scene for the session: it can open files, generate models, sculpt strokes, remesh, paint and export. Claude Code: claude mcp add sculptforge -- /path/to/sculptforge-cli --mcp Claude Desktop or another client: add a stdio server whose command is the full path to sculptforge-cli and whose argument is --mcp. For Claude Desktop that is an entry in its configuration file like this: { \"mcpServers\": { \"sculptforge\": { \"command\": \"/path/to/sculptforge-cli\", \"args\": [\"--mcp\"] } } } Then ask for something like \"make a sphere, remesh it at 128 and export it to ~/Desktop/ball.glb\". File paths are on your machine. The agent works headless; to see the result, open the exported file in SculptForge. sculptforge-cli --schema prints the same tool definitions as JSON, for wiring SculptForge into your own agent."},{"p":"scripting.html","c":"Scripting and automation","a":"see-also","h":"See also","t":"The interface: the command palette and Ctrl-hover help For studios: Rez, the VFX builds and farm rendering Image and text to 3D and Exporting: the commands in context Keyboard and mouse reference"},{"p":"studios.html","c":"SculptForge for studios","a":"","h":"SculptForge for studios","t":"SculptForge is built to drop into animation, VFX and game studios that run their own pipelines: native on Linux, scriptable, standards-based, with no licence server and nothing that phones home. This chapter is for pipeline TDs and IT: the VFX Reference Platform builds, Rez deployment, shared brush libraries, environment variables, headless use and licensing."},{"p":"studios.html","c":"SculptForge for studios","a":"vfx-reference-platform-builds","h":"VFX Reference Platform builds","t":"SculptForge tracks the VFX Reference Platform. Every commit is built and tested in the platform's reference environments: CY2026 CY2027 SculptForge Linux compiler GCC 14.2 GCC 14.2 Built and tested with gcc-toolset-14 glibc 2.28 (EL8) 2.34 (EL9) Rocky Linux 8 and 9 builds; CI checks that no newer glibc symbols are used C++ C++20 C++20 C++20 Python 3.13 3.13 The sculptforge module is built and tested against 3.13 Windows VS 2022 17.6+ VS build tools 14.44+ Visual Studio 2022 macOS minimum 14.0 14.0 Universal binary with deployment target 11.0 FBX 2020.x 2020.x Writes FBX 7.4 binary, which FBX SDK 2020 reads SculptForge doesn't depend on Qt, OpenEXR, Boost, TBB or other platform libraries, so it can't conflict with the versions your other tools load. Its few dependencies (SDL3, Dear ImGui, GLM, ufbx) are linked into the binaries. Each release includes SculptForge--linux--vfx2026.tar.gz (Rocky 8, glibc 2.28) and ...-vfx2027.tar.gz (Rocky 9, glibc 2.34), for x86_64 and ARM64, with the Python module under lib/sculptforge/python."},{"p":"studios.html","c":"SculptForge for studios","a":"deploy-with-rez","h":"Deploy with Rez","t":"packaging/rez/package.py in the source tree builds and installs a Rez package: cd packaging/rez SCULPTFORGE_PYTHON=$(which python3.13) rez-build --install # or --release for your release repository rez-env sculptforge -- sculptforge # the app rez-env sculptforge -- sculptforge-cli --list # every pipeline command rez-env sculptforge python-3.13 -- python -c \"import sculptforge\" The package puts bin/ on PATH and the Python module on PYTHONPATH, and sets SCULPTFORGE_ROOT. The Python module is built for the first python3 found unless SCULPTFORGE_PYTHON names an interpreter."},{"p":"studios.html","c":"SculptForge for studios","a":"studio-brush-libraries","h":"Studio brush libraries","t":"Each artist's own brushes live in their user brush library, one .sfbrush file per brush (see Brush Lab and sharing brushes). To give a whole team the same brushes, put .sfbrush files on a share and list it in SCULPTFORGE_BRUSH_PATH: export SCULPTFORGE_BRUSH_PATH=/studio/brushes:/show/troll/brushes # ';' between folders on Windows sculptforge-cli -c 'brush_library' # every brush, where it comes from and its file, plus the folders The app, sculptforge-cli and the Python module load these folders at start-up, read-only: SculptForge never writes into them, so the share can be mounted read-only. Studio brushes show a studio tag in the Custom brushes list. When brushes share a name, the artist's own wins over a studio one, which wins over a built-in. Among studio folders, the first one listed wins. Refining a studio brush in Brush Lab saves the artist's own version (tagged yours) without touching the share. Deleting that version brings the studio brush back. To publish a brush, copy its .sfbrush file into the share: right-click it in the Custom brushes list > Save .sfbrush..., or take it from an artist's user library. With Rez, set the share once for everyone: when SCULPTFORGE_STUDIO_BRUSHES is set as the package resolves (in a site package, your rezconfig or the launcher), it is appended to SCULPTFORGE_BRUSH_PATH. export SCULPTFORGE_STUDIO_BRUSHES=/studio/brushes rez-env sculptforge -- sculptforge"},{"p":"studios.html","c":"SculptForge for studios","a":"environment-variables","h":"Environment variables","t":"Variable Effect SCULPTFORGE_BRUSH_PATH Read-only studio brush folders (:-separated, ; on Windows) SCULPTFORGE_STUDIO_BRUSHES With the Rez package: appended to SCULPTFORGE_BRUSH_PATH SCULPTFORGE_BRUSH_GALLERY Use another community brush gallery index (a URL or a folder), for example an in-house mirror HF_TOKEN (or HUGGING_FACE_HUB_TOKEN) Hugging Face token for the free image-to-3D models FAL_KEY, MESHY_API_KEY Keys for the paid generation services ANTHROPIC_API_KEY, OPENAI_API_KEY Keys for Brush Lab providers XDG_DATA_HOME (Linux), APPDATA (Windows) Move the settings folder (see where settings live) Keys from the environment are used when none is saved in the app, so a launcher can supply them without writing them to each artist's settings."},{"p":"studios.html","c":"SculptForge for studios","a":"headless-and-farm-use","h":"Headless and farm use","t":"sculptforge-cli runs every editing operation without a display: imports, remeshing, decimation, LOD chains, FBX, USD and glTF export, splat conversion and AI generation. See Scripting and automation. sculptforge --render out.png --turntable 8 renders review images and turntables offscreen. It needs an OpenGL 3.3 context; on a headless Linux node, run it under Xvfb. sculptforge-cli --mcp exposes the same operations to AI agents through the Model Context Protocol. import sculptforge gives Python the same commands plus NumPy arrays of the mesh, for your own tools. A typical farm job turns incoming scans into game-ready assets: sculptforge-cli --set in=/ingest/scan_042.ply --set usd=/assets/scan_042.usda --set glb=/assets/scan_042.glb -c ' open path=$in splat_transform rotate_x=180 fit=true splat_clean splat_to_mesh resolution=320 export_usd path=$usd export_lods path=$glb levels=4 ratio=0.5 ' A --set variable replaces a whole value, so pass complete paths (with their extensions) as variables."},{"p":"studios.html","c":"SculptForge for studios","a":"formats-in-a-pipeline","h":"Formats in a pipeline","t":"Format Read Write Notes OpenUSD (.usda, .usdz) Yes Yes Meshes, xform ops, Z-up stages, UsdSkel blend shapes, ParticleField Gaussian splats; checked with OpenUSD's usdchecker FBX Yes (any version) Yes (7.4 binary) LOD groups, blend shapes, centimetre units glTF / GLB Yes Yes Morph targets, vertex colours, KHR_gaussian_splatting; checked with the Khronos validator OBJ Yes Yes Objects as SubTools, groups as polygroups, vertex colours PLY Yes Yes Meshes with vertex colours, Gaussian splats STL Yes (binary and ASCII) Yes (binary) ZBrush GoZ Yes Yes Polygroups, mask, polypaint, UVs SculptForge project (.sfproj) Yes Yes Everything; a documented ZIP of JSON and binary arrays Binary .usdc files and USD references or payloads aren't read yet; convert with usdcat in.usd -o out.usda. The project format is described in docs/project-format.md in the source tree, so pipeline tools can read it without SculptForge."},{"p":"studios.html","c":"SculptForge for studios","a":"licensing","h":"Licensing","t":"SculptForge is free software under the GNU General Public License, version 3 or later. In practice: Using it is unrestricted, commercially or otherwise, on any number of machines. There are no seats, licence servers or accounts. Your artwork belongs to you. The GPL covers the program, not the models you make with it. You can modify it in-house. The GPL only requires you to share source if you distribute the modified program outside your organisation. Internal use, including across your own facilities and farm, is generally not considered distribution. (This is the common reading of the GPL, not legal advice; check with your counsel.) SculptForge has no telemetry and no servers of its own. AI features are optional and talk only to the service each artist chooses, or to your own ComfyUI server."},{"p":"studios.html","c":"SculptForge for studios","a":"not-yet","h":"Not yet","t":"Planned pipeline features, roughly in order: OpenColorIO viewport display, Alembic export, fuller USD authoring (layers, variants, references, .usdc), UVs and texture baking, multiresolution sculpting. Pipeline requests are welcome as issues on the project's GitHub page."},{"p":"studios.html","c":"SculptForge for studios","a":"see-also","h":"See also","t":"Scripting and automation Exporting, Send to Unreal and GoZ Brush Lab and sharing brushes Image and text to 3D: running models on your own ComfyUI server Troubleshooting"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"","h":"Keyboard and mouse","t":"This chapter is the reference for every default keyboard shortcut and mouse gesture in SculptForge. Inside the app, F1 opens the same list as the Controls window, showing your own keys if you've changed any."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"changing-shortcuts","h":"Changing shortcuts","t":"Every key below can be reassigned: hold Ctrl+Alt and click a button, then press the new key, or use Preferences > Hotkeys. Press Ctrl+Shift+I (Store Config) to keep your changes. See Customizing the interface. On macOS, Cmd works wherever a shortcut says Ctrl. Single-letter shortcuts don't fire while you type in a text field."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"keyboard-shortcuts","h":"Keyboard shortcuts","t":"The table lists the default shortcut of every action, grouped by palette. It is generated from SculptForge's action registry, the same source as the Controls window."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"brush","h":"Brush","t":"Action Keys What it does Brush picker B Pop up every brush under the cursor. Type the first letter of a brush, then the orange letter on its tile (B S T = Standard). Clay 2 Builds up clay that fills the hollows first. ClayBuildup 0 Square, flat-topped clay strokes for blocking in forms. Crease 6 Cuts a sharp crease; Alt raises a ridge. DamStandard 9 A sharp V-shaped crease with the sides pinched in (ZBrush DamStandard). Flatten 7 Presses the surface toward a plane. Inflate 5 Swells the surface outward along its normals. Move 4 Grabs the surface under the cursor and pulls it along. Paste brush Ctrl+V Add the brush on the clipboard: a brush code someone shared, or the text of a .sfbrush file. Pinch 8 Pulls the surface toward the stroke to tighten edges. Smooth 3 Relaxes the surface. Hold Shift to smooth with any brush. Standard 1 Raises the surface along the stroke; Alt digs in."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"color","h":"Color","t":"Action Keys What it does Pick colour C Take the paint colour from the model under the cursor."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"draw","h":"Draw","t":"Action Keys What it does Draw Size at cursor S A Draw Size slider under the cursor: drag it, or type a number and press Enter. Larger brush ] Make the brush 10% larger (hold to repeat). Paint P Paint colour without sculpting (ZBrush Rgb on, Zadd off). Alt paints back to white, Shift still smooths. Smaller brush [ Make the brush 10% smaller (hold to repeat). Strength at cursor I A Strength slider under the cursor: drag it, or type a number and press Enter."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"edit","h":"Edit","t":"Action Keys What it does Redo Ctrl+Shift+Z or Ctrl+Y Redo the last undone action. Undo Ctrl+Z Undo the last action."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"file","h":"File","t":"Action Keys What it does Export GLB... Ctrl+E Export the model as glTF binary, with sculpt layers as blend shapes (morph targets). New Sphere Ctrl+N Replace the scene with a new sphere ready for sculpting. Open... Ctrl+O Open a project (.sfproj), a model (.obj, .glb, .fbx, .stl, .ply, .usd ...) or splats. Quit Ctrl+Q Close SculptForge (asks to save changes first). Save Ctrl+S Save the project (.sfproj: every SubTool, layer, brush and setting). Asks for a name the first time. Save As... Ctrl+Shift+S Save the project under a new name. Send to Unreal Ctrl+U Export a game-ready FBX and import it into the running Unreal Editor (Python remote execution)."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"help","h":"Help","t":"Action Keys What it does Command palette F3 or Ctrl+Shift+P Search every command, brush and setting by name and run it. Commands that need parameters open in the console. Controls F1 Every shortcut and mouse gesture, generated from the commands themselves. User Guide Shift+F1 The SculptForge user guide: every tool explained, with search. Hold Ctrl over a control and press F1 to open the chapter about it."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"lightbox","h":"LightBox","t":"Action Keys What it does LightBox , Show or hide the LightBox: thumbnails of your projects, models, brushes, alphas, materials, images, splats and QuickSaves along the top of the canvas. Double-click to load."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"material","h":"Material","t":"Action Keys What it does Material picker M Pop up the materials under the cursor. Hover one to preview it on the model; click to keep it."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"preferences","h":"Preferences","t":"Action Keys What it does Load UI... Ctrl+L Load a layout file someone shared (or you saved with Save UI). Shelves Tab Hide or show the shelves and trays around the canvas. Store Config Ctrl+Shift+I Keep the current layout, shortcuts and interface preferences for future sessions. Like ZBrush, SculptForge never saves them on its own."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"render","h":"Render","t":"Action Keys What it does Fullscreen F11 Fill the screen with SculptForge (again: back to a window). Wireframe W or Shift+F Show the mesh's triangles over the surface (ZBrush PolyFrame)."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"script","h":"Script","t":"Action Keys What it does Console ` The script console: every command you run appears as a script line, and you can type commands yourself."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"tool","h":"Tool","t":"Action Keys What it does Subdivide Ctrl+D Smoothly subdivide the mesh (Loop subdivision). Each level multiplies the triangle count by 4."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"transform","h":"Transform","t":"Action Keys What it does Frame F Fit the whole model in the view. X X Mirror strokes across X (left and right)."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"mouse-and-pen-gestures","h":"Mouse and pen gestures","t":"Action Gesture Sculpt Left-drag on the model Invert the brush (subtract) Hold Alt while sculpting Smooth Hold Shift while sculpting (works with any brush, and with Paint) Rotate Left-drag on the background, or right-drag Pan Alt+left-drag on the background, middle-drag, or Shift+right-drag Zoom Mouse wheel, Ctrl+middle-drag, or Ctrl+left-drag on the background (when nothing is masked) Paint the mask Hold Ctrl while stroking on the model Erase the mask Hold Ctrl+Alt while stroking on the model Invert the mask Ctrl+click the background Clear the mask Ctrl+drag on the background Isolate a polygroup Ctrl+Shift+click it (again: invert the visibility) Hide a polygroup Ctrl+Shift+Alt+click it Show everything Ctrl+Shift+click the background Hide outside a rectangle Ctrl+Shift+drag (add Alt: hide inside) Select a SubTool Alt+click it in the view Pan, zoom or orbit with a button Drag on Move, Zoom or Rotate on the right shelf Help on any control Hold Ctrl and point at it (Ctrl+Alt: scripting parameters) Assign a shortcut Ctrl+Alt+click any button, then press the key Move or remove shelf items Ctrl+Alt+drag (with Enable Customize on) Tablet pressure Used automatically when a pen is detected (Pressure > Strength / Pressure > Size) Open files Drop a model (.obj, .glb ...), project, brush (.sfbrush), splat capture or image onto the window"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"keys-inside-pop-ups-and-panels","h":"Keys inside pop-ups and panels","t":"Some keys only mean something while a pop-up or panel has the keyboard."},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"brush-picker-b","h":"Brush picker (B)","t":"Key Action A letter Keep the brushes whose names start with the letters typed so far The orange letter on a tile Pick that brush (B S T = Standard) Backspace Take back one letter Enter Pick the first match Esc Close"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"draw-size-and-strength-at-the-cursor-s-i","h":"Draw Size and Strength at the cursor (S, I)","t":"Key Action Digits and . Type a value Enter Apply the typed value and close Esc Close without applying a typed value"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"command-palette-f3","h":"Command palette (F3)","t":"Key Action Up / Down, Page Up / Page Down Choose a row Enter Run it Shift+Enter Open a command with parameters in the console to edit them Esc Close"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"console-","h":"Console (`)","t":"Key Action Enter Run the line (statements separated by ;) Tab Complete a command or parameter name; press again to list the candidates Up / Down Walk through earlier lines (the last 200 are remembered between sessions)"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"shortcut-capture-ctrlaltclick","h":"Shortcut capture (Ctrl+Alt+click)","t":"Key Action Any key or chord Becomes the new shortcut (taken from another action if it had it) Backspace or Delete Remove the shortcut Esc Cancel"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"zbrush-keys-that-work-differently","h":"ZBrush keys that work differently","t":"Most ZBrush shortcuts do the same thing in SculptForge. A few differ because the feature works differently or doesn't exist yet: ZBrush SculptForge D / Shift+D (subdivision level up / down) No subdivision levels yet; Ctrl+D subdivides once and can be undone Space (QuickMenu) No QuickMenu; use the left-shelf tiles, B, M, S and I O (Focal Shift) No focal shift setting Q W E R (Draw, Move, Scale, Rotate gizmo) No transform gizmo; W toggles the wireframe (PolyF) Ctrl+W (group masked) Tool > Polygroups > From mask Shift (snap the view while rotating) No view snapping yet H (hide the ZScript window) ` toggles the console"},{"p":"shortcuts.html","c":"Keyboard and mouse","a":"see-also","h":"See also","t":"The interface Navigating the view Masking Polygroups and visibility"},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"","h":"Troubleshooting and FAQ","t":"This chapter collects fixes for common problems: start-up and graphics errors, tablets, AI service messages, ComfyUI errors, the camera notch, first-launch warnings on macOS and Windows, where SculptForge keeps its settings, how to reset the interface, and how to report a bug."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"sculptforge-doesnt-start","h":"SculptForge doesn't start","t":"SculptForge draws with OpenGL 3.3 (core profile). Almost every GPU from the last decade supports it, but an old driver, a remote desktop session or a virtual machine without 3D acceleration may not. Update your graphics driver from the GPU maker (NVIDIA, AMD, Intel) or your Linux distribution. Virtual machines: turn on 3D acceleration in the VM settings. Remote desktop: some remote sessions only offer an older OpenGL. Run SculptForge locally, or use a remote tool that forwards the GPU. Linux: on a machine without a working GPU driver, Mesa's software renderer works (slowly): LIBGL_ALWAYS_SOFTWARE=1 sculptforge. To see why it stopped, start it from a terminal and read the messages. It prints the OpenGL version and GPU it found at start-up (for example OpenGL 4.6 (Core Profile) Mesa 26.1.8 on ...), or the error, such as OpenGL 3.3 context creation failed or Missing OpenGL function: .... Linux: run sculptforge in a terminal. macOS: run /Applications/SculptForge.app/Contents/MacOS/SculptForge in Terminal. Windows: the release build has no console window; if it closes straight away, update the driver first."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"first-launch-warnings-on-macos-and-windows","h":"First launch warnings on macOS and Windows","t":"The release builds aren't code-signed yet, so the operating system warns the first time. macOS (Gatekeeper): \"SculptForge can't be opened because it is from an unidentified developer\". In Finder, right-click (or Ctrl+click) SculptForge in Applications and choose Open, then Open again. macOS remembers the choice. On recent macOS versions you may instead need System Settings Privacy & Security > Open Anyway. Windows (SmartScreen): \"Windows protected your PC\". Click More info, then Run anyway. Download SculptForge only from the official releases page on GitHub (the website that Help > Website & documentation opens links to it)."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"the-viewport-is-slow","h":"The viewport is slow","t":"Check the triangle count in the title strip (Tris). Millions of triangles on a laptop GPU are heavy; Tool > Geometry > Decimate or a lower Voxel Remesh resolution brings it down. See Subdivide, Remesh, Decimate and LODs. Turn off Wireframe (W) on dense meshes. Hide SubTools you aren't working on, or Solo the active one. A large Gaussian splat capture costs GPU time too: lower the count with Clean floaters, or untick 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)."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"pen-tablets","h":"Pen tablets","t":"SculptForge reads pen pressure through the operating system's standard pen input, so most Wacom, XP-Pen, Huion and similar tablets, and pen displays, work without settings. Open the Draw palette. Under Tablet it shows \"Pen pressure: 0.42\" once the pen has come near the tablet, or \"No pen detected\". Pressure > strength (on by default) and Pressure > size choose what pressure controls. They are also on the top shelf. A custom brush can also set its own pressure response (pressureCurve in its recipe, see Brush Lab and sharing brushes). If no pen is detected or pressure doesn't change: Install or update the tablet maker's driver, then restart SculptForge. Windows: most drivers have a Windows Ink option. If pressure doesn't reach SculptForge, try switching it (on or off) in the tablet driver's settings for SculptForge or for all applications, then restart SculptForge. Linux: check that the system sees the pen as a tablet (for example in your desktop's tablet settings). If the cursor moves but strokes have no pressure, test in another application to see whether the driver reports pressure at all."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"hugging-face-free-image-and-text-to-3d","h":"Hugging Face (free image and text to 3D)","t":"Message What to do Hugging Face's free GPU time is used up for now The anonymous daily allowance ran out. Add a free token (huggingface.co/settings/tokens, read access) in HF token in the Generate 3D window, or set HF_TOKEN; or wait for it to refill (about a day); or pick another model The Hugging Face Space is asleep or restarting The model's demo is starting up. Try again in a minute, or pick another model Waiting in the queue for a long time The demos are shared. Try a faster model (Hunyuan3D 2 mini Turbo, Stable Fast 3D) or another time of day TRELLIS.2 fails without a token TRELLIS.2 needs a Hugging Face token"},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"falai-and-meshy","h":"fal.ai and Meshy","t":"Message What to do The API key was rejected Check the key in the Generate 3D window, or the FAL_KEY / MESHY_API_KEY variable Out of credits on this account Top up your account with that service Model or endpoint not found Check the fal model id Rate limited Wait a moment and try again"},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"brush-lab","h":"Brush Lab","t":"The default Free provider uses a hosted open model with no account. If it is unreachable and Ollama runs on your computer, SculptForge uses your local model instead. \"Rate limited by the provider\" means too many requests in a short time: wait a few seconds. For setup of local models, see Brush Lab and sharing brushes."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"no-connection-at-all","h":"No connection at all","t":"AI features need internet access (except a local Ollama, LM Studio or ComfyUI). Behind a company proxy or firewall, ask IT to allow the service you use: huggingface.co (and *.hf.space), fal.ai, meshy.ai, or the Pollinations.ai text endpoint for the free Brush Lab model."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"comfyui-errors","h":"ComfyUI errors","t":"Message What to do Nothing is answering at http://... ComfyUI isn't running at that address, or a firewall blocks it. Check the address and port (8188 by default). For another computer, start ComfyUI with --listen ...answered, but not like ComfyUI Something else uses that port, or a proxy is in the way. Use the address ComfyUI prints when it starts This workflow was saved in ComfyUI's editor format Export it again in ComfyUI with Workflow > Export (API) This ComfyUI does not have the node ... or ...is missing the nodes ... Install the custom nodes the workflow uses (ComfyUI Manager > Install Missing Custom Nodes) and restart ComfyUI ...names a model file this server doesn't have Download the model into the right subfolder of ComfyUI's models folder, for example models/checkpoints ComfyUI rejected the workflow: node N ... An input is out of range. Open the workflow in ComfyUI: it shows the same error on that node The workflow finished but saved no mesh file End the workflow with Save GLB or another node that saves a mesh ...the GPU ran out of memory The GPU ran out of memory. Lower the resolution or octree size, or use a smaller model The job disappeared from ComfyUI's queue Someone cleared the queue or ComfyUI restarted. Generate again The workflow has no Load Image node You chose a text workflow on the From image tab. Use it from From text See Image and text to 3D for setup."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"the-top-of-the-window-is-hidden-behind-the-camera-notch","h":"The top of the window is hidden behind the camera notch","t":"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 MacBook displays on Linux), Always reserve, or Off. F11 switches between fullscreen and a window."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"text-and-buttons-are-too-small-or-too-large","h":"Text and buttons are too small or too large","t":"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 (Ctrl+Shift+I)."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"my-layout-or-shortcuts-are-gone-after-a-restart","h":"My layout or shortcuts are gone after a restart","t":"Like ZBrush, SculptForge never saves the layout on its own. Press Store Config (Ctrl+Shift+I) to keep the current layout, shortcuts and interface preferences. See The interface."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"reset-the-interface","h":"Reset the interface","t":"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) and imgui.ini (positions of floating windows such as Brush Lab) from the settings folder below."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"a-key-does-nothing","h":"A key does nothing","t":"Shortcuts don't fire while you type in a text field: click the canvas first. Check the key in Help > Controls (F1), which shows every shortcut as currently assigned; a key you reassigned shows in orange in Preferences > Hotkeys, where Default shortcuts undoes every change."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"where-settings-live","h":"Where settings live","t":"SculptForge keeps its settings in one folder per user: System Settings folder Linux ~/.local/share/SculptForge/SculptForge/ (or $XDG_DATA_HOME/SculptForge/SculptForge/) macOS ~/Library/Application Support/SculptForge/SculptForge/ Windows %APPDATA%\\SculptForge\\SculptForge\\ (usually C:\\Users\\\\AppData\\Roaming\\SculptForge\\SculptForge\\) File or folder What it holds ui.json Layout, shortcut changes and interface preferences, written by Store Config imgui.ini Positions and sizes of floating windows ai.json AI settings: providers, models, keys, ComfyUI address (readable only by your account) project.json Recent files and the autosave interval autosave.sfproj The autosaved copy of unsaved work (removed once you save) clean_exit Marks a normal exit; without it, the autosave is offered for restore console_history.txt The console's command history recent_actions.txt Recently used entries of the command palette brushes/ Your brush library, one .sfbrush file per brush brush-gallery-cache/, brush-gallery.json Community brush gallery cache and its address thumbs/ Cached LightBox and picker thumbnails (safe to delete) Your library folder (projects, tools, alphas, images, splats and QuickSaves shown in the LightBox) is separate: Documents/SculptForge by default, changeable in Preferences > LightBox > 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."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"recovering-work-after-a-crash","h":"Recovering work after a crash","t":"SculptForge autosaves unsaved work every 5 minutes by default (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 QuickSave."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"frequently-asked-questions","h":"Frequently asked questions","t":"Can SculptForge open ZBrush files (.ZTL, .ZPR)? No. They are proprietary and undocumented. Use GoZ, or export OBJ or FBX from ZBrush. See Exporting, Send to Unreal and GoZ. Does it have subdivision levels, DynaMesh, ZRemesher or UVs? Voxel remesh works like DynaMesh. Multiresolution subdivision levels, dynamic topology, automatic retopology and UV unwrapping are not there yet; they are on the roadmap. Is it really free? Can I sell what I make? Yes and yes. SculptForge is GPL-3.0-or-later free software; the licence covers the program, not your models. The AI models have their own licences (see Image and text to 3D). Does SculptForge send anything about me anywhere? No. There is no telemetry and no account. AI features talk only to the service you choose, when you use them. Does it work offline? Yes. Everything except the hosted AI services works offline, and Brush Lab and image-to-3D can run on local models (Ollama, LM Studio, your own ComfyUI or generator command). Where are my brushes? In the brushes folder in the settings folder above. Brush Lab saves every brush you make or refine there."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"report-a-problem","h":"Report a problem","t":"Choose Help > Report a problem to open the issue tracker on GitHub (you need a free GitHub account). A good report includes: The SculptForge version (Help > About SculptForge) and your operating system. Your GPU and driver: the OpenGL ... on ... line SculptForge prints at start-up (see SculptForge doesn't start), or the GPU name from your system settings. Steps to reproduce: what you did, what you expected and what happened instead. The commands you ran: open the console (the backtick key, left of 1), click Copy session as script and paste it into the report. It often reproduces the problem exactly. A file if the problem is with a particular model (a small .sfproj or the original file), and a screenshot for display problems. For a security problem, don't open a public issue; follow SECURITY.md in the repository instead."},{"p":"troubleshooting.html","c":"Troubleshooting and FAQ","a":"see-also","h":"See also","t":"Installing SculptForge The interface Glossary"},{"p":"glossary.html","c":"Glossary","a":"","h":"Glossary","t":"This chapter maps ZBrush terms to their SculptForge equivalents, so you can find a familiar tool quickly, and explains the terms that only SculptForge uses. \"Not yet\" means SculptForge doesn't have it today; see the roadmap for what is planned."},{"p":"glossary.html","c":"Glossary","a":"zbrush-terms-in-sculptforge","h":"ZBrush terms in SculptForge","t":"ZBrush SculptForge Alpha Alpha: built-in round, square and noise, or any grayscale image. Left shelf, Alpha palette. See Sculpting Auto Groups Tool > Polygroups > By pieces (polygroup_by_connectivity) BPR render Not yet as a renderer. Headless renders and turntables with sculptforge --render (Scripting) Brush pop-up (B) Brush picker, B, then type letters (B S T = Standard) Clip brushes Not yet. The Trim brush shaves to a plane Curve brushes, IMM, ZModeler, ZSpheres Not yet Decimation Master Tool > Geometry > Decimate (decimate). See Geometry Del Hidden Tool > Visibility > Delete hidden (delete_hidden) Divide (Ctrl+D) Tool > Geometry > Subdivide, Ctrl+D Document, 2.5D canvas, pixols Not planned: SculptForge is a 3D sculpting app only Draw Size Draw Size (top shelf, S, [ / ]) DynaMesh Voxel Remesh (Tool > Remesh, remesh). See Geometry Focal Shift No slider for the built-in brushes. Custom brushes have Hardness and Tip sharpness in their recipe Ghost, Transp Not yet. Inactive SubTools are drawn slightly dimmed GoZ GoZ: .GoZ import and export and the GoZ bridge (File > ZBrush (GoZ)). See Exporting Group Masked Tool > Polygroups > From mask (polygroup_from_mask) Group Visible Tool > Polygroups > Merge visible (polygroup_merge_visible) Groups By Normals Tool > Polygroups > By normals with an angle (polygroup_auto_by_normals) Layers (sculpt layers) Tool > Layers: sculpt layers with weights, exported as blend shapes. See Layers LazyMouse LazyMouse stroke type (Stroke palette) LightBox LightBox, , (comma) Live Boolean Not yet Local symmetry, radial symmetry Not yet. Symmetry is X, Y and Z across the world axes Mask by Cavity Tool > Masking > By cavity (mask_by_cavity) Masking (Ctrl) Hold Ctrl to paint the mask, Ctrl+Alt to erase. See Masking Mask Lasso, Select Lasso Not yet. Rectangle hide works: Ctrl+Shift+drag MatCap Material: seven MatCaps, Sculpt the default, plus Studio (M). Custom MatCap images not yet. See Polypaint Morph target A sculpt layer; exported as glTF morph targets and FBX/USD blend shapes Mrgb, M (material channel) Not yet: there is no per-vertex material channel Polyframe (PolyF, Shift+F) PolyF on the right shelf, W or Shift+F Polygroups Polygroups: same idea, same Ctrl+Shift gestures. See Polygroups and visibility Polypaint Polypaint: Paint brush (P), Rgb, fills, cavity paint. See Polypaint Projection Master Not yet. Generate > Stamp projects an image onto the model from the view QuickSave QuickSave in the title strip; the last 10 are kept. See Projects Rgb Rgb on the top shelf (paint while sculpting) Rgb Intensity, Z Intensity Strength (top shelf, I) Sculptris Pro, dynamic topology Not yet SDiv, D / Shift+D (subdivision levels) Not yet: Subdivide is a single, destructive step Solo Solo on the right shelf or in Tool > SubTool Spotlight Not yet Store Config Store Config, Ctrl+Shift+I (Preferences > Config) Stroke (Dots, DragRect, Spray) Stroke types Dots, DragRect, Spray, LazyMouse SubTool SubTool: same idea, Alt+click to select. See SubTools Texture palette Not yet: there is no texture painting or texture slot Transpose, Gizmo 3D Not yet. Use the Move brush, or move the camera with the right-shelf buttons UV Master Not yet. UVs that come in with a GoZ model are kept (and saved in projects) Zadd / Zsub Zadd / Zsub on the top shelf; Alt flips for one stroke ZPlugin No in-app plugin system yet. Automate with the Python module, sculptforge-cli and MCP (Scripting) ZRemesher Not yet (quad retopology is on the roadmap) ZScript Script commands: the console (backtick key), script files, sculptforge-cli. See Scripting ZTL, ZPR files Not supported. Use GoZ, OBJ, FBX or GLB to bring models over; save work as .sfproj"},{"p":"glossary.html","c":"Glossary","a":"sculptforge-terms","h":"SculptForge terms","t":"Term Meaning Brush Lab The AI brush creator: describe a brush in words and it builds a recipe you can tweak. Opens from AI Brush. See Brush Lab Brush code One line of text (sfbrush1:...) that holds a whole brush, for sharing in chat or a forum. Paste with Ctrl+V Brush library Your saved custom brushes, loaded at every start Brush recipe The data that defines a custom brush (direction, depth, plane, pinch, pattern and so on): values, never code .sfbrush A file holding one brush recipe .sfproj A SculptForge project file: the whole scene. See Projects Command palette F3: search every command, brush and setting by name and run it Community gallery Shared CC0 brushes you can install in one click (Community brushes) Console The script console (backtick key): every action appears as a script line Ctrl help Hold Ctrl and point at a control to see what it does, its shortcut and its command Gaussian splat A 3D capture made of soft coloured blobs (from phone scanning apps). Load one as a reference, convert it to a mesh, or turn a sculpt into splats. See Gaussian splats Generate 3D Turn an image or a description into a sculptable model. See Image and text to 3D LOD chain A series of lighter copies of a model (LOD0, LOD1...) for game engines. See Geometry MCP Model Context Protocol: sculptforge-cli --mcp lets AI agents such as Claude run SculptForge commands Send to Unreal Export and import a model into a running Unreal Editor in one step (Ctrl+U) Shelves, palettes, trays The interface around the canvas: shelves hold the most-used controls, palettes hold everything, trays hold pinned palettes. See The interface Studio brush folder A shared, read-only brush folder for a team (SCULPTFORGE_BRUSH_PATH). See For studios"},{"p":"glossary.html","c":"Glossary","a":"see-also","h":"See also","t":"Welcome to SculptForge The interface Keyboard and mouse reference"}];diff --git a/website/guide/welcome.html b/website/guide/welcome.htmlindex 96c935f0..1ad13252 100644--- a/website/guide/welcome.html+++ b/website/guide/welcome.html@@ -69,7 +69,7 @@<strong>Keep separate meshes</strong> as SubTools (body, eyes, teeth, armour), each with its own undo history. See <a href="subtools.html">SubTools</a>.</li><li>-<strong>Paint colour</strong> on the surface (polypaint) and look at the model through six MatCap materials. See <a href="polypaint.html">Polypaint and materials</a>.+<strong>Paint colour</strong> on the surface (polypaint) and look at the model through seven MatCap materials. See <a href="polypaint.html">Polypaint and materials</a>.</li><li><strong>Sculpt layers</strong> that double as blend shapes (morph targets), with live weights. See <a href="layers.html">Sculpt layers and blend shapes</a>.