homeplanr

A fast, local-first home planning app — draw floor plans in 2D, furnish them from a built-in catalog, and walk around the result in 3D. Built with Tauri 2, React, and three.js. Linux first, Windows too.

🚧 v0.2 — young but functional. Feedback and issues welcome.

Features

• 2D floor-plan editor — click-click wall drawing with live lengths and 0/45/90° assist, mitered wall joins, automatic room detection with areas, doors and windows that slide along walls, snapping (nodes, grids, alignment guides, back-against-wall capture with corner composition)
• Measurements — live pills while dragging (opening gaps, furniture-to-wall distances, wall lengths), a tape-measure tool, and permanent wall-dimension labels; lengths in meters, centimeters, or feet-and-inches
• Furniture catalog — 35 procedural items (living, bedroom, dining, kitchen, bathroom, office), each with an isometric thumbnail rendered from its real 3D model; drag onto the plan or click-to-place; resize, rotate, flip, duplicate, copy/paste, nudge
• Materials — per-side wall paint (14 colors) with brick/concrete/tile finishes, and 11 floor materials with procedural textures — pick in 2D, see in 3D
• 3D view — the same document rendered live: walls with door/window openings cut, glass and frames, soft shadows; orbit/zoom with a fitted camera — or press Walk and stroll through the plan in first person with real collision
• Export — the 2D plan as PNG or SVG, the 3D view as a screenshot
• Theming — light/dark (follows the system) with six accent colors
• Local-first files — projects are plain-JSON .homeplanr files with native Save/Open dialogs, double-click file association, recents, autosaved crash recovery, and an unsaved-changes guard; project files migrate forward automatically — 0.1.0 files open in every future version, upgraded on next save; no accounts, no cloud, works offline
• Deep undo/redo — every gesture is exactly one undo step

Controls

Input	Action
V / W / D / N / M	Select · draw walls · place door · place window · tape measure
Click-click (wall tool)	Place wall points; click the start to close a room; Enter ends; Backspace steps back
Drag / R / handle	Move · rotate 90° · free-rotate with 15° detents (Ctrl = free)
Ctrl+D / Ctrl+C Ctrl+V / F	Duplicate · copy/paste at the cursor · flip
Arrows	Nudge selected furniture 1 cm (Shift = 10 cm); with nothing selected, pan (Shift = faster)
Del	Delete selection (walls cascade their openings)
Left-drag on empty canvas	Pan (a plain click still deselects)
Wheel / Ctrl+wheel	Zoom to cursor (touchpad pinch works)
Shift+wheel / middle-drag / Space+drag	Pan
+ / −	Zoom about the view center (on-canvas − / % / + / Fit cluster too)
Shift+1	Zoom to fit
Shift+D	Toggle wall-dimension labels
Ctrl+Z / Ctrl+Shift+Z	Undo / redo
Ctrl+N / Ctrl+O / Ctrl+S / Ctrl+Shift+S	New · open · save · save as
Gear button	Options — theme, accent color, units (m / cm / ft-in)
Esc	Cancel gesture → leave tool → deselect
Alt+click or repeat-click	Cycle overlapping items (some Linux WMs grab Alt+drag — repeat-click always works)
3D: Walk button	Click a floor to walk there; WASD/arrows move (Shift sprints), drag looks, click teleports, Esc exits
3D: Save image	Save the current 3D view as a PNG
File → Export PNG… / SVG…	Export the 2D plan as an image

Two-finger touchpad scroll zooms (CAD convention); pan with Space-drag.

Install

Grab the latest build from Releases:

• Linux .deb (Debian/Ubuntu) — recommended; small (~10 MB), uses the system WebKitGTK: sudo apt install ./homeplanr_*.deb
• Linux AppImage — self-contained (~70–120 MB). Requires the FUSE 2 runtime: Arch sudo pacman -S fuse2, Debian/Ubuntu sudo apt install libfuse2 — or run with --appimage-extract-and-run
• Windows installer (*-setup.exe) — builds are unsigned, so SmartScreen will warn: choose More info → Run anyway. First install downloads the WebView2 runtime if missing (needs network once)

File association: the .deb/.rpm and the Windows installer register the .homeplanr extension — double-clicking a project opens it (a second launch focuses the running window instead of starting another). The AppImage only gets the association once you integrate it into your desktop, e.g. with Gear Lever.

Linux troubleshooting: if the 3D view reports a WebGL failure, launch with WEBKIT_DISABLE_DMABUF_RENDERER=1 homeplanr (or WEBKIT_DISABLE_COMPOSITING_MODE=1). The 2D editor works regardless.

Develop

Prerequisites: Node ≥ 22 (.nvmrc says 26), Rust stable + cargo, and on Linux the Tauri prerequisites (webkit2gtk-4.1, gtk3, librsvg, base-devel/build-essential…).

git clone https://github.com/kapuchai/homeplanr && cd homeplanr
npm ci
npm run tauri dev      # native window with hot reload
npm run dev            # browser-only mode (file dialogs become downloads)
npm test               # vitest — geometry/model/store/tool suites
npm run typecheck && npm run lint

The file format is versioned, pretty-printed JSON — a .homeplanr file is diffable and safe to keep in git.

Architecture (short version)

One document store (zustand + immer + zundo) is the single source of truth; src/geometry/ derives mitered wall outlines, detected rooms, and 3D wall prisms from it with per-entity reference stability; the SVG 2D editor and the react-three-fiber 3D view are two renderers over the same derived data. Conventions (units, coordinate frames, winding) live in src/model/README.md and are pinned by tests.

License

MIT