rei-mirrors
/
Fornjot
mirror of https://github.com/hannobraun/Fornjot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
16,075 Commits 2 Branches 51 Tags 26 MiB
Rust 99%
WGSL 0.7%
Nix 0.2%
Just 0.1%
Go to file
Hanno Braun 6e00260233 Add store for surfaces 2024-12-20 20:30:28 +01:00
.github Disable CI build on Windows 2024-06-07 21:14:28 +02:00
.vscode Add configuration for Nix Environment Selector 2023-11-22 17:30:24 +01:00
crates Bump the cargo group with 3 updates 2024-12-16 12:39:45 +00:00
experiments Add store for surfaces 2024-12-20 20:30:28 +01:00
models Prepare for simplifying `SweepSketch` 2024-08-14 19:55:21 +02:00
tools Bump the cargo group with 3 updates 2024-12-16 12:39:45 +00:00
.gitignore Keep experiment config out of of top-level file 2024-10-30 00:50:02 +01:00
CHANGELOG.md Update changelog 2024-03-21 14:20:10 +01:00
CONTRIBUTING.md Improve wording 2024-10-10 20:01:51 +02:00
Cargo.lock Run `cargo update` 2024-12-16 14:11:39 +01:00
Cargo.toml Update version 2024-03-21 14:20:41 +01:00
LICENSE.md Add license 2021-04-07 18:04:22 +00:00
README.md Update list of sponsors 2024-12-16 20:00:43 +01:00
bacon.toml build: remove whitespace in front of comment 2022-02-22 10:10:05 +01:00
justfile Expand `just ci` to run Clippy for whole workspace 2024-01-03 14:34:46 +01:00
release-procedure.md Update release procedure 2024-03-21 14:53:50 +01:00
rust-toolchain.toml Upgrade to Rust 1.83.0 2024-12-05 20:19:28 +01:00
rustfmt.toml Configure maximum line length 2020-07-30 19:36:11 +02:00
shell.nix Make `cargo run` work within `nix-shell` 2023-11-23 17:49:54 +01:00

README.md

Fornjot

Blog | Community | Contribution Guide

About

Fornjot is an early-stage CAD kernel, using boundary representation (b-rep), written in the Rust programming language.

As a CAD kernel, the project's main 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:

  • Focus on mechanical CAD applications, like 3D printing, machining, woodworking; over other use cases such as architecture or electronics.
  • Favor reliability over features. Anything you can do should either work as expected, or result in a clear and actionable error.
  • Maintain a friendly API for directly defining models in Rust. This means code-first CAD modeling (or Code-CAD) is natively supported.
  • Support code-first CAD modeling in other languages, by enabling third-party APIs.

Fornjot is still in development and doesn't always live up to these ambitions. None the less, these are the priorities the project follows.

For more information, please check out the website.

Sponsors

Fornjot is supported by @reivilibre, @krl, @thestig4242, @thomasgarrison, @seanjensengrey, @lthiery, @ahdinosaur, @martindederer, @sucaba, @MitchellHansen, @Rahix, @ziguana, @nullstyle, @HalfVoxel, @jessebraham, @jminer, @U007D, @guillaumechauvat, @mayfieldiv, @bglw, @refarb, @hansihe, @romixlab, @justinmimbs, @yikesable, @hrgdavor, @ironchief, @kingsmountainlabs, @epyintheshell, @jneem, and my other awesome sponsors. Thank you!

Please consider supporting me too, to help make Fornjot sustainable long-term.

Table of Contents

Status

Fornjot is usable for simple models (see models/ directory), but currently lacks the features for anything more advanced. Work to change that is underway.

Despite this, there are some experimental projects that are build on top of Fornjot:

Overview

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.

Usage

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:

  • To display a model, run cargo run -p cuboid (replace cuboid with name of model you want to display).
  • To export a model, run 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).
  • To see full set of CLI options, run cargo run -p cuboid -- --help (all models have the same CLI interface, so this shouldn't differ much between them).

Community

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!

Get Involved

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!

License

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.