Early-stage b-rep CAD kernel, written in the Rust programming language. No longer in development.
Early-stage b-rep CAD kernel, written in the Rust programming language. No longer in development.
⚠⚠⚠ This project has been shut down. Its goals were never reached. The rest of this README has been left as it was, for posterity. ⚠⚠⚠
Fornjot is an early-stage and experimental CAD kernel, using boundary representation (b-rep), written in the Rust programming language.
As a CAD kernel, the project's (so far unrealized) goal is to provide a solid foundation for developers to build on top of, whether for special purpose tooling, third-party libraries for extending Fornjot's feature set, or full-featured CAD applications.
In doing so, Fornjot follows these principles:
Fornjot is still in development and doesn't live up to these ambitions. None the less, these are the priorities which the project follows.
For more information, please check out the website.
Fornjot's mainline code (i.e. what is available at the top level of this repository, specifically in the crates/ directory) has not been developed in over a year, in favor of a series of experiments.
At this point, I fully expect that the code developed as part of such an experiment will replace the mainline code eventually. When and how that might happen is unclear.
Both the mainline code and the more advanced experiments are usable for simple very models (see models/ directory, for the mainline code). Currently, Fornjot lacks the features for anything more advanced, making it unsuited for real-world use cases.
Despite this, there are some experimental projects that are build on top of Fornjot:
Fornjot features a modular architecture, allowing you to pick and choose which parts of it you want to use. It is made up of the following libraries:
fj: All-in-one API that re-exports all of the following crates.fj-math: Math primitives used by the rest of Fornjot.fj-interop: Basic types that allow other crates to interoperate, without depending on each other.fj-core: Core primitives and code operating on those primitives.fj-export: Exports Fornjot models to external data formats.fj-viewer: Displays Fornjot models.fj-window: Simple windowing abstraction for use with fj-viewer.Fornjot is a set of Rust libraries (see list above). The definitive documentation on how to use those is their reference documentation. The crates.io pages of each library (see list above) link to those.
If you want to use Fornjot to create a specific model in Rust, the best starting point are the example models in this repository:
cargo run -p cuboid (replace cuboid with name of model you want to display).cargo run -p cuboid -- --export model.3mf (replace cuboid with name of model you want to export; optionally replace 3mf with another supported file format).cargo run -p cuboid -- --help (all models have the same CLI interface, so this shouldn't differ much between them).If you are interested in Fornjot, please consider joining the community. We'd love to have you!
Please check out the community page on the website for information on where to find us!
If you are interested in helping out, just fork one of the GitHub repositories and submit a pull request:
If you don't know what to work on, check out the good first issues. If you need some more guidance, check out the contribution guide, or just ask!
This project is open source, licensed under the terms of the Zero Clause BSD License (0BSD, for short). This basically means you can do anything with it, without any restrictions, but you can't hold the authors liable for problems.
See LICENSE.md for full details.
No open issues yet, or sync has not completed.