Skip to content

安装指南

ShxNovel 是基于 Rust(使用 Tauri)和 Web 技术栈构建的。

对于非开发者而言,安装环境是一门艺术。在遇到困难时,请不要灰心,欢迎询问我们!

  1. 基础环境
  2. 开发环境

为了使用 ShxNovel 设计的工作流,推荐团队中的开发、艺术、剧本创作者都安装这些依赖项。

当然啦,如果团队拥有独立的艺术资源管理方式,艺术创作者可以跳过安装这些依赖项。

ShxNovel 的命令行工具 CLI 使用了 Node.js (version 20.0 或更高)
如果已经安装了 node 环境,可以在命令行使用 node -v 来检查版本

pnpm 是精致的包管理器,用于管理各类依赖。
在安装 Node.js 后,就可以在你的系统终端中使用 npm install -g pnpm 来安装!

Terminal window
npm install -g pnpm

Visual Studio Code 代码编辑器。
为了更好的开发体验,强烈推荐使用 Visual Studio Code(VSCode)作为你的编辑器。

前往我们的 Github 储存库 ShxNovel 下载最新的 release 包(随后解压到你喜欢的目录)

在完成下载后,请进入项目目录(或其中的任意子目录),在终端中使用 pnpm i 安装依赖。

Terminal window
pnpm i

在完成下载后(或者等待下载的过程中),欢迎阅读之后的教程,了解 ShxNovel 的基本使用方法。

对于需要预览项目(尤其是负责程序开发)的角色而言,你还需要安装以下依赖:

在 Windows 下,你需要安装:Rust 以及 Microsoft C++ 生成工具

如果为 Windows 7 或更低,还需要安装 下载 WebView2 运行时(选择常青独立安装程序)

如果希望完成跨平台打包,可以参阅 Tauri 官方的指南。