SugarCube v2 项目教程

SugarCube v2 项目教程

sugarcube-2 SugarCube is a free (gratis and libre) story format for Twine/Twee. 项目地址: https://gitcode.com/gh_mirrors/su/sugarcube-2

1. 项目目录结构及介绍

SugarCube v2 是一个开源项目，为 Twine/Twee 提供了一个免费的故事格式。项目的目录结构如下：

• .github/: 存放 GitHub 的一些配置文件。
• .vscode/: Visual Studio Code 编辑器的配置文件。
• dist/: 存放编译后的文件，包括 Twine 1 和 Twine 2 两种格式的故事格式。
• docs/: 项目文档。
• locale/: 本地化文件，包含各种语言的翻译。
• scripts/: 脚本文件，用于项目的构建等。
• src/: 源代码目录，包含项目的核心代码。
• template/: 模板文件。
• vendor/: 第三方库和插件。
• .browserslistrc: 指定项目支持的浏览器。
• .eslintrc.json: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件。
• .stylelintignore: Stylelint 忽略文件。
• .stylelintrc.json: Stylelint 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目介绍和说明文件。
• build.js: 项目构建脚本。
• icon.svg: 项目图标。
• package-lock.json: npm 依赖锁定文件。
• package.json: npm 项目配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 build.js 文件进行。这个文件是一个 Node.js 脚本，用于构建和编译项目。以下是启动项目的基本步骤：

1. 确保安装了 Node.js (目前版本 ≥v16) 和 Git。
2. 克隆项目仓库到本地：git clone https://github.com/tmedwards/sugarcube-2.git
3. 切换到项目目录：cd sugarcube-2
4. 切换到正确的分支（develop 或 master）。
5. 安装项目依赖：npm install
6. 构建项目：node build.js

构建完成后，编译后的故事格式文件会输出到 dist 目录。

3. 项目的配置文件介绍

项目的主要配置文件包括：

• .eslintrc.json: ESLint 配置文件，用于定义代码风格和规则。
• .stylelintrc.json: Stylelint 配置文件，用于定义 CSS 的代码风格和规则。
• package.json: npm 项目配置文件，定义了项目的依赖、脚本和元数据。

这些配置文件是项目开发和维护过程中不可或缺的部分，它们帮助保持代码的一致性和质量。开发者可以根据项目需求对这些配置文件进行自定义和调整。

sugarcube-2 SugarCube is a free (gratis and libre) story format for Twine/Twee. 项目地址: https://gitcode.com/gh_mirrors/su/sugarcube-2