【亲测免费】 fSpy 项目技术文档

1. 安装指南

1.1 下载安装包

如果您只是想运行 fSpy 应用程序，可以直接从 GitHub Releases 页面下载适用于您平台的最新可执行文件。

1.2 源码安装

如果您是开发者，并希望从源码构建和运行 fSpy，请按照以下步骤操作：

1.2.1 安装依赖

首先，确保您已经安装了 Node.js 和 Yarn。然后，克隆项目仓库并安装依赖：

git clone https://github.com/stuffmatic/fSpy.git
cd fSpy
yarn install

1.2.2 运行开发模式

在开发模式下运行 fSpy：

1. 打开一个新的终端标签页，运行 yarn dev-server 启动开发服务器。
2. 在另一个终端标签页中，运行 yarn build-dev 构建主进程和 GUI 代码。
3. 在另一个终端标签页中，运行 yarn electron-dev 启动 Electron 实例，该实例将使用开发服务器来实现 GUI 代码更改的自动重新加载。

注意：当前的构建过程并不理想，例如，它不支持主进程代码更改的实时重新加载。更改主进程代码需要手动重新构建，即执行步骤 2 和 3。

1.2.3 创建可分发的二进制文件

要创建可分发的二进制文件，请运行：

yarn dist

这将调用 Electron builder 来生成可执行文件。

2. 项目使用说明

2.1 基本功能

fSpy 是一个开源的跨平台应用程序，用于静态图像的相机匹配。它可以帮助您在 3D 应用程序中设置相机参数，以便与输入的静态图像匹配。

2.2 导入到 Blender

如果您是 Blender 用户，可以使用 官方的 fSpy 导入插件 来设置 Blender 相机的参数，并可选地设置相机背景图像。

2.3 导入到其他应用程序

如果您使用的应用程序没有专门的导入器，您仍然可以通过手动复制 fSpy 的相机参数来实现导入。具体步骤如下：

1. 将相机视口设置为与输入图像的尺寸匹配。
2. 使用输入图像作为相机背景。
3. 设置相机视野。
4. 设置相机位置。

3. 项目 API 使用文档

3.1 fSpy 项目文件格式

fSpy 的项目文件格式是开放的，您可以参考 fSpy 项目文件格式规范 来了解如何解析和生成 fSpy 项目文件。

3.2 自定义导入器

如果您希望为您的应用程序编写一个自定义的 fSpy 导入器，可以参考上述项目文件格式规范，并根据您的应用程序的需求进行实现。

4. 项目安装方式

4.1 直接下载安装包

最简单的方式是从 GitHub Releases 页面下载适用于您平台的可执行文件，并直接运行。

4.2 源码构建

如果您是开发者，并希望从源码构建 fSpy，请按照以下步骤操作：

1. 克隆项目仓库。
2. 安装依赖。
3. 运行开发模式或创建可分发的二进制文件。

通过以上步骤，您可以轻松地安装和使用 fSpy 项目。