# FloorPlanCraft

> FloorPlanCraft is a web floor planner for commercial spaces: restaurants, cafés, indoor playgrounds, gyms, salons, clinics, classrooms, shops, offices, warehouses and more, in 2D, 3D and a first-person walkthrough. Its plans are concept layouts, not certified architectural, engineering, safety or code documents.

Every docs page is also plain Markdown: add `.md` to its address (`https://floorplancraft.com/docs/<page>.md`) or ask for it with `Accept: text/markdown`. Everything in one file: https://floorplancraft.com/llms-full.txt

## Getting started

- [What FloorPlanCraft is](https://floorplancraft.com/docs/what-is-floorplancraft.md): A web floor planner for commercial spaces: draw the space, furnish it from catalogs made for your business, and see it in 3D.
- [Start a plan](https://floorplancraft.com/docs/start-a-plan.md): Open a furnished template, a ready plan at a common size, or one blank room, as a guest or signed in to your account.
- [A tour of the planner](https://floorplancraft.com/docs/planner-tour.md): Find your way around the planner: the 2D, 3D and walkthrough views, the top bar, the tool bar, the drawers and the Inspect card.
- [Keyboard shortcuts](https://floorplancraft.com/docs/keyboard-shortcuts.md): Every keyboard shortcut in the planner, grouped by where it works: the 2D plan, the item card, the 3D view, painting and the walkthrough.

## Drawing the space

- [Rooms and walls](https://floorplancraft.com/docs/rooms-and-walls.md): Place and size rooms, let rooms share walls, join or delete rooms, draw walls that divide a room, and change a wall from its card.
- [Doors, windows and exits](https://floorplancraft.com/docs/doors-windows-and-exits.md): Add doors and windows to walls, choose a door's type and swing, size and move openings, and mark a door as an exit.
- [Floors and stairs](https://floorplancraft.com/docs/floors-and-stairs.md): Add floors to a building, set each floor's name, elevation and ceiling height, and connect floors with stairs you can walk.
- [Columns, zones, venue size and the view](https://floorplancraft.com/docs/more-drawing-tools.md): Place columns, mark zones, resize the whole venue, and control the 2D view: zoom, pan, the grid, snapping and what is shown.

## Furnishing

- [Add and arrange items](https://floorplancraft.com/docs/add-and-arrange-items.md): Place furniture and equipment from your plan's catalog, then move, turn, duplicate, align and remove items on the plan or from the item card.
- [Swap an item](https://floorplancraft.com/docs/swap-an-item.md): Trade an item for a similar one from the same catalog without moving it: same spot, same facing, one undo step for each swap.
- [Plan check and clearances](https://floorplancraft.com/docs/plan-check-and-clearances.md): Read the plan check: what blocking issues, warnings and info notes mean, how Space around shows and fixes gaps, and why it is guidance only.

## Finishes and 3D

- [Paint walls and change floors](https://floorplancraft.com/docs/materials-and-paint.md): Change paint, wallpaper, prints and floors with Materials in the 3D view, on a surface's card in 2D, or from the Finishes list.
- [Look at your plan in 3D](https://floorplancraft.com/docs/the-3d-view.md): Turn and zoom the 3D model, choose how walls show, preview themes, time and Golden light, change items, present it and save a picture.
- [Walk through your plan](https://floorplancraft.com/docs/walk-through-your-plan.md): Walk through your plan at eye level: start and pause, move with the keys and mouse, pick a start room, paint walls and preview light.

## Saving and sharing

- [Accounts and signing in](https://floorplancraft.com/docs/accounts-and-signing-in.md): What works without an account, how to create one, sign in and out, bring a guest draft with you, and get help with your account.
- [Save your plan](https://floorplancraft.com/docs/saving-your-plan.md): Save a plan to your account, read the save status, see when the planner saves by itself, and what happens to a guest's draft.
- [Manage your plans](https://floorplancraft.com/docs/your-plans.md): Use the plan library to open, duplicate, archive, restore and delete your saved plans, and see what each does to a shared link.
- [Share and export a plan](https://floorplancraft.com/docs/share-and-export.md): Send a view-only link, see what viewers can do, unshare it, save a picture as a guest, and download PNG, PDF, SVG or JSON files.

## Live 3D

- [What Live 3D is](https://floorplancraft.com/docs/what-is-live-3d.md): Live 3D shows your venue app's tables, bookings or play zones live on your shared plan in 3D, with replays of past service days.
- [Connect your venue app](https://floorplancraft.com/docs/connect-your-app.md): Approve a restaurant, booking or play venue app, choose the plan it shows, choose its sites, switch on Live 3D and disconnect it.
- [Read the live view](https://floorplancraft.com/docs/the-live-view.md): What the live view shows: live or last seen, service days, replays and speed, labels, floor status, recent events and the legend.
- [Fix Live 3D problems](https://floorplancraft.com/docs/live-3d-troubleshooting.md): Fix common Live 3D problems: a missing plan, the wrong account, expired requests and links, a venue that is not live, and Live 3D off.

## Developers

- [Developer overview](https://floorplancraft.com/docs/developer-overview.md): How a restaurant, booking or play venue app connects to FloorPlanCraft, pushes live status and shows the live 3D floor inside the app.
- [Connect an app](https://floorplancraft.com/docs/connect-an-app.md): Send a connect request, let the venue owner approve it in FloorPlanCraft, then exchange the code with PKCE for a connection id and secret.
- [Signing requests](https://floorplancraft.com/docs/signing-requests.md): Sign pushes, embed address requests, table sync and disconnect with HMAC-SHA256 over the method, path, timestamp and exact body bytes.
- [Live updates](https://floorplancraft.com/docs/live-updates.md): Push the venue's floor to FloorPlanCraft: feed pushes, heartbeats, service days, sequence numbers, events and what each answer tells your app.
- [Backfill and exit times](https://floorplancraft.com/docs/backfill-and-exit-times.md): Re-send a past range of a service day after an error, and send when each party leaves so the live view can estimate the floor while your app is offline.
- [Embedding the live view](https://floorplancraft.com/docs/embed-the-live-view.md): Show the venue's live 3D floor inside your app: mint a short-lived embed address, frame it, renew it when it expires, or frame the plan alone.
- [Table clicks and highlights](https://floorplancraft.com/docs/table-clicks-and-highlights.md): Messages between the 3D embeds and your page: learn which table a guest clicked, and colour the tables your app offers, selects or blocks.
- [Disconnect and errors](https://floorplancraft.com/docs/disconnect-and-errors.md): Disconnect your app, react when the venue owner disconnects it, and handle every error code, check, rate limit and body limit of the API.

## AI agents

- [Using these docs with an AI agent](https://floorplancraft.com/docs/docs-for-ai-agents.md): How a coding agent or chatbot reads FloorPlanCraft's docs as Markdown: llms.txt, llms-full.txt, .md addresses and Accept: text/markdown.
- [Prompts to connect your system](https://floorplancraft.com/docs/agent-prompts.md): Copyable prompts that tell a coding agent how to connect a play venue POS, a restaurant POS or a booking app to FloorPlanCraft Live 3D.

## Questions

- [Questions](https://floorplancraft.com/docs/faq.md): Short answers about accounts, saving, versions, sharing, exports, blank plans, finishes, the walkthrough, phones and Live 3D.
