README.md

BREP.io

Warning

This project is deprecated

BREP.io is no longer under active development. Please use the new project https://next.BREP.io instead. It has a completely new codebase written in Rust and provides a real BREP kernel with real surfaces and support for reading and writing real STEP files.

This repository is preserved for historical and reference purposes. The legacy browser-based CAD application and JavaScript kernel may still be useful for studying the earlier mesh-based implementation, but APIs and behavior are no longer actively maintained.

Successor project

For the current BREP.io project, visit https://next.BREP.io.

The successor is built completely from scratch in Rust and provides:

• Real geometric surfaces
• Real BREP topology
• Reading and writing of STEP files

Archived project resources

• Source repository
• NPM package: brep-io-kernel
• Legacy live application
• Legacy API examples
• Developer Discord

Archived documentation

The documentation below describes the deprecated implementation and is retained for reference:

• Developer Docs Index
• Modeling Workbench
• Import Workbench
• Surfacing Workbench
• Sheet Metal Workbench
• Assemblies Workbench
• PMI Workbench
• All Feature Docs
• Assembly Constraint Solver
• PMI Annotations Index

Archived quick start

The legacy application can still be run locally with Node.js 18+, pnpm, and initialized submodules:

git submodule update --init --recursive
pnpm install
pnpm dev

Then open the Vite URL shown in the terminal. The main app shell is /index.html and the CAD workspace is /cad.html.

Archived package usage

The deprecated package was published as brep-io-kernel:

pnpm add brep-io-kernel

import { BREP, PartHistory } from "brep-io-kernel";

See brep-io-kernel examples for archived package examples.

License

See LICENSE.md. This project uses a dual-licensing strategy managed by Autodrop3d LLC.