Skip to content

Latest commit

 

History

History
91 lines (53 loc) · 5.04 KB

README.md

File metadata and controls

91 lines (53 loc) · 5.04 KB
Raw

Fornjot

Blog | Community | Contribution Guide

About

Fornjot is an early-stage b-rep CAD kernel written in the Rust programming language.

For an introduction of what the project aims to achieve, please check out the website.

Sponsors

Fornjot is supported by @MitchellHansen, @webtrax-oz, @reivilibre, @lthiery, @ahdinosaur, @martindederer, @bollian, @nullstyle, @tachiniererin, @HalfVoxel, @sucaba, @Kethku, @jessebraham, @seanjensengrey, @MattOslin, @benwis, @happysalada, @jminer, @jeevcat, @voxpelli, @U007D, @guillaumechauvat, @mayfieldiv, 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 some toy examples, but currently lacks the features for something more advanced. Work to change that is underway.

Overview

This is a list of the crates that make up Fornjot, along with a short description for each, starting with the most basic ones and leading up to the high-level ones:

  • 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.