> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ploterr.com/llms.txt
> Use this file to discover all available pages before exploring further.

# What is Floorkit?

> A browser-based TypeScript SDK for editable building models, floor plans, and drawing sheets. A Ploterr product powered by OpenGeometry.

Floorkit is a Ploterr product powered by OpenGeometry. It is a browser-based TypeScript SDK for apps that create and edit building models, floor plans, and drawing sheets.

People and AI agents can work with the same saved building data. Your app chooses its workflow and AI provider.

Your application owns the user interface. Floorkit gives you the geometry, the building model, the editor and the drawings.

## What is in the box

<CardGroup cols={2}>
  <Card title="Editor" icon="pen-ruler" href="/floorkit/concepts/editing-and-history">
    Draw walls, place doors and windows, and shape rooms. Edit the same model in 2D and in 3D, with
    undo and redo.
  </Card>

  <Card title="Drawings and sheets" icon="file-lines" href="/floorkit/concepts/drawings">
    Make plans, sections and elevations from the model. Put them on sheets with a title block.
  </Card>

  <Card title="Open formats" icon="file-export" href="/floorkit/concepts/exports">
    Export sheets as PDF and the 3D model as GLB. IFC and DXF come in the next release.
  </Card>

  <Card title="Ready for AI agents" icon="sparkles" href="/floorkit/agents/agent-building-workflow">
    The building is a typed JSON document. An agent proposes it, and Floorkit checks and builds it.
  </Card>
</CardGroup>

## Built on OpenGeometry

Floorkit uses [OpenGeometry](https://docs.opengeometry.io/OpenGeometry/what-is-opengeometry), a CAD kernel that our team maintains. The kernel runs in the browser as WebAssembly.

Choose Floorkit for building elements, architectural editors, saved projects, and sheets. Choose the kernel for lower-level geometry such as extrusion and booleans. Each package has its own API and license.

Each wall, opening and room is a real building element with data. It is not only a picture of one. A door cuts its wall, and a wall joins the walls that it touches.

## How it fits into your app

| Your app owns | Floorkit gives you |
| - | - |
| The page, the panels and the tools | Building elements with correct geometry |
| The Three.js scene and the renderer | 3D objects that you add to that scene |
| Storage and user accounts | One JSON project file to save and open |
| The workflow of your product | Edit commands, drawings, sheets and export files |

## Where to use it

Build AI floor-plan applications, browser CAD, architecture/BIM tools, and property or space-planning apps. [What you can build](/floorkit/use-cases) connects each use case to the required guides and current limits.

## Start here

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/floorkit/installation">
    Add the package to your web app.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/floorkit/quickstart">
    Create your app and show the first room.
  </Card>

  <Card title="How Floorkit works" icon="layer-group" href="/floorkit/concepts/architecture">
    Learn the four parts and how data moves between them.
  </Card>

  <Card title="API reference" icon="code" href="/floorkit/api/overview">
    Find each class and function.
  </Card>

  <Card title="Build with agents" icon="sparkles" href="/floorkit/agents/index">
    Give your coding agent the docs, or connect an agent to your building workflow.
  </Card>

  <Card title="What you can build" icon="route" href="/floorkit/use-cases">
    Choose a complete path for your application.
  </Card>
</CardGroup>

<Note>
  Local development is free. Every deployed hostname needs a valid key, including public prototypes
  and non-commercial demos. See [Licensing](/floorkit/licensing).
</Note>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.