Fornjot

博客 | 社区 | 贡献指南

关于

Fornjot是一个 早期阶段的CAD内核，使用 边界表示（b-rep），用Rust编程语言编写。

作为一个CAD内核，该项目的目标是提供 一个坚实的基础，供开发者构建，无论是用于专用工具、扩展Fornjot功能集的第三方库，还是全功能的CAD应用程序。

在这样做的时候，Fornjot遵循以下原则

• 专注于 机械CAD应用程序，如3D打印、加工、木工；而不是其他用例，如建筑或电子。
• 优先考虑 可靠性而非功能。你可以做的事情应该要么按预期工作，要么产生清晰且可操作的错误。
• 保持 友好的API，可直接在Rust中定义模型。这意味着代码优先的CAD建模（或Code-CAD）是原生支持的。
• 通过启用第三方API来 支持其他语言中的代码优先CAD建模。

Fornjot仍在开发中，并不总是能满足这些雄心壮志。尽管如此，这些是项目遵循的优先事项。

更多信息，请 查看网站。

赞助商

Fornjot 由以下人员支持：@MitchellHansen、@webtrax-oz、@seanjensengrey、@reivilibre、@lthiery、@ahdinosaur、@martindederer、@bollian、@sucaba、@nullstyle、@tachiniererin、@HalfVoxel、@MattOslin、@jminer、@voxpelli、@U007D、@guillaumechauvat、@mayfieldiv、@bglw、@hansihe、@romixlab、@krl，以及 我的其他优秀赞助者。谢谢你们！

请考虑 支持我，以帮助 Fornjot 持续发展。

目录

• 状态
• 概述
• 用法
• 社区
• 参与进来
• 许可协议

状态

Fornjot 可用于简单的模型（请参阅 示例），但目前尚未具备更高级功能。正在努力改进。

概述

Fornjot 具有模块化架构，允许您选择使用它的哪些部分。它由以下库组成

• fj：导出以下所有crate的完整API。
• fj-math：Fornjot其他部分使用的数学原语。
• fj-interop：允许其他crate进行交互的基本类型，无需相互依赖。
• fj-core：核心原语及其代码。
• fj-export：将 Fornjot 模型导出到外部数据格式。
• fj-viewer：显示 Fornjot 模型。
• fj-window：用于与 fj-viewer 一起使用的简单窗口抽象。

用法

Fornjot 是一组Rust库（请参阅上面的列表）。关于如何使用这些库的权威文档是它们的参考文档。每个库的 crates.io 页面（请参阅上面的列表）链接到这些文档。

如果您想使用 Fornjot 在 Rust 中创建特定模型，最佳起点是此存储库中的 示例模型。

• 要显示模型，运行 cargo run -p cuboid（将 cuboid 替换为您想显示的模型的名称）。
• 要导出模型，请运行 cargo run -p cuboid -- --export model.3mf（将 cuboid 替换为你想导出的模型的名称；可选地将 3mf 替换为其他支持的文件格式）。
• 要查看完整的 CLI 选项，请运行 cargo run -p cuboid -- --help（所有模型都具有相同的 CLI 接口，因此它们之间不会有太大的差异）。

社区

如果您对 Fornjot 感兴趣，请考虑加入社区。我们非常希望您能加入我们！

请访问网站上的 社区页面 了解我们所在的位置！

参与进来

如果您想帮忙，只需克隆 GitHub 仓库中的一个并提交一个拉取请求。

• 主要 Fornjot 仓库
• 网站仓库

如果您不知道要做什么，请查看 good first issues。如果您需要更多的指导，请查看 贡献指南，或直接提问！

许可协议

本项目是开源的，根据 零条款 BSD 许可协议（0BSD，简称）许可。这基本上意味着您可以对其进行任何操作，没有任何限制，但您不能因为问题而追究作者的赔偿责任。

请参阅 LICENSE.md 以获取详细信息。