Using Sweet Home 3D furniture models
The site can use models from Sweet Home 3D's free furniture libraries next to the generated props.
Two scripts in tools/blender/ do the work (paths here are relative to the Popfold folder):
| Script | Runs in | Does |
|---|---|---|
sh3d_catalog.py | Python 3 + Pillow | Unpacks .sh3f libraries, writes catalog.json, preview sheets and index.tsv |
sh3d_to_glb.py | Blender 4.2+ (tested 5.3) | Converts one catalogue entry to a GLB prop plus a credits JSON |
Use a working folder outside any repository (about 190 MB packed, more unpacked). Below it is <sh3d>.
1. Download the libraries
Source mirror: https://github.com/YoannDev90/SweetHome3D-Packs (same libraries as sweethome3d.com).
The .sh3f files are plain files in the repo, so use raw.githubusercontent.com (the LFS media URL returns 404):
$root = '<sh3d>'; New-Item -ItemType Directory -Force "$root\packs" | Out-Null
foreach ($p in 'BlendSwap-CC-0','BlendSwap-CC-BY','Contributions','KatorLegaz','LucaPresidente','Reallusion','Scopia','Trees') {
curl.exe -sSL --fail -o "$root\packs\$p.sh3f" "https://raw.githubusercontent.com/YoannDev90/SweetHome3D-Packs/main/Furnitures/$p.sh3f"
}
Each .sh3f is a zip: PluginFurnitureCatalog.properties plus one folder per model (OBJ + MTL + textures) and a PNG icon.
2. Catalogue and pick
python tools/blender/sh3d_catalog.py --root <sh3d>
Writes extracted/<pack>/, catalog.json (every field of every model) and preview/<group>.jpg sheets with a code under each icon.
Codes are pack letters + catalogue number: B0 BlendSwap CC-0, BB BlendSwap CC-BY, C Contributions, K Kator Legaz,
L Luca Presidente, R Reallusion, S Scopia, T Trees. So C178 is Contributions #178.
Add --group NAME "regex" to make a sheet for something specific (matched against name and tags).
Each run rewrites preview/index.tsv with only the groups of that run (the sheets for other groups stay).
Already-unpacked packs are not extracted again.
Run it with the working directory outside extracted/ (as above): the archives are third-party data.
3. Convert one model
blender -b --factory-startup --python tools/blender/sh3d_to_glb.py -- `
--pack <sh3d>\extracted\Contributions --index 178 `
--out <site>/public/models/props/sh3d/toronto-ontario-place-frame.glb
The last output line starts with SH3D_TO_GLB_OK followed by the metadata. Output:
<name>.glb: one mesh, one material per OBJ material, textures embedded. Same convention as the generated props: glTF Y-up, front faces +Z, origin at the centre of the base, longest side = 1 unit, metalness 0, roughness 0.6 (--roughnessto change).<name>.json: name, creator, license, pack, index, real size in cm,elevation_cm(Sweet Home 3D's default height off the floor; non-zero means a wall or shelf piece), triangle count.
How the conversion matches Sweet Home 3D: the OBJ is Y-up with its front toward +Z; the catalogue's optional
modelRotation (3x3, row-major) is applied first; then the bounding box is stretched to the catalogue
width x height x depth. All 1,510 models in these packs are OBJ.
4. Use it in the site
- Add the name with its folder to a home's
propslist, e.g.'sh3d/toronto-ontario-place-frame'. A name with a folder loads from the site's shared props folder (models/props/unless the recipe setssharedDir), so every home can use it. - Place it like any prop in the home's
furnish():ctx.gen('sh3d/<name>', size)returns a group (ornullif the file failed to load).sizeis the longest side in scene units. The rooms are 4 units wide with 2.2-unit walls; compare with nearby props rather than converting the real size from the JSON literally (the home is toy-scaled). Floor pieces go onleft.drawer/right.drawer/rootaty = fyory0; wall pieces go onleft.wall/right.wallat a smallz(about 0.14) so they sit on the wallpaper. The centre room's back wall is the open lid: add pieces tolidwithrotation.x = Math.PI / 2,y = -0.04, andz= height of the piece's bottom edge along the lid. gen()keeps the model's own roughness and sets metalness to 0.- Add a line to the site's
CREDITS.mdfrom the JSON (creator, model name, license). CC-BY models need it.
Gotchas
- Sweet Home 3D models are realistic and plainly textured; they usually need recolouring to match either theme. Small textures (some are 320 px) are fine for small wall pieces only.
- The dev server picks up new files in
public/on reload; no restart needed. - Keep the
--outfile name lowercase with dashes; it becomes the prop name.