Parchment 项目教程

1. 项目介绍

Parchment 是一个基于 Web 的 Z-Machine 和 Glulx 虚拟机，专门用于运行 Infocom 和现代 Z-code 游戏。它是一个开源项目，旨在提供一个简单易用的平台，让用户能够在现代浏览器中体验经典的文字冒险游戏。

Parchment 的主要特点包括：

• 跨平台：支持在各种现代浏览器中运行。
• 兼容性强：能够运行多种格式的 Z-code 和 Glulx 游戏。
• 易于扩展：提供了丰富的 API 和插件机制，方便开发者进行扩展和定制。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保你已经安装了以下工具：

• Node.js (建议版本 v14 或更高)
• Git

2.2 克隆项目

首先，克隆 Parchment 项目到本地：

git clone https://github.com/curiousdannii/parchment.git
cd parchment

2.3 安装依赖

进入项目目录后，安装所需的依赖包：

npm install

2.4 启动开发服务器

安装完成后，启动开发服务器：

npm start

启动成功后，你可以在浏览器中访问 http://localhost:3000 来查看 Parchment 的运行效果。

3. 应用案例和最佳实践

3.1 运行经典游戏

Parchment 最常见的应用场景是运行经典的文字冒险游戏。你可以通过以下步骤加载并运行一个游戏文件：

1. 将游戏文件（通常是 .z5, .z8, 或 .ulx 格式）放置在 public/games 目录下。
2. 在浏览器中访问 http://localhost:3000/games/your-game-file.z5。

3.2 自定义界面

Parchment 提供了丰富的 API 和插件机制，允许开发者自定义界面和功能。例如，你可以通过修改 src/index.html 文件来调整界面的布局和样式。

3.3 集成到现有项目

如果你希望将 Parchment 集成到现有的 Web 项目中，可以通过以下步骤实现：

1. 将 Parchment 的源码复制到你的项目目录中。
2. 在你的 HTML 文件中引入 Parchment 的入口文件：

<script src="path/to/parchment/dist/parchment.js"></script>

3. 初始化 Parchment 并加载游戏文件：

const parchment = new Parchment();
parchment.loadGame('path/to/your-game-file.z5');

4. 典型生态项目

4.1 Inform 7

Inform 7 是一个用于创建交互式小说和文字冒险游戏的开发工具。Parchment 可以作为 Inform 7 游戏的运行环境，提供了一个现代化的平台来展示和运行这些游戏。

4.2 Twine

Twine 是一个开源的工具，用于创建非线性故事和文字冒险游戏。Parchment 可以与 Twine 集成，提供一个强大的运行环境，支持 Twine 生成的游戏文件。

4.3 Glulx

Glulx 是一种用于文字冒险游戏的虚拟机格式，Parchment 提供了对 Glulx 格式的全面支持，使得开发者可以在现代浏览器中运行和测试 Glulx 游戏。

通过这些生态项目的支持，Parchment 不仅能够运行经典的文字冒险游戏，还能够与现代开发工具无缝集成，为开发者提供了一个全面的解决方案。