Full guide (English)

A DRAWING YOU CAN KEEP

Save your plan.
Make it yours.

Draw and preview your home on this website. Export a JSON file to keep an editable copy you can reopen or share.

No account, Python or installation is needed to use the hosted planner. Your draft stays in this browser. Export downloads a copy without removing the draft; your project is not automatically published or synced to another device.

01 · KEEP AN EDITABLE COPY

Export before you leave

  1. In the planner, choose Export JSON. Your browser downloads project.json.
  2. Move the file from Downloads to a folder you will remember. Rename it to describe the version, such as my-home-first-draft.json.
  3. To check the backup, choose Open JSON and select that file. Confirm that the rooms and items look right in Plan 2D and Preview 3D.

The file stores the editable project: floors, room shapes, walls, openings, items and any entity IDs you entered. Exporting does not create a separate website, a 3D model download or a Home Assistant package.

Where your drawing lives

Your drawing is saved in this browser profile. It is not uploaded. Browser storage belongs to the website origin; other project pages under the same ha-homelab.github.io origin share that storage boundary. A different browser, device or domain has a separate draft.

Home studio adds no analytics, advertising or project sync. GitHub serves the static website and logs visitor IP addresses for security; see GitHub's hosting notice. Do not enter passwords or tokens in your project.

02 · LET SOMEONE OPEN THEIR OWN COPY

Share the drawing file

Send your exported JSON file and the link to this planner to someone you choose. They can select Open JSON and explore their own editable copy. Their edits do not change your draft; they can export a new version to send back.

A link to this website opens the planner, not your saved home. There is no account, shared project link or live collaboration in this release.

Before sharing a file, review its room names, item notes and entity IDs. An exported project contains the details you entered. Keep a private backup of the original.

03 · FROM DRAWING TO INSTALLED PANEL

Take your plan into Home Assistant

The complete public toolkit includes a local compiler, a Home Assistant integration, and its installer. Keep your exported JSON, download the complete ZIP, and follow the installation guide.

In the browser
Draw, preview, and save editable JSON. Entering an entity ID records a mapping; this editor does not connect to or control Home Assistant.
On your computer
Python 3.10+ builds your private viewer, model exports, and installation archive. The compiler and installer need no extra Python packages.
In Home Assistant
Install the component, add its YAML entry, check configuration, and restart. Administrators can open 3D Home and link items to their own entities.

The Build & install dialog provides the export and build command. The guide covers local installation, Home Assistant OS file transfer, backups, and updates. These steps run outside the browser and do not need a Home Assistant token.

Build and install your home

Optional: use a local copy

Use the downloaded toolkit's editor offline

The hosted planner needs no setup. To use a downloaded copy, extract the complete ZIP and keep its folders together. From the extracted toolkit folder, run:

python3 -m http.server 8099 --bind 127.0.0.1

Open http://127.0.0.1:8099/planner/ and keep the terminal running while you draw. Double-clicking index.html is not supported.

Use Export JSON and Open JSON to move your drawing between the hosted and local copies; their browser storage is separate. The toolkit also includes the compiler and installer; run those separately in your terminal when you follow the installation guide.