Skip to content

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

35.7 KB
Raw Blame
<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Install SculptForge on Windows, macOS and Linux - SculptForge User Guide</title>
  <meta name="description" content="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.">
  <meta name="theme-color" content="#111114">
  <meta name="color-scheme" content="dark">
  <link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32.png?v=7">
  <link rel="icon" type="image/png" sizes="64x64" href="../img/favicon-64.png?v=7">
  <link rel="apple-touch-icon" href="../img/apple-touch-icon.png?v=7">
  <link rel="canonical" href="https://sculptforge.app/guide/installing.html">
  <meta property="og:type" content="article">
  <meta property="og:title" content="Install SculptForge on Windows, macOS and Linux - SculptForge User Guide">
  <meta property="og:description" content="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.">
  <meta property="og:image" content="https://sculptforge.app/img/social-preview.png?v=5">
  <meta property="og:url" content="https://sculptforge.app/guide/installing.html">
  <link rel="stylesheet" href="../style.css?v=19">
  <script src="../motion.js?v=12" defer></script>
  <script data-goatcounter="https://sculptforge.goatcounter.com/count" async src="https://gc.zgo.at/count.js"></script>
  <script src="search-index.js?v=52" defer></script>
</head>
<body class="guide-page" data-prev="quick-tour.html" data-next="interface.html">
  <div class="scroll-progress" aria-hidden="true"></div>
  <header class="nav">
    <div class="wrap nav-inner">
      <a class="brand" href="../index.html"><img class="brand-mark" src="../img/bust-mark-44.png" srcset="../img/bust-mark-88.png 2x, ../img/bust-mark-132.png 3x" width="44" height="44" alt=""><span>SculptForge</span></a>
      <nav aria-label="Main">
        <a href="../index.html#features">Features</a>
        <a href="../index.html#demos">Demos</a>
        <a href="../brushes.html">Brushes</a>
        <a href="index.html" aria-current="page">Guide</a>
        <a class="nav-dl" href="../index.html#download">Download</a>
        <a class="gh" href="https://discord.gg/gWrYkEmQhH">Discord</a>
        <a class="gh" href="https://github.com/islandmed/SculptForge">GitHub</a>
      </nav>
    </div>
  </header>
  <div class="wrap guide-layout">
    <div class="guide-side">
      <button class="toc-toggle" type="button" aria-expanded="false" aria-controls="guide-toc">
        <span>Contents</span><span class="toc-current">Install SculptForge on Windows, macOS and Linux</span></button>
      <div id="guide-toc" class="toc-panel">
        <div class="guide-search" role="search">
          <input type="search" id="guide-q" placeholder="Search the guide" aria-label="Search the guide" autocomplete="off">
          <div class="search-results" id="guide-results" hidden></div>
        </div>
        <nav class="toc" aria-label="User guide"><a class="toc-home" href="index.html">Contents</a><p class="toc-group">Getting started</p><ul><li><a href="welcome.html">Welcome to SculptForge</a></li><li><a href="first-sculpt.html">Your first sculpt in 10 minutes</a></li><li><a href="whats-new.html">What&#x27;s new</a></li><li><a href="quick-tour.html">Quick tour for experienced sculptors</a></li><li><a href="installing.html" class="current" aria-current="page">Install SculptForge on Windows, macOS and Linux</a><ul class="toc-sections"><li><a href="#system-requirements">System requirements</a></li><li><a href="#download">Download</a></li><li><a href="#windows">Windows</a></li><li><a href="#opening-sculptforge-for-the-first-time">Opening SculptForge for the first time</a></li><li><a href="#what-you-see-at-start-up">What you see at start-up</a></li><li><a href="#updating-and-uninstalling">Updating and uninstalling</a></li><li><a href="#building-from-source">Building from source</a></li><li><a href="#see-also">See also</a></li></ul></li><li><a href="interface.html">The interface</a></li><li><a href="navigation.html">Navigating the view</a></li></ul><p class="toc-group">Sculpting</p><ul><li><a href="sculpting.html">Sculpting and brushes</a></li><li><a href="brush-lab.html">Brush Lab and sharing brushes</a></li><li><a href="brush-packs.html">Brush packs</a></li><li><a href="masking.html">Masking</a></li><li><a href="face-groups.html">Face Groups and visibility</a></li><li><a href="selection-sets.html">Selection sets and morph targets</a></li><li><a href="parts.html">Parts</a></li><li><a href="linked-duplicates.html">Linked Duplicates</a></li><li><a href="forge-spheres.html">Forge Spheres</a></li><li><a href="tube.html">Tube: draw in 3D space</a></li><li><a href="vertex-paint.html">Vertex Paint and materials</a></li><li><a href="texture-painting.html">Texture painting</a></li><li><a href="uv-editor.html">UV Editor</a></li><li><a href="pbr-painting.html">Material painting (PBR)</a></li><li><a href="fill-layers.html">Fill layers, Mesh Maps and Material Recipes</a></li><li><a href="layers.html">Sculpt layers and blend shapes</a></li><li><a href="facial-shapes.html">Facial shapes and live face</a></li><li><a href="subdivision-levels.html">Subdivision levels</a></li><li><a href="micro-levels.html">Micro levels: hundreds of millions of polygons</a></li><li><a href="dynamic-topology.html">Dynamic topology</a></li><li><a href="timeline.html">Sculpt Timeline and timelapse</a></li><li><a href="gizmo.html">Moving, rotating and posing (Gizmo)</a></li><li><a href="geometry.html">Subdivide, remesh, decimate and LODs</a></li><li><a href="cut.html">Cut: line, lasso, rectangle and polyline</a></li><li><a href="retopology.html">Quad retopology and detail projection</a></li></ul><p class="toc-group">AI and capture</p><ul><li><a href="generate-3d.html">Image and text to 3D</a></li><li><a href="splats.html">Gaussian splats</a></li><li><a href="scan-to-splat.html">Scan an object into a splat</a></li><li><a href="scan-to-sculptable.html">From scan to sculptable mesh</a></li><li><a href="phone-capture.html">Phone capture and AR</a></li></ul><p class="toc-group">Files and pipelines</p><ul><li><a href="baking.html">Baking normal and displacement maps</a></li><li><a href="exporting.html">Exporting, Unreal and Bridge</a></li><li><a href="export-presets.html">Export presets</a></li><li><a href="blender.html">Working with Blender</a></li><li><a href="maya.html">Working with Maya</a></li><li><a href="projects.html">Projects, autosave and snapshots</a></li><li><a href="scripting.html">Scripting and automation</a></li><li><a href="packs-and-macros.html">Packs and macros</a></li><li><a href="studios.html">SculptForge for studios</a></li><li><a href="security.html">Security overview for IT reviews</a></li></ul><p class="toc-group">Reference</p><ul><li><a href="shortcuts.html">Keyboard and mouse</a></li><li><a href="performance.html">Performance and big meshes</a></li><li><a href="troubleshooting.html">Troubleshooting: tablets, display, crashes and FAQ</a></li><li><a href="glossary.html">Glossary</a></li><li><a href="discord.html">Show SculptForge on Discord</a></li></ul></nav>
      </div>
    </div>
    <main class="guide-main" id="top">
      <article class="guide-article">
<h1 id="install-sculptforge-on-windows-macos-and-linux">Install SculptForge on Windows, macOS and Linux</h1>
<p>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>
<h2 id="system-requirements">System requirements<a class="anchor" href="#system-requirements" aria-label="Link to this section">#</a></h2>
<ul>
<li>
<strong>Operating system</strong>: 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.
</li>
<li>
<strong>Graphics</strong>: a GPU and driver that support <strong>OpenGL 3.3</strong> (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.
</li>
<li>
<strong>Input</strong>: a three-button mouse works for everything. A pen tablet adds pressure (see <a href="sculpting.html">Sculpting and brushes</a>).
</li>
<li>
<strong>Network</strong>: 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.
</li>
</ul>
<aside class="callout callout-note"><p><strong>Note:</strong> SculptForge is a 64-bit desktop application. There is no web, iPad or Android version.</p></aside>
<h2 id="download">Download<a class="anchor" href="#download" aria-label="Link to this section">#</a></h2>
<p>Each link below downloads the newest version. Pick the one for your system:</p>
<div class="table-wrap"><table><thead><tr><th>System</th><th>Download</th><th>How to install</th></tr></thead><tbody><tr><td>Windows 10/11 (x64)</td><td><a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-windows-x86_64-setup.exe" rel="noopener">Installer (.exe)</a></td><td>Run the installer (adds a Start menu shortcut)</td></tr><tr><td>Windows, portable</td><td><a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-windows-x86_64-portable.zip" rel="noopener">Portable .zip</a></td><td>Unzip anywhere and run <code>bin\sculptforge.exe</code></td></tr><tr><td>macOS 11+ (Apple Silicon and Intel)</td><td><a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-macos.dmg" rel="noopener">SculptForge.dmg</a></td><td>Open the disk image and drag SculptForge to Applications</td></tr><tr><td>macOS with <a href="https://brew.sh" rel="noopener">Homebrew</a></td><td><code>brew install --cask islandmed/tap/sculptforge</code></td><td>Updates with <code>brew upgrade</code></td></tr><tr><td>Ubuntu, Debian, Mint, Pop!_OS</td><td><a href="https://github.com/islandmed/SculptForge/releases/latest/download/sculptforge_amd64.deb" rel="noopener">.deb for x86_64</a> or <a href="https://github.com/islandmed/SculptForge/releases/latest/download/sculptforge_arm64.deb" rel="noopener">ARM64</a></td><td><code>sudo apt install ./sculptforge_amd64.deb</code></td></tr><tr><td>Fedora, RHEL, Rocky, Alma 8+</td><td><a href="https://github.com/islandmed/SculptForge/releases/latest/download/sculptforge.x86_64.rpm" rel="noopener">.rpm for x86_64</a> or <a href="https://github.com/islandmed/SculptForge/releases/latest/download/sculptforge.aarch64.rpm" rel="noopener">ARM64</a></td><td><code>sudo dnf install ./sculptforge.x86_64.rpm</code></td></tr><tr><td>Any Linux</td><td><a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-linux-x86_64.AppImage" rel="noopener">AppImage for x86_64</a> or <a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-linux-arm64.AppImage" rel="noopener">ARM64</a></td><td><code>chmod +x</code> the file, then run it</td></tr><tr><td>Any Linux, sandboxed</td><td><a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-linux-x86_64.flatpak" rel="noopener">Flatpak for x86_64</a> or <a href="https://github.com/islandmed/SculptForge/releases/latest/download/SculptForge-linux-arm64.flatpak" rel="noopener">ARM64</a></td><td><code>flatpak install --user ./SculptForge-linux-x86_64.flatpak</code>, or install from FlatPark to get updates (see <a href="#flatpak">Flatpak</a>)</td></tr><tr><td>Arch Linux</td><td><code>packaging/arch/PKGBUILD</code> in the source</td><td><code>makepkg -si</code> in that folder (the AUR package isn&#x27;t published yet; see <a href="#package-managers">Package managers</a>)</td></tr><tr><td>Studio pipelines</td><td><code>SculptForge-&lt;version&gt;-...-vfx2026.tar.gz</code> or <code>...-vfx2027.tar.gz</code></td><td>See <a href="studios.html">SculptForge for studios</a></td></tr></tbody></table></div>
<p>Most PCs are x86_64; ARM64 is for ARM laptops, Raspberry Pi and Apple Silicon Macs running Linux (it runs on 4, 16 and 64 KiB memory pages). Older versions are on the <a href="https://github.com/islandmed/SculptForge/releases" rel="noopener">releases page</a>.</p>
<h3 id="install-with-one-command">Install with one command<a class="anchor" href="#install-with-one-command" aria-label="Link to this section">#</a></h3>
<p>Instead of downloading by hand you can install (or update) with one command. On macOS and Linux it installs for your user only, with no administrator password:</p>
<div class="code-block"><pre class="code"><code class="language-sh">curl -fsSL https://raw.githubusercontent.com/islandmed/SculptForge/main/install/install.sh | sh</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>On Windows, in PowerShell (it downloads and starts the installer):</p>
<div class="code-block"><pre class="code"><code class="language-powershell">irm https://raw.githubusercontent.com/islandmed/SculptForge/main/install/install.ps1 | iex</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>Both check the download against the release&#x27;s checksums before installing. To uninstall on macOS or Linux, run the first command with <code>sh -s -- --uninstall</code> at the end instead of <code>sh</code>.</p>
<h3 id="package-managers">Package managers<a class="anchor" href="#package-managers" aria-label="Link to this section">#</a></h3>
<p>Where SculptForge is in a package manager today, so it updates with the rest of your system:</p>
<div class="table-wrap"><table><thead><tr><th>Package manager</th><th>Status</th><th>Command</th></tr></thead><tbody><tr><td>Homebrew (macOS)</td><td><strong>Available</strong></td><td><code>brew install --cask islandmed/tap/sculptforge</code>, then <code>brew upgrade</code></td></tr><tr><td>winget (Windows)</td><td><strong>Submitted, in review</strong> at winget-pkgs; not installable yet</td><td>Use the installer or the one-command install meanwhile</td></tr><tr><td>AUR (Arch Linux)</td><td><strong>Ready, not published yet</strong></td><td>Until then: <code>makepkg -si</code> in <code>packaging/arch</code></td></tr><tr><td>Omarchy</td><td><strong>Submitted, in review</strong> at omarchy-pkgs</td><td>As for Arch meanwhile</td></tr><tr><td>apt (Debian, Ubuntu) and dnf (Fedora, RHEL) repositories</td><td><strong>Not yet; being built</strong> (<a href="https://github.com/islandmed/SculptForge/issues/149" rel="noopener">#149</a>)</td><td>Install the <code>.deb</code> or <code>.rpm</code> file; SculptForge tells you when a new version is out</td></tr><tr><td>FlatPark (Linux)</td><td><strong>Available</strong> (x86_64, ARM64)</td><td><code>flatpak --user remote-add --if-not-exists flatpark https://dl.flatpark.org/flatpark.flatpakrepo</code> then <code>flatpak --user install flatpark org.sculptforge.SculptForge</code> (see <a href="#flatpak">Flatpak</a>)</td></tr></tbody></table></div>
<p>This table changes as each one goes live.</p>
<p>Every release also has a <code>SHA256SUMS.txt</code> file with the checksum of each download, so you can confirm a file arrived intact.</p>
<p>Each package contains two programs: <strong>SculptForge</strong>, the desktop application, and <strong>sculptforge-cli</strong>, the headless command-line tool for scripts, build farms and AI agents (see <a href="scripting.html">Scripting and automation</a>). On macOS the command-line tool sits inside the app bundle, at <code>SculptForge.app/Contents/MacOS/sculptforge-cli</code>.</p>
<h3 id="flatpak">Flatpak<a class="anchor" href="#flatpak" aria-label="Link to this section">#</a></h3>
<p>The Flatpak runs SculptForge in Flatpak&#x27;s sandbox and works on any distribution that has Flatpak (most do; see <a href="https://flatpak.org/setup/" rel="noopener">flatpak.org/setup</a> if yours doesn&#x27;t). The easiest way is from <a href="https://flatpark.org/" rel="noopener">FlatPark</a>, a community Flatpak repository that carries SculptForge&#x27;s official Linux build unmodified (x86_64 and ARM64):</p>
<div class="code-block"><pre class="code"><code class="language-sh">flatpak --user remote-add --if-not-exists flatpark https://dl.flatpark.org/flatpark.flatpakrepo
flatpak --user install flatpark org.sculptforge.SculptForge
flatpak run org.sculptforge.SculptForge</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>Or install the single file from the release: download it, then <code>flatpak install --user ./SculptForge-linux-x86_64.flatpak</code> (or <code>...-linux-arm64.flatpak</code>).</p>
<p>SculptForge then appears in your application menu. The first install also downloads the freedesktop runtime it runs on (a few hundred MB, shared with other Flatpak apps) from Flathub; both ways add Flathub for that if it isn&#x27;t set up. SculptForge itself is not on Flathub.</p>
<ul>
<li>
<strong>Updating</strong>: from FlatPark, new versions arrive with <code>flatpak update</code> (or your software center&#x27;s updates), usually within a day of each release, and SculptForge&#x27;s new-version notice shows that command. Installed from the file, download the new <code>.flatpak</code> and install it the same way. Your settings are kept either way.
</li>
<li>
<strong>Uninstalling</strong>: <code>flatpak uninstall org.sculptforge.SculptForge</code> (add <code>--delete-data</code> to remove its settings too).
</li>
<li>
<strong>Files</strong>: the sandbox can read and write your home folder, so projects, models and the textures beside them open as they would without it. Files elsewhere (another drive under <code>/mnt</code> or <code>/media</code>) open through the file dialog; to let SculptForge see a whole drive, run <code>flatpak override --user --filesystem=/mnt/data org.sculptforge.SculptForge</code>.
</li>
<li>
<strong>Settings</strong> live in <code>~/.var/app/org.sculptforge.SculptForge/</code>, not <code>~/.local/share/SculptForge</code>, so a Flatpak and another install of SculptForge on the same computer keep separate settings and brushes. Your library in Documents/SculptForge is shared.
</li>
<li>
<strong>Pen tablets and the SpaceMouse</strong> work in the sandbox.
</li>
<li>
<strong>Blender bridge</strong>: the add-on finds the Flatpak by itself and exchanges models through the usual folder.
</li>
<li>
<strong>Not in the sandbox</strong>: programs SculptForge starts on your computer, such as <code>ffmpeg</code> for recording demo videos and the splat trainer (<strong>Splat &gt; Train</strong>), are not visible to it. Use another package for those. Ollama, ComfyUI and other local AI servers work, because SculptForge talks to them over the network.
</li>
</ul>
<p>To build the Flatpak yourself from the source, install <code>flatpak</code> and <code>flatpak-builder</code> and run <code>packaging/flatpak/build.sh</code>; it writes <code>SculptForge-&lt;version&gt;-&lt;arch&gt;.flatpak</code>.</p>
<h2 id="windows">Windows<a class="anchor" href="#windows" aria-label="Link to this section">#</a></h2>
<p>Windows is where most SculptForge artists work. The notes below cover the first start, pen tablets and screen scaling.</p>
<h3 id="smartscreen">SmartScreen<a class="anchor" href="#smartscreen" aria-label="Link to this section">#</a></h3>
<p>The builds are not code-signed yet, so the first start may show &quot;Windows protected your PC&quot;.</p>
<ol>
<li>
Click <strong>More info</strong>.
</li>
<li>
Click <strong>Run anyway</strong>.
</li>
</ol>
<p>To confirm the file is the one we published, compare it with <code>SHA256SUMS.txt</code> on the release page.</p>
<h3 id="pen-tablets-windows-ink-and-wintab">Pen tablets: Windows Ink and Wintab<a class="anchor" href="#pen-tablets-windows-ink-and-wintab" aria-label="Link to this section">#</a></h3>
<p>SculptForge reads the pen through <strong>Windows Ink</strong>, the pen input built into Windows 10 and 11. When Windows Ink is off in the tablet driver, it takes the pressure from the driver&#x27;s <strong>Wintab</strong> instead. Either way works; Windows Ink also gives the eraser end and tilt.</p>
<ul>
<li>
<strong>Wacom</strong>: Wacom Tablet Properties &gt; <strong>Mapping</strong> &gt; <strong>Use Windows Ink</strong>. You can set it for SculptForge only by adding it as an application in Wacom Tablet Properties.
</li>
<li>
<strong>Huion, XP-Pen, Gaomon, Ugee</strong>: <strong>Windows Ink</strong> (sometimes &quot;Windows Ink mode&quot;) in the driver&#x27;s settings.
</li>
<li>
<strong>Pen displays and Surface-type pens</strong> use Windows Ink already.
</li>
</ul>
<p>Check it in <strong>Edit &gt; Preferences &gt; Tablet</strong>: it shows &quot;Pressure: on&quot; once the pen has pressed, or &quot;Pressure: not detected&quot;. A tablet plugged in while SculptForge runs works straight away. If pressure is missing, switch the driver&#x27;s Windows Ink option and bring the pen back to the tablet.</p>
<p><strong>Mouse mode.</strong> Most drivers map the pen to the screen (pen mode): where the pen touches is where the cursor goes. If you set the driver to <strong>Mouse</strong> (relative) mode, the pen moves the cursor by how far it moves, like a mouse. Turn on <strong>Edit &gt; Preferences &gt; Tablet &gt; Mouse mode (relative)</strong> to match it, or the cursor jumps when you put the pen down.</p>
<p>Pen side buttons work as the driver sets them; a button set to <strong>Right click</strong> opens the <a href="sculpting.html#the-quick-menu">Quick Menu</a>. More in <a href="troubleshooting.html#pen-tablets">Troubleshooting: pen tablets</a>.</p>
<h3 id="screen-scaling-dpi">Screen scaling (DPI)<a class="anchor" href="#screen-scaling-dpi" aria-label="Link to this section">#</a></h3>
<p>SculptForge follows the <strong>Scale</strong> in Windows&#x27; <strong>Settings &gt; System &gt; Display</strong>, so text and buttons have the same size as in other apps at 125%, 150% or 200%. To make the interface larger or smaller than that, choose a size in <strong>Edit &gt; Preferences &gt; Interface &gt; UI scale</strong> (<strong>Automatic</strong> follows Windows).</p>
<h3 id="where-files-go">Where files go<a class="anchor" href="#where-files-go" aria-label="Link to this section">#</a></h3>
<ul>
<li>
Settings, brushes and the log: <code>%APPDATA%\SculptForge\SculptForge</code> (<strong>Help &gt; Open log folder</strong> opens it).
</li>
<li>
Your library (projects, snapshots, alphas, Lit Spheres): <code>Documents\SculptForge</code>.
</li>
</ul>
<p>See <a href="troubleshooting.html#where-settings-live">Where settings live</a> for every file.</p>
<h2 id="opening-sculptforge-for-the-first-time">Opening SculptForge for the first time<a class="anchor" href="#opening-sculptforge-for-the-first-time" aria-label="Link to this section">#</a></h2>
<p>The builds are not code-signed yet, so your operating system may warn you the first time.</p>
<h3 id="macos-gatekeeper">macOS: Gatekeeper<a class="anchor" href="#macos-gatekeeper" aria-label="Link to this section">#</a></h3>
<p>macOS may say that SculptForge &quot;cannot be opened because the developer cannot be verified&quot;.</p>
<ol>
<li>
In Finder, open the Applications folder.
</li>
<li>
Right-click (or <kbd>Ctrl</kbd>+click) <strong>SculptForge</strong> and choose <strong>Open</strong>.
</li>
<li>
Click <strong>Open</strong> in the dialog that appears.
</li>
</ol>
<p>You only need to do this once. On recent macOS versions you may instead have to go to <strong>System Settings &gt; Privacy &amp; Security</strong> and click <strong>Open Anyway</strong> next to the message about SculptForge.</p>
<h3 id="windows-smartscreen">Windows: SmartScreen<a class="anchor" href="#windows-smartscreen" aria-label="Link to this section">#</a></h3>
<p>Windows may show &quot;Windows protected your PC&quot;. See <a href="#windows">Windows</a> below.</p>
<h3 id="linux">Linux<a class="anchor" href="#linux" aria-label="Link to this section">#</a></h3>
<p>The <code>.deb</code> and <code>.rpm</code> packages add SculptForge to your desktop&#x27;s application menu. An AppImage needs to be made executable first (<code>chmod +x SculptForge-*.AppImage</code>, or tick &quot;Allow executing file as program&quot; in your file manager&#x27;s properties).</p>
<h3 id="wayland-and-x11">Wayland and X11<a class="anchor" href="#wayland-and-x11" aria-label="Link to this section">#</a></h3>
<p>Every Linux package (.deb, .rpm, AppImage, Flatpak, tar.gz) opens as a native Wayland window on a Wayland desktop, without XWayland, and as a normal X11 window on an X11 session. On Wayland the window stays sharp at fractional and HiDPI scales (125%, 150%, 200%), and title bars come from the desktop (or from libdecor on GNOME).</p>
<p>To force X11 (for example, a screen recorder or remote-desktop tool that only captures X11 windows), start SculptForge with:</p>
<div class="code-block"><pre class="code"><code class="language-sh">SDL_VIDEO_DRIVER=x11 sculptforge</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>Pen tablets work on both. On Wayland, pressure, tilt, the eraser end and side buttons come through the desktop&#x27;s tablet protocol (tablet-v2), so the tablet must be set up in your desktop&#x27;s settings rather than through X11 tools such as <code>xsetwacom</code>. If pressure doesn&#x27;t respond, check <strong>Edit &gt; Preferences &gt; Tablet</strong> for the live pressure reading.</p>
<h2 id="what-you-see-at-start-up">What you see at start-up<a class="anchor" href="#what-you-see-at-start-up" aria-label="Link to this section">#</a></h2>
<p>SculptForge opens a 1600 x 960 window with a sphere ready to sculpt and the <strong>Library</strong> open along the top of the canvas on its <strong>Project</strong> tab, so you can reopen recent work with a double-click. Press <kbd>,</kbd> (comma) to close it, or turn off <strong>Edit &gt; Preferences &gt; Library &gt; Show at startup</strong>. The first start also creates your library folder (<strong>Documents/SculptForge</strong>, with Projects, Tools, Brushes, Alphas, Lit Spheres, Images, Splats and QuickSave (snapshots) sub-folders), which the Library shows as <strong>User</strong>.</p>
<p>The first start also asks what you are <strong>Coming from</strong>: <strong>Classic sculpting keys</strong>, <strong>Blender</strong>, <strong>Maya</strong> or <strong>New to sculpting</strong>. Your answer picks the key style: <strong>Classic sculpting keys</strong> turns on the Classic sculpting keys, <strong>Blender</strong> and <strong>Maya</strong> their own styles, and <strong>New to sculpting</strong> keeps the SculptForge keys (the default). Change it any time in <strong>Edit &gt; Preferences &gt; Input &gt; Style</strong> (see <a href="shortcuts.html">Keyboard and mouse</a>); if you are updating from an earlier version, your saved style is kept and the question isn&#x27;t asked.</p>
<p>You can open a file directly from the command line, too: <code>sculptforge model.obj</code> (or a <code>.glb</code>, <code>.sfproj</code>, splat capture or image). <code>sculptforge --fullscreen</code> starts filling the screen; <code>sculptforge --help</code> lists every option.</p>
<p>The next chapter, <a href="interface.html">The interface</a>, explains what everything on screen does.</p>
<h2 id="updating-and-uninstalling">Updating and uninstalling<a class="anchor" href="#updating-and-uninstalling" aria-label="Link to this section">#</a></h2>
<p>SculptForge tells you when there is a new version. Once a day at start-up it downloads a small file from its website that names the newest version; if yours is older, a banner at the top of the 3D view says what&#x27;s new, with <strong>What&#x27;s new</strong>, <strong>Download</strong>, <strong>Later</strong> and <strong>Skip this version</strong>. Nothing about you or your computer is sent. <strong>Help &gt; Check for updates</strong> asks right away, and <strong>Edit &gt; Preferences &gt; Updates</strong> turns the daily check off (and picks the update channel: <strong>Stable</strong>, or <strong>Preview</strong> for the betas).</p>
<p><strong>One-click update.</strong> The Linux AppImage and the Windows installer and portable zip also get an <strong>Update</strong> button on the banner. It downloads the new version in the background (with a progress bar and <strong>Cancel</strong>), checks it, and then asks: <strong>Restart now</strong> installs it and starts the new version; <strong>Later</strong> installs it when you quit, so the next start is the new version. If you have unsaved changes, Restart now asks first, as quitting does.</p>
<p>What the check means: the files come only from SculptForge&#x27;s own GitHub releases, over a checked secure connection; the release&#x27;s list of checksums must carry the SculptForge release signature (a key built into the app); and the download must match its checksum. If any of that fails, nothing is changed and nothing downloaded is run: the banner says what went wrong and <strong>Download</strong> still opens the release page. The current version is kept beside the new one (the AppImage as <code>&lt;name&gt;.AppImage.old</code>, the portable folder as <code>&lt;folder&gt;.old</code>) until the new version has started once, then removed; if the new version doesn&#x27;t start, the old one is put back. The Windows installer asks for permission to change Program Files, as installing does.</p>
<p><strong>Member builds.</strong> Members get each release early. In <strong>Edit &gt; Preferences &gt; Updates &gt; Member builds</strong>, click <strong>Sign in with GitHub</strong>: SculptForge shows a short code; open <strong>github.com/login/device</strong>, sign in with the GitHub account that accepted the invitation to the member repository, and enter the code. From then on the update check also offers the member builds, and <strong>Update</strong> installs them exactly like releases, with the same signature check. The sign-in can only read the member repository&#x27;s releases (nothing else on your GitHub account), it is kept in your system&#x27;s keychain (Windows Credential Manager, or the Secret Service on Linux such as GNOME Keyring or KWallet; never in SculptForge&#x27;s settings), and <strong>Sign out</strong> removes it. Without a keychain the sign-in lasts until you quit.</p>
<p>Installs that belong to a package manager are never replaced by the app: the Arch PKGBUILD (and the AUR and Omarchy packages once they are published) builds without the update check, a Homebrew install shows <code>brew upgrade --cask sculptforge</code>, and the Flatpak, <code>.deb</code> and <code>.rpm</code> files say to download the new file and open it (a Flatpak from FlatPark shows <code>flatpak update</code>). The macOS app shows <strong>Download</strong> for now.</p>
<p>To update by hand, download the new release and install it over the old one. Either way your settings, brushes and library are kept: they live in your user folders, not next to the program (see <a href="troubleshooting.html">Troubleshooting and FAQ</a> for where).</p>
<p>To uninstall, use your system&#x27;s usual method (Settings &gt; Apps on Windows, dragging the app to the Bin on macOS, <code>sudo apt remove sculptforge</code> or <code>sudo dnf remove sculptforge</code> on Linux, <code>flatpak uninstall org.sculptforge.SculptForge</code> for the Flatpak, or delete the AppImage). Delete the settings and library folders as well if you want to remove everything.</p>
<h2 id="building-from-source">Building from source<a class="anchor" href="#building-from-source" aria-label="Link to this section">#</a></h2>
<p>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&#x27;t installed already) SDL3 are downloaded automatically. AI features use libcurl on Linux and macOS and the built-in WinHTTP on Windows.</p>
<div class="code-block"><pre class="code"><code class="language-sh">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</code></pre><button class="copy" type="button" aria-label="Copy">Copy</button></div>
<p>On Windows the program is <code>build\Release\sculptforge.exe</code>; on macOS run <code>open build/SculptForge.app</code>.</p>
<p>Useful CMake options:</p>
<div class="table-wrap"><table><thead><tr><th>Option</th><th>Default</th><th>What it does</th></tr></thead><tbody><tr><td><code>SCULPTFORGE_BUILD_APP</code></td><td><code>ON</code></td><td>Build the desktop application (turn off for a headless build of <code>sculptforge-cli</code> only)</td></tr><tr><td><code>SCULPTFORGE_BUILD_PYTHON</code></td><td><code>OFF</code></td><td>Build the Python module (<code>import sculptforge</code>); needs Python development headers</td></tr><tr><td><code>SCULPTFORGE_BUILD_TESTS</code></td><td><code>ON</code></td><td>Build the unit and UI tests</td></tr><tr><td><code>SCULPTFORGE_USE_SYSTEM_SDL</code></td><td><code>ON</code></td><td>Use an installed SDL3 if one is found</td></tr></tbody></table></div>
<p>Running <code>cpack</code> in the build folder makes the platform&#x27;s packages (<code>.deb</code>, <code>.rpm</code> and <code>.tar.gz</code> on Linux, a <code>.dmg</code> on macOS, an installer and a <code>.zip</code> on Windows).</p>
<h2 id="see-also">See also<a class="anchor" href="#see-also" aria-label="Link to this section">#</a></h2>
<ul>
<li>
<a href="interface.html">The interface</a>
</li>
<li>
<a href="troubleshooting.html">Troubleshooting and FAQ</a>
</li>
<li>
<a href="studios.html">SculptForge for studios</a>
</li>
</ul>
      </article>
      <nav class="pager" aria-label="Previous and next chapter"><a class="prev" rel="prev" href="quick-tour.html"><span>Previous</span>Quick tour for experienced sculptors</a><a class="next" rel="next" href="interface.html"><span>Next</span>The interface</a></nav>
      <p class="guide-meta fine">Also in the app: <strong>Help &gt; User Guide</strong> (<kbd>Shift</kbd>+<kbd>F1</kbd>).
        Found a mistake? <a href="https://github.com/islandmed/SculptForge/edit/main/docs/guide/installing.md">Edit this page on GitHub</a>.</p>
    </main>
    <aside class="on-page" aria-label="On this page"><p>On this page</p><ul><li><a href="#system-requirements">System requirements</a></li><li><a href="#download">Download</a></li><li><a href="#windows">Windows</a></li><li><a href="#opening-sculptforge-for-the-first-time">Opening SculptForge for the first time</a></li><li><a href="#what-you-see-at-start-up">What you see at start-up</a></li><li><a href="#updating-and-uninstalling">Updating and uninstalling</a></li><li><a href="#building-from-source">Building from source</a></li><li><a href="#see-also">See also</a></li></ul></aside>
  </div>
  <footer class="footer">
    <div class="wrap footer-grid">
      <div>
        <a class="brand" href="../index.html"><img class="brand-mark" src="../img/bust-mark-44.png" srcset="../img/bust-mark-88.png 2x, ../img/bust-mark-132.png 3x" width="32" height="32" alt=""><span>SculptForge</span></a>
        <p class="fine">Copyright © 2026 The SculptForge contributors.<br>The SculptForge User Guide is part of
          SculptForge, licensed under the <a href="https://github.com/islandmed/SculptForge/blob/main/LICENSE">GNU GPL v3.0 or later</a>.</p>
      </div>
      <div class="links">
        <a href="../performance/">Performance</a>
        <a href="index.html">User guide</a>
        <a href="../supporters.html">Members</a>
        <a href="https://github.com/islandmed/SculptForge">Source code</a>
        <a href="https://discord.gg/gWrYkEmQhH">Community Discord</a>
        <a href="https://github.com/islandmed/SculptForge/issues">Report a problem</a>
        <a href="https://github.com/islandmed/SculptForge/blob/main/docs/ai-services.md">AI services &amp; privacy</a>
      </div>
      <p class="fine trademarks">SculptForge is an independent project. Product names are trademarks of their respective owners.</p>
    </div>
  </footer>
</body>
</html>