Add comprehensive documentation for SnapForm features and workflows
Some checks failed
构建扩展 / build (push) Failing after 24s
Some checks failed
构建扩展 / build (push) Failing after 24s
- Introduced new guides for Depth Plane, Surface, and animation workflows. - Added installation instructions and FAQs to assist users in setup and troubleshooting. - Created a quick-start guide for first-time users to convert images to Depth Planes. - Documented the process for removing backgrounds from images. - Established a models and storage section to clarify data management. - Included a stylesheets file for improved documentation styling. - Updated mkdocs configuration for better navigation and theme settings.
This commit is contained in:
53
docs/installation.md
Normal file
53
docs/installation.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# 安装与首次配置
|
||||
|
||||
SnapForm 的安装分为两步:先安装 Blender Extension,再安装独立运行环境和默认模型。第二步只需在首次使用或环境版本发生变化时执行。
|
||||
|
||||
## 安装 Blender Extension
|
||||
|
||||
1. 下载与你的系统匹配的 ZIP 文件:
|
||||
- `SnapForm.v版本号.windows-x64.zip`
|
||||
- `SnapForm.v版本号.macos-arm64.zip`
|
||||
- `SnapForm.v版本号.linux-x64.zip`
|
||||
2. 打开 Blender,进入 **Edit > Preferences > Extensions**。
|
||||
3. 点击右上角菜单,选择 **Install from Disk**。
|
||||
4. 选择下载的 ZIP 文件并完成安装。
|
||||
|
||||
!!! warning
|
||||
不要解压扩展包。Blender 需要直接安装 ZIP 文件,并且安装包必须与你的操作系统匹配。
|
||||
|
||||
## 检查扩展偏好设置
|
||||
|
||||
在 SnapForm 的扩展偏好设置中可以看到两个选项:
|
||||
|
||||
- **Storage Root**:保存运行环境、模型和任务文件的位置。默认是用户目录下的 `.snapform`,一般无需修改。
|
||||
- **Device**:正式转换任务使用的计算设备。SnapForm 默认选择本机可用的最快设备;如果 GPU Provider 不可用,会使用 CPU。
|
||||
|
||||
如果准备把 Storage Root 放到其他磁盘,建议在首次安装 Environment 之前修改。更换目录后,旧目录中的环境和模型不会自动移动。
|
||||
|
||||
## 安装 Environment
|
||||
|
||||
打开 3D View,按 `N` 显示侧栏并切换到 **SnapForm** 页签。在 **Job Server** 面板中选择一个安装入口:
|
||||
|
||||
- **Install Environment**:使用官方源,适合能稳定访问 GitHub、Python 下载源和 PyPI 的网络。
|
||||
- **Install Environment (Mirror)**:使用国内镜像下载 uv、Python 和 Python 包。
|
||||
|
||||
安装程序会依次准备 uv、独立 Python 和运行包。Environment 完成后,SnapForm 还会下载日常功能需要的 **MoGe-2 ViT-S Normal** 与 **BEN2 Base**。
|
||||
|
||||
!!! note
|
||||
两个安装按钮只影响 Environment 的下载源。模型会按自己的下载源与备用镜像规则获取。
|
||||
|
||||
安装过程中请保持 Blender 打开。状态栏会显示当前阶段、进度和下载速度。首次安装耗时取决于网络与磁盘速度。
|
||||
|
||||
## 确认安装完成
|
||||
|
||||
完成后可以用以下方式确认:
|
||||
|
||||
- **Job Server** 不再显示 “Environment is not installed”。
|
||||
- 展开 **Models** 面板,MoGe-2 ViT-S Normal 和 BEN2 Base 显示 **Ready**。
|
||||
- 选中 Image Empty 后,右键菜单中的 **Convert to Depth Plane**、**Convert to Surface** 和 **Remove Background** 可以点击。
|
||||
|
||||
如果 Environment 已安装但默认模型缺失,Image Empty 的 **SnapForm** 右键子菜单会显示 **Download Required Models**。点击一次即可补齐缺失项。
|
||||
|
||||
## 下一步
|
||||
|
||||
继续阅读[五分钟上手](quick-start.md),用一张图片完成第一次转换。
|
||||
Reference in New Issue
Block a user