![\"OpenGeometry\"](\"https://raw.githubusercontent.com/OpenGeometry-io/.github/main/profile/opengeometryTextLogo.png\")
\n \n\n \n \n \n
\n The browser-native TypeScript library for architectural BIM authoring — walls, doors, windows, levels, grids, dimensions, and IFC / PDF / DXF export in one API.\n
\n\n\n One class. Every architectural element. Every export format.
\n Pure browser — no server, no plugin, no compromise.\n
\n ![\"npm](\"https://img.shields.io/npm/v/@opengeometry/openplans?style=flat-square&color=4460FF&label=npm\")
![\"license\"](\"https://img.shields.io/github/license/OpenGeometry-io/OpenPlans?style=flat-square\")
![\"built](\"https://img.shields.io/badge/built%20on-OpenGeometry-4460FF?style=flat-square\"){kind=icon}
![\"three.js\"](\"https://img.shields.io/badge/three.js-000000?style=flat-square&logo=three.js&logoColor=white\"){kind=icon}
![\"Discord\"](\"https://img.shields.io/badge/Discord-Join%20us-5865F2?style=flat-square&logo=discord&logoColor=white\"){kind=icon}
![\"Twitter\"](\"https://img.shields.io/badge/Twitter-Follow-1DA1F2?style=flat-square&logo=x&logoColor=white\"){kind=icon}
![\"LinkedIn\"](\"https://img.shields.io/badge/LinkedIn-Connect-0A66C2?style=flat-square&logo=linkedin&logoColor=white\"){kind=icon}
\n Website ·\n Documentation ·\n Live Demos ·\n npm ·\n OpenGeometry Kernel\n
\n\n---\n\n> **Actively maintained.** OpenPlans ships regular updates and welcomes bug reports, feature requests, and contributions on [GitHub](https://github.com/OpenGeometry-io/OpenPlans/issues).\n\n## What is OpenPlans?\n\nOpenPlans is a TypeScript toolkit for authoring architectural plans in the browser. It gives architects, BIM developers, and AEC tooling teams a single, integrated environment to:\n\n- Draft 2D and 3D architectural elements (walls, doors, windows, openings, floors)\n- Place reference datums (levels, grids, section lines, elevation markers, project origin)\n- Compose printable drawing sheets with linked viewports and dimensions\n- Export to **IFC** (semantic BIM), **PDF** (vector sheets), and **DXF** (CAD interchange)\n\nUnder the hood, every piece of geometry is generated and operated on by the [OpenGeometry](https://opengeometry.io) kernel — a Rust + WebAssembly CAD kernel that runs entirely in the browser. OpenPlans is the architectural-domain layer; OpenGeometry is the geometry engine.\n\n## Built on OpenGeometry\n\nOpenPlans does not implement its own geometry. Every wall extrusion, every CSG cut for a window, every B-rep solid that ends up in the IFC export is computed by the [**OpenGeometry**](https://opengeometry.io) kernel.\n\n| OpenGeometry provides | OpenPlans turns it into |\n|---|---|\n| `Polygon`, `Solid`, `Sweep` | Walls, slabs, openings |\n| `Arc`, `Line`, `Polyline`, `Rectangle` | 2D primitives and door swing arcs |\n| `Cuboid`, `Cylinder` | Generic 3D shapes and volume elements |\n| Boolean operations (`subtract`, polygon-with-holes) | Doors and windows cut into walls |\n| IFC B-rep serialization | Standards-compliant `IFCWALL`, `IFCDOOR`, `IFCWINDOW` |\n\nThis separation means OpenPlans inherits OpenGeometry's robustness, AI-friendly API surface, and IFC fidelity for free, while focusing on the architectural domain — semantic elements, sheets, dimensions, and exports.\n\nIf you need lower-level geometry primitives directly, work with [OpenGeometry](https://opengeometry.io). If you are building floor plans, drawing sets, or BIM export pipelines in the browser, OpenPlans is the higher-level toolkit you want.\n\n## What you can build\n\n- **Floor plan editors** — drag-and-drop walls, doors, windows, and room layouts in the browser\n- **Space planning tools** — level-based layouts with grids, section lines, and elevation markers\n- **BIM authoring apps** — export semantically valid IFC from browser interactions, no server round-trip\n- **Drawing sheet composers** — linked viewports on paper frames, exported as vector PDF or DXF\n- **3D architectural modellers** — switch between orthographic plan view and perspective 3D view\n- **AI-driven layout generators** — declarative TypeScript API makes it straightforward for agents to generate and export buildings programmatically\n\nIf you only need a CAD geometry kernel without the architectural semantics, use [OpenGeometry](https://opengeometry.io) directly.\n\n## Quick Start\n\n```bash\nnpm install @opengeometry/openplans three camera-controls\n```\n\n```ts\nimport { CameraMode, OpenPlans } from \"@opengeometry/openplans\";\n\nconst container = document.getElementById(\"app\");\nif (!container) throw new Error(\"Missing app container\");\n\n// One class to set up the renderer, camera, and scene\nconst openPlans = new OpenPlans(container);\n\n// Boot the WebAssembly geometry kernel — must await before creating geometry\nawait openPlans.setupOpenGeometry();\n\nopenPlans.CameraMode = CameraMode.Plan;\n\n// Start placing architectural elements\nconst wall = openPlans.singleWall();\nwall.position.set(2, 0, 0);\n\nconst door = openPlans.door();\ndoor.position.set(2, 0, 1);\n\nconst window = openPlans.window();\nwindow.position.set(2, 0, 3);\n```\n\nThat's it — a live 3D scene with walls, doors, and windows, ready to export to IFC or PDF.\n\n## Features\n\n**Primitives** — Line, Arc, Polyline, Rectangle\n\n**Shapes** — Cuboid, Cylinder\n\n**Architectural Elements** — SingleWall, PolyWall, WallOpening, Door, Window\n\n**Reference Datums** — Levels, Grids, ReferencePlanes, SectionLines, ElevationMarkers, ProjectOrigin\n\n**Drawing Helpers** — PaperFrame (A4 / A3 / A2, portrait & landscape), ViewportBlock, Dimensions (line / angle / radius)\n\n**Camera Modes** — `CameraMode.Plan` (orthographic top-down), `CameraMode.Model` (perspective 3D)\n\n**Themes** — `light`, `dark`, `darkBlue`\n\n**Exports** — IFC (semantic BIM with property sets), PDF (vector sheets via jsPDF), DXF (CAD interchange)\n\nThe document-first views/sheets API (`document-sheet-editor`) is available as a preview. The paper-frame PDF path, architectural elements, primitives, and IFC export are the primary production APIs.\n\n## Paper Frames and PDF Export\n\nCompose linked viewports on a named paper frame and export the result as a downloadable vector PDF. The `PaperFrame` and `ViewportBlock` classes are available directly from the package, and `PlanPDFGenerator` handles the PDF rendering. See [docs.openplans.io](https://docs.openplans.io) for the full sheets workflow and API reference.\n\n## IFC Export\n\nOpenPlans emits semantically valid IFC with B-rep geometry produced by the OpenGeometry kernel. Walls become `IFCWALL`, doors become `IFCDOOR`, windows become `IFCWINDOW`, each carrying the property sets you'd expect from a BIM authoring tool. See [docs.openplans.io](https://docs.openplans.io) for the full IFC workflow and property set reference.\n\n## Demos\n\nLive demos: [try.openplans.io](https://try.openplans.io)\n\nTo run the example gallery locally:\n\n```bash\nnpm install\nnpm run dev\n# open http://localhost:5555\n```\n\nUseful entry points by category:\n\n**General** — [Quick Start](./examples/src/quickstart.html) · [IFC export](./examples/src/exporters/ifc-export.html) · [DXF export](./examples/src/exporters/dxf-export.html)\n\n**Elements** — [Single wall](./examples/src/elements/solids/single-wall.html) · [Polyline wall](./examples/src/elements/solids/polyline-wall.html) · [Wall opening](./examples/src/elements/solids/wall-opening.html) · [Door](./examples/src/elements/openings/door.html) · [Window](./examples/src/elements/openings/window.html) · [Opening](./examples/src/elements/openings/opening.html)\n\n**Primitives** — [Line](./examples/src/primitives/line.html) · [Arc](./examples/src/primitives/arc.html) · [Polyline](./examples/src/primitives/polyline.html) · [Rectangle](./examples/src/primitives/rectangle.html)\n\n**Shapes** — [Cuboid](./examples/src/shapes/cuboid.html) · [Cylinder](./examples/src/shapes/cylinder.html)\n\n**Datums** — [All datums](./examples/src/datums/all-datums.html) · [Level](./examples/src/datums/level.html) · [Grid](./examples/src/datums/grid.html) · [Section line](./examples/src/datums/section-line.html) · [Elevation marker](./examples/src/datums/elevation-marker.html) · [Reference plane](./examples/src/datums/reference-plane.html) · [Project origin](./examples/src/datums/project-origin.html)\n\n**Dimensions** — [Line](./examples/src/dimensions/line-dimension.html) · [Angle](./examples/src/dimensions/angle-dimension.html) · [Radius](./examples/src/dimensions/radius-dimension.html)\n\n**Drawings & Sheets** — [Paper frame export](./examples/src/drawings/paper.html) · [Viewport block](./examples/src/drawings/viewport-block.html)\n\n**Views** — [View creation](./examples/src/views/view-creation.html)\n\n## Documentation\n\nFull product documentation lives at **[docs.openplans.io](https://docs.openplans.io)** — generated by our auto-docs pipeline and kept in sync with the published package.\n\nFor lower-level geometry kernel docs, see **[docs.opengeometry.io](https://docs.opengeometry.io)**.\n\n## Architecture\n\nOpenPlans is organized as two internal packages under `src/packages/`:\n\n- **`openplans-core`** — semantic BIM layer. Owns element types (primitives, shapes, architectural elements, datums), layout/view management, dimensions, and IFC/PDF/DXF exporters. Has no direct renderer dependency.\n- **`openplans-three`** — Three.js runtime. Owns scene setup, the render loop, camera (Plan/Model modes), grid, and Three.js helpers. Consumes `openplans-core` types and drives them through the OpenGeometry kernel.\n\nThe `OpenPlans` class in `src/index.ts` is the public facade that wires both packages together and is the primary entry point for application code.\n\n## Repository Layout\n\n```text\nsrc/index.ts Public facade and top-level exports\nsrc/packages/openplans-core/src/ Primitives, shapes, elements, layouts, exporters\nsrc/packages/openplans-three/src/ Three.js runtime, camera, grid, helpers\nexamples/src/ Browser examples used for manual verification\ndist/ Generated library output (do not edit)\nexamples/dist/ Generated example site output (do not edit)\n```\n\n## Build From Source\n\nPrerequisites: Node.js 18 or newer, npm.\n\n```bash\nnpm install\nnpm run build\n```\n\nUseful commands:\n\n- `npm run dev` — start the Vite example server on port `5555`\n- `npm run build` — build the library into `dist/`\n- `npm run build-examples` — build the example site into `examples/dist/`\n\nFor local development against a sibling OpenGeometry kernel checkout, see [developer.md](./developer.md).\n\n## Who is this for?\n\n- **AEC software teams** building browser-based plan editors, schematic-design tools, or BIM viewers.\n- **Architects and design technologists** prototyping spatial tools without a desktop CAD installation.\n- **AI / agent builders** generating buildings programmatically and exporting to standards-compliant IFC.\n- **OpenGeometry users** who need an architectural-domain layer instead of working with raw geometry.\n\n## Community\n\n- **Discord** — [Join us](https://discord.com/invite/9wJpbfgGGA)\n- **Twitter / X** — [@openGeometry](https://x.com/openGeometry)\n- **LinkedIn** — [OpenGeometry](https://linkedin.com/company/openGeometry)\n- **GitHub Issues** — [Report a bug or request a feature](https://github.com/OpenGeometry-io/OpenPlans/issues)\n\n## Contributing\n\nOpenPlans is open source under the [MIT license](./LICENSE.md). Contributions are welcome — see [CONTRIBUTING.md](./CONTRIBUTING.md) for the workflow.\n\n---\n\n\n OpenPlans is part of the OpenGeometry family — a browser-native CAD ecosystem.\n
\n","readmeFilename":"README.md"}