如何从源码构建Shrimply:Rust + CUDA开发环境完整搭建教程
如何从源码构建Shrimply:Rust + CUDA开发环境完整搭建教程
Shrimply 是一款用 Rust 编写的跨平台 GPU 视频编辑器,其渲染核心依赖 CUDA 与 Slang 着色器。本文带你从零完成 Shrimply 源码构建 的完整流程:先准备 NVIDIA 显卡与约 70 GB 磁盘空间,再通过 Fedora 手动装依赖、Nix 一键环境或 Docker 三种方案之一,用一条 make dev 命令编译并启动编辑器。
一、构建前准备:硬件与磁盘要求
在动手之前,先确认你的机器满足以下硬性条件(摘自项目 development.rst 文档):
| 要求 | 说明 |
|---|---|
| 🖥️ 显卡 | NVIDIA GPU(GTX 900 ~ RTX 50 系列)或 Apple Silicon |
| 💻 系统 | Linux + Wayland,或 macOS 15+ |
| 🔧 驱动 | 必须安装 NVIDIA 驱动,否则无法运行 Shrimply |
| 📦 磁盘 | 源码构建约需 70 GB 可用空间 |
| 🎛️ 工具链 | Rust 固定为 nightly-2026-04-03(由 rust-toolchain.toml 锁定) |
| 🎬 CUDA | 官方验证于 CUDA Toolkit 12.9,默认路径 /usr/local/cuda |
💡 Shrimply 目前处于 pre-alpha 阶段,构建过程中遇到崩溃、性能回退属于正常现象,请保持耐心。
二、克隆源码:三步获取完整代码
Shrimply 依赖若干 git 子模块(OptiX SDK、manim、vtracer,见 external/),务必初始化子模块,否则后续编译会直接报错:
git clone https://gitcode.com/gh_mirrors/sh/shrimply.git
cd shrimply
git submodule update --init --recursive
仓库根目录的 Makefile 是所有构建命令的入口,所有 make 目标都在其中定义。
三、方案A:Fedora 手动安装依赖(官方首选路径)
官方推荐的构建路径是 Fedora。Makefile 内置了完整的依赖包清单,一条命令即可装齐 Rust、Clang、LLD、OpenCV、FFmpeg、GTK4、Qt6 等开发库:
make deps-fedora # 通过 dnf 安装全部系统依赖
make dev # 编译并启动 GTK 版编辑器
几个容易踩的坑:
- Slang 依赖:构建过程会自动下载 Slang 编译器,请确保系统装有
curl、tar、sha256sum。若你已有本地 Slang,可设置环境变量SLANG_LIBRARY_DIR和SLANG_INCLUDE_DIR跳过下载(参考 pkgs/slang.nix 中锁定的版本)。 - CUDA 架构自动检测:开发构建会调用 packaging/cuda-target.py 读取你的 GPU 计算能力,自动生成
sm_XX目标;检测失败说明 NVIDIA 驱动没装好。 - 日志位置:开发日志统一输出到
target/shrimply-dev.log,排错时先看它。 - 想试 Qt 界面? 把
make dev换成make dev-qt,只编译不启动则用make qt-build,产物为target/debug/shrimply-qt。
四、方案B:Nix 一键开发环境(最省心)
如果你嫌装依赖麻烦,项目的 flake.nix 提供了完整的 Nix 开发壳,一次性给齐 Rust、CUDA Toolkit、Slang 以及 GTK/Qt 原生依赖(pkgs/dev-shell.nix 定义了完整包列表):
git submodule update --init --recursive
nix develop --accept-flake-config
make dev
也可以直接构建可运行包,而不进入开发壳:
nix build --accept-flake-config
./result/bin/shrimply
⚠️ 注意:该包内置面向 compute capability 8.6(RTX 30 系)的 CUDA 内核。多用户版 Nix 若无法信任 CUDA 二进制缓存,需先在系统 Nix 配置中手动添加该缓存源。
五、方案C:Docker 实验性构建
如果本机环境实在无法调通,可以用仓库根目录的 Dockerfile 在容器内完成整个构建(标记为 Experimental):
git submodule update --init --recursive
docker buildx build --target export --output type=local,dest=dist/stage .
构建完成后,dist/stage/ 目录下即为打包好的可运行文件(含 shrimply、shrimply-qt、shrimply-mcp 等二进制)。
六、常用 make 命令速查表
日常开发中,你大概率只会用到下表这几个目标(完整清单见 Makefile):
| 命令 | 作用 |
|---|---|
make dev |
编译并启动 GTK 编辑器(含依赖检查与 CUDA 内核编译) |
make dev-qt |
编译并启动 Qt 版编辑器 |
make build / make release |
仅编译 debug / release 版本,不启动 |
make check |
跑完整检查:格式、Clippy lint、文档校验等 |
make test |
运行全部 Rust 测试 |
make docs |
用 Sphinx 构建官方文档 |
make clean |
清理构建产物 |
七、常见问题排查清单
Could not detect the local CUDA architecture→ NVIDIA 驱动未正确安装,packaging/cuda-target.py 无法读取libcuda.so.1。先装好驱动再重试。- Slang 下载失败 → 检查
curl/tar/sha256sum是否可用,或手动设置SLANG_LIBRARY_DIR、SLANG_INCLUDE_DIR。 - 找不到 CUDA 工具链 → 构建脚本默认
CUDA_HOME=/usr/local/cuda,如果你的 CUDA 装在其他位置,请显式传入CUDA_HOME=... make dev。 - 界面起不来但编译通过 → 查看
target/shrimply-dev.log;程序崩溃时 Makefile 会自动调用crash-report目标生成堆栈转储到target/shrimply-editor.stack。 - 构建太慢 → 项目已针对 debug 构建关闭 LTO、开启增量编译(Cargo.toml 的 profile 配置),首次编译仍需要较长时间,后续增量会快很多。
环境搭建完成后,打开编辑器创建第一个 .shrimp 项目,更多操作细节可参阅 getting-started.rst。祝你构建顺利,离"一只虾做视频"又近了一步!🦐
