CADmium

本项目旨在从零开始创建一个新的CAD程序。它体积小，可在网页浏览器中运行，源代码在Github上免费提供。

传统的CAD程序花费了数千年的集体工程时间才发展到现在的水平，因此这个程序在功能广度上永远无法与之竞争。但CADmium的目标是用不到10%的工作量来实现80%最常见的CAD用例。目前我们的目标用户是那些只想为3D打印机设计小部件的家庭爱好者，而不是想设计汽车或飞机的公司，尽管这些功能将在未来添加。

如果您在寻找：

• 一个简单、现代、参数化的CAD界面，可在浏览器中运行
• 可以将实体导出为.step、.obj或.cadmium（本项目正在开发的基于json的CAD格式）
• 可以将草图导出为.svg或.dxf
• 无需互联网连接即可工作

那么这个项目可能适合您！

状态：早期原型。这个工具还不是最小可行产品（MVP），但正在公开开发中。~~请不要将此分享到HN、Reddit或类似平台。~~哈，看来这艘船已经起航了！

总体计划

演示版：我们目前正在加速开发第一个演示版本V0.0.1。这是我们决定构建和发布流程的良好第一步练习。

之后，我们将发布更多演示版本（V0.0.*），逐步增加功能，直到感觉相当可用。

Alpha版：当我们感觉达到了人们可能真正想要使用的最小可行产品时，就到了发布Alpha版本（V0.1.0）的时候，我们将积极征求用户反馈。我们将利用这些反馈进行更多改进，必要时重新设计以实现出色的工作流程。

此后，我们将拭目以待！

技术

底层的边界表示引擎是truck，它用Rust编写，不依赖于任何传统的B-rep引擎。

基于truck，我们编写了一个名为cadmium的小型Rust库，提供了项目、工作空间、草图、挤压和约束的结构。我们的目标是使这个Rust库为那些喜欢代码优先CAD的人提供与UI相同的所有功能。该库能够将项目以json格式保存到磁盘并从磁盘加载。我们还构建了一组JavaScript绑定，使整个程序可以编译成wasm并在浏览器中运行。

UI使用SvelteKit和Tailwind构建。它托管在Github Pages上。我们使用three.js进行渲染，在这种情况下底层使用WebGL。我们使用Threlte以声明式方式管理场景图。

原生构建使用Tauri，这是一个基于Rust的包装器，封装了特定操作系统的原生webview，允许我们从同一代码库构建原生应用。

许可证

本软件采用Elastic License 2.0许可。简而言之，您可以随意使用这个软件，但不能将其作为服务提供给第三方。

运行代码

如果您只是想尝试一下，点击这里查看在线网页演示。

要使用pnpm workspace和turbo在本地构建：

git clone https://github.com/Cadmium-Co/CADmium.git
cd CADmium
pnpm install
pnpm dev

原生构建

# 开发
pnpm tauri dev

# 生成二进制文件和安装程序
pnpm tauri build

Tauri可以使用以下命令为原生构建生成图标：

pnpm tauri icon applications/web/public/cadmium_logo_min.svg

工具设置

pnpm

我们使用pnpm管理monorepo。请按照以下说明安装：https://pnpm.io/installation#using-a-standalone-script

如果您是Node.js新手，可以使用pnpm管理Node.js：

# https://pnpm.io/cli/env#use
pnpm env use --global 20

rust

首先使用rustup安装Rust：https://rustup.rs

然后安装wasm-pack

cargo install wasm-pack

运行测试

pnpm test

Playwright用于端到端测试。您可能会收到提示，要求输入命令安装它。

对于manjaro/archlinux用户，它可能会报告缺少依赖项。在manjaro上，根据这条评论，可以通过以下方式解决缺少的依赖项：

yay -S aur/enchant1.6 aur/icu66 aur/libwebp052

仅监视vitest单元测试：

cd applications/web
pnpm test:unit -w

rust

要构建和运行Rust测试：

cargo test

rust示例

使用Rust代码的简单示例可以在packages/cadmium/examples中找到

运行简单的Rust示例：

cargo run --example project_simple_extrusion

将生成example.obj文件和example.step输出文件，可以在CAD查看器中检查.step文件。

git blame

要忽略纯粹用于格式更改的提交，以保留正确的作者身份，请设置您的本地git配置：

git config blame.ignoreRevsFile .git-blame-ignore-revs

贡献

我们正在积极寻找贡献者！请加入Discord来帮忙！

我们特别需要以下领域的帮助：

**设计：**工具必须看起来和使用起来都很好，而我们不是设计师。我们非常欢迎以下形式的贡献：

• 关于如何改善不同元素外观和行为的建议、模型或tailwindcss示例
• 特别是帮助选择一个效果好且独特的配色方案
• 帮助弄清如何实现深色模式

**Rust：**这是我们的第一个Rust项目。我们需要有经验的Rust开发者帮助：

• 找出如何更好地组织Rust代码
• 指出我使用这门语言时的任何明显问题（到目前为止，我们完全避开了生命周期、特征、Rc、RefCell等，这可能会阻碍一些事情）

**Svelte：**这是我们第一次使用Svelte的项目。我们希望有经验的开发者能：

• 审查基本结构，告诉我们是否有任何重大错误
• 在Svelte 5发布时帮助我们迁移

如果你愿意并能够提供帮助，请加入我们的Discord！

许可证常见问题

你们使用什么许可证？

我们使用Elastic License v2.0。

该许可证的条款是什么？

你可以用这些代码做任何事，除了将其作为服务提供给第三方。

为什么你们使用这种许可证而不是MIT、GPL等？

因为我们不希望Autodesk、Siemens、Dassault或PTC克隆我们的代码，改变logo，然后开始将其作为他们的产品之一提供。

我可以为我的家人托管一个CADmium实例吗？

可以。

我可以为我的公司内部使用托管一个CADmium实例吗？

可以。

我可以为我的公司托管一个CADmium实例，作为免费服务提供给我的客户吗？

不可以。

我可以为我的公司托管一个CADmium实例，作为付费服务提供给我的客户吗？

不可以。

如果你们在某个时候决定停止开发CADmium，这个项目会/可能发生什么？

我们会将许可证转换为MIT、GPL或类似的许可证。

如果我分叉项目并对其进行更改（重新品牌化或添加新功能），我可以自己托管吗？

可以，只要你的分叉仅供你或你的公司使用。不允许你将你的分叉作为服务托管给第三方。

我必须公开我的分叉吗？

不必。

V0.0.1版本发布（演示版）的即时待办事项

用于跟踪进度的Github项目在这里

• 草图绘制
  • 实现独立的一阶2D约束求解器
  • 将新的求解器集成到sketch.rs中
  • 能够在实体表面创建草图
  • 在UI中创建和修改约束的能力
  • 实体：线、矩形、圆、弧、2D圆角
  • 约束：水平、垂直、平行、垂直、长度、半径、重合，可能还有其他一些
• 拉伸
  • 配置拉伸以创建新实体或从现有实体中减去
  • 模式：新建、添加、切割
  • 控制：深度、偏移
  • 能够同时拉伸多个面（来自一个草图），同时不拉伸草图中的每个面
• 旋转
  • 与拉伸相同
• 布尔运算
  • 并集、交集、减法
• 项目
  • 能够重命名项目
  • 能够删除步骤
  • 将ctrl + s绑定到.cadmium导出，将ctrl + o绑定到.cadmium导入
• 单位
  • 明确整个文件使用毫米单位
• 文件
  • 保存和加载CADmium文件
  • 导出为STEP、OBJ、STL、SVG、DXF格式
• 营销
  • YouTube视频演示如何制作：
    • 一个简单的立方体
    • 一个带螺丝孔的板
    • 一些非常复杂的东西像这样