Badges and one-line instructions for Windows, macOS, Linux and the web app, right after the tagline and demo. The links use releases/latest/download with version-less file names, which release.yml now attaches (and checksums) alongside the versioned installers. The Flatpak note and the name/compatibility section move into the book's Getting started page. Claude-Session: https://claude.ai/code/session_01RjGw4gA5ZvKrU8MQP6sBgT Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
62 lines
4.3 KiB
Markdown
62 lines
4.3 KiB
Markdown
SolidCraft is open-source parametric 3D CAD in Rust: sketch, constrain, extrude, and change a
|
|
parameter to watch the timeline rebuild. [Documentation](https://bherbruck.github.io/solidcraft/)
|
|
· [try it in the browser](https://bherbruck.github.io/solidcraft/app/) ·
|
|
[contributing](https://github.com/bherbruck/solidcraft/blob/main/CONTRIBUTING.md) ·
|
|
[issues](https://github.com/bherbruck/solidcraft/issues). AI agents can model with it over MCP:
|
|
`solidcraft-cli mcp` ([how](https://bherbruck.github.io/solidcraft/guide/mcp.html)).
|
|
|
|
**Renamed to SolidCraft.** Everything now uses the new name: the `solidcraft` and
|
|
`solidcraft-cli` programs, `.solidcraft` designs, `SOLIDCRAFT_*` environment variables,
|
|
settings folders, package names and the `solidcraft` MCP server. Upgrading from SolveCraft:
|
|
- `.solvecraft` designs still open (double-click, Open, drag-drop, the CLI and MCP); new saves
|
|
are `.solidcraft`. Builds older than this one can't open files saved by it.
|
|
- Settings, preferences and recovery files are copied to the new folders on first launch; the
|
|
old folders are left in place. `SOLVECRAFT_*` environment variables are still read.
|
|
- `solvecraft-cli` remains as a deprecated alias for one release; it forwards to
|
|
`solidcraft-cli` and prints a note. Agents: `claude mcp add solidcraft -- solidcraft-cli mcp`;
|
|
an existing `claude mcp add solvecraft -- solvecraft-cli mcp` setup keeps working.
|
|
- Windows: the `.msi` upgrades the existing installation in place (now in
|
|
`Program Files\SolidCraft`). Linux: the `solidcraft` `.deb`/`.rpm` replaces the `solvecraft`
|
|
package. The Flatpak app ID stays `ai.storyteller.solvecraft`, so `flatpak update` just works,
|
|
and existing AppImages find the update.
|
|
- macOS: quit the app, move the old `SolveCraft.app` to the Trash (your designs and settings
|
|
stay), then drag `SolidCraft.app` from the DMG onto Applications and pin it in the Dock.
|
|
- Details: [compatibility notes](https://github.com/bherbruck/solidcraft/blob/main/docs/compatibility.md).
|
|
|
|
Documentation, the browser app and the Flatpak feed use the SolidCraft project Pages URLs;
|
|
old-name Pages addresses are not permanent aliases.
|
|
|
|
**Which file?**
|
|
- **Windows:** `SolidCraft-{version}-windows-x64.exe` runs as is. Or install the `.msi`, or unzip the
|
|
`-portable.zip` (x64, x86 and arm64).
|
|
- **macOS 11+** (Apple silicon and Intel): open the `.dmg` and drag `SolidCraft.app` onto Applications.
|
|
The CLI is in `solidcraft-cli-{version}-macos-universal.zip`.
|
|
- **Linux** (x86_64 and aarch64, glibc 2.35+): the `.AppImage` (`chmod +x`, then run it), the
|
|
`.deb` or `.rpm`, the `.flatpak` (`flatpak install --user <file>`), or the `.tar.gz`.
|
|
- **FreeBSD:** `tar -xzf solidcraft-{version}-freebsd-x86_64.tar.gz --strip-components 1 -C /usr/local`.
|
|
- **Web:** `solidcraft-web-{version}.zip` is a static site to host yourself.
|
|
- `SHA256SUMS.txt`: `sha256sum -c SHA256SUMS.txt --ignore-missing`.
|
|
- Files without a version in the name (`solidcraft-windows-x64.msi`, `solidcraft-linux-x86_64.AppImage`, …)
|
|
are the same packages under fixed names, for download links that always fetch the latest release.
|
|
|
|
For Flatpak feed installation and updates, add Flathub for the required runtime before
|
|
installing SolidCraft; keep both remotes in the same user installation:
|
|
|
|
```sh
|
|
flatpak remote-add --user --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
|
|
flatpak remote-add --user --if-not-exists solidcraft https://bherbruck.github.io/solidcraft/flatpak/solidcraft.flatpakrepo
|
|
flatpak install --user solidcraft ai.storyteller.solvecraft
|
|
flatpak run ai.storyteller.solvecraft
|
|
```
|
|
|
|
Single-file `.flatpak` bundles include the runtime repository address; missing runtimes
|
|
still need an internet connection. [Linux installation details](https://bherbruck.github.io/solidcraft/guide/getting-started.html#linux-flatpak).
|
|
|
|
The builds aren't signed yet. On macOS, right-click `SolidCraft.app` in Applications and choose
|
|
**Open** the first time (or run `xattr -dr com.apple.quarantine /Applications/SolidCraft.app`).
|
|
On Windows, SmartScreen may say "Windows protected your PC": **More info**, then **Run anyway**.
|
|
Licences are built in (Help ▸ About ▸ Licences, `solidcraft-cli licences`); the packages also
|
|
install `THIRD-PARTY-LICENSES.txt`. Known limitations:
|
|
[ROADMAP.md](https://github.com/bherbruck/solidcraft/blob/main/ROADMAP.md#known-limitations).
|
|
|