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.
User guide tools
The user guide lives in docs/guide (Markdown, one file per chapter, index.md lists them in order). The
same files feed three places:
- The app:
cmake/EmbedGuide.cmakeembedsdocs/guide/*.mdanddocs/guide/images/*in the binary;src/app/UserGuide.cppshows them (Help > User Guide, Shift+F1). While writing, setSCULPTFORGE_GUIDE_DIR=docs/guideto read the files from disk without rebuilding. - The website:
python3 tools/guide/build_site.pywriteswebsite/guide/*.html(and copies the images). - Tests:
ctestrunsguide_site(every link, anchor and image resolves, only characters the app's font has) andui_guide_shortcuts(the keyboard table matches the app);tests/test_guide.cppcovers the parser andtests/ui/user_guide.sfuithe reader.
Write only the Markdown subset described at the top of src/core/Guide.h (the reader renders nothing else),
in ASCII or Latin-1 characters.
Regenerating
# Keyboard table in shortcuts.md, from the app's action registry
python3 tools/guide/update_shortcuts.py --app build/sculptforge
# Screenshots: drive the real UI, then crop, label and compress them into docs/guide/images (needs Pillow)
build/sculptforge --ui-test tools/guide/shots.sfui --ui-out build/guide-shots
python3 tools/guide/make_images.py build/guide-shots --preview build/guide-shots/sheet.png
# Website pages
python3 tools/guide/build_site.py --check
Crop rectangles for each image are in make_images.py; if the UI layout changes, look at the preview sheet and
adjust them. Re-run cmake after adding or removing guide files so the app embeds them.
Menu paths
The guide names the default SculptForge layout's menus: Edit > Preferences > Input, Sculpt > Stroke,
Render > Materials. Tool > ... paths stay, since the Tool palette is in the right tray in both layouts.
python3 tools/guide/menu_paths.py rewrites classic palette paths (Preferences > Input) in every
chapter; ctest guide_menu_paths fails while any are left.
Feature panels
Bake, fill layers, PBR, the UV Editor, Performance and other feature images come from the feature UI tests, run in the default look (tests written for the Classic look run from a converted copy):
python3 tools/guide/feature_shots.py --app build/sculptforge --out build/guide-features
python3 tools/guide/make_images.py build/guide-shots --features build/guide-features