Browse the docs
FloorPlanCraft docs
Plan your space, furnish it, share it and show it live. New here? Start with the first section.
Getting started
What FloorPlanCraft is, how to start a plan and find your way around the planner.
- What FloorPlanCraft isA web floor planner for commercial spaces: draw the space, furnish it from catalogs made for your business, and see it in 3D.
- Start a planOpen 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 plannerFind your way around the planner: the 2D, 3D and walkthrough views, the top bar, the tool bar, the drawers and the Inspect card.
- Keyboard shortcutsEvery 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, walls, doors, windows, levels and stairs.
- Rooms and wallsPlace 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 exitsAdd 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 stairsAdd 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 viewPlace columns, mark zones, resize the whole venue, and control the 2D view: zoom, pan, the grid, snapping and what is shown.
Furnishing
Add, arrange and swap items, and read the plan check.
- Add and arrange itemsPlace 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 itemTrade 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 clearancesRead 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
Floors and paint, the 3D view and the walkthrough.
- Paint walls and change floorsChange 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 3DTurn 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 planWalk 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, saving, your plans, sharing, embedding and export.
- Accounts and signing inWhat 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 planSave 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 plansUse 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 planSend 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
Show your venue's tables, bookings or play zones live on your plan.
- What Live 3D isLive 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 appApprove 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 viewWhat the live view shows: live or last seen, service days, replays and speed, labels, floor status, recent events and the legend.
- Fix Live 3D problemsFix 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
Connect a restaurant, booking or play venue app to Live 3D.
- Developer overviewHow a restaurant, booking or play venue app connects to FloorPlanCraft, pushes live status and shows the live 3D floor inside the app.
- Connect an appSend a connect request, let the venue owner approve it in FloorPlanCraft, then exchange the code with PKCE for a connection id and secret.
- Signing requestsSign pushes, embed address requests, table sync and disconnect with HMAC-SHA256 over the method, path, timestamp and exact body bytes.
- Live updatesPush the venue's floor to FloorPlanCraft: feed pushes, heartbeats, service days, sequence numbers, events and what each answer tells your app.
- Backfill and exit timesRe-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 viewShow 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 highlightsMessages 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 errorsDisconnect 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
Use these docs with a coding agent, and prompts to connect your own system.
- Using these docs with an AI agentHow 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 systemCopyable 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
Short answers to common questions.
For AI agents: /llms.txt lists every page, and every page is also Markdown (add .md to its address). /llms-full.txt holds them all in one file.