Quixe 项目技术文档

1. 安装指南

1.1 环境准备

• 浏览器支持: Quixe 是一个纯 JavaScript 的 Glulx 虚拟机解释器，支持在现代浏览器中运行。
• Python: 如果你需要将游戏文件转换为 Quixe 可加载的格式，需要安装 Python。

1.2 下载项目

你可以从项目的 GitHub 仓库下载 Quixe 的源代码。下载后解压缩到你的工作目录。

1.3 安装依赖

Quixe 不需要额外的依赖库，但如果你需要使用 game2js.py 工具，确保你已经安装了 Python。

2. 项目的使用说明

2.1 使用 Quixe 运行游戏

Quixe 可以直接在浏览器中运行 Glulx 格式的游戏文件（.ulx 或 .gblorb）。你可以通过以下几种方式使用 Quixe：

2.1.1 使用 Inform 7 生成游戏页面

1. 下载 Quixe.zip 模板包并解压缩。
2. 将解压后的 Quixe 文件夹安装到 Inform 7 的模板目录中（例如在 Mac 上为 ~/Library/Inform/Templates）。
3. 在你的 Inform 7 源代码中添加以下行：

   Release along with the "Quixe" interpreter.
   

2.1.2 手动配置 Quixe 页面

1. 复制项目中的 play.html 文件及其依赖的 JavaScript 和 CSS 文件。
2. 使用 game2js.py 工具将你的游戏文件转换为 Quixe 可加载的格式：

   python tools/game2js.py --giload mystory.ulx > mystory.ulx.js
   

3. 在 play.html 中替换 glulxercise.ulx.js 为你的 mystory.ulx.js 文件。

2.1.3 远程加载游戏

如果你希望 Quixe 页面能够加载任何互联网上的游戏文件，可以使用 play-remote.html 文件。

2.2 保存与恢复游戏

Quixe 支持保存和恢复游戏进度。如果你的浏览器支持 HTML5 的本地存储功能，保存的游戏文件将在不同的浏览器会话中保持可用。

3. 项目API使用文档

3.1 Quixe 核心 API

Quixe 的核心 API 主要集中在 quixe.js 文件中，负责 Glulx 虚拟机的解释和执行。

3.2 Glk 层 API

gi_dispa.js 文件包含了 Glk 层的调度器，负责处理输入输出、窗口管理等功能。

3.3 游戏文件加载 API

gi_load.js 文件负责加载游戏文件，并处理 Blorb 格式的资源。

3.4 配置选项

Quixe 提供了一些配置选项，可以通过修改 play.html 中的 JavaScript 代码进行调整，例如：

• max_buffer_length: 控制文本缓冲区的最大长度。
• log_execution_time: 控制是否记录游戏执行时间。

4. 项目安装方式

4.1 直接使用

你可以直接将 Quixe 的文件复制到你的项目目录中，并根据需要修改 play.html 文件来加载你的游戏文件。

4.2 使用 Electron

如果你使用 Electron 环境，Quixe 提供了 elkote.min.js 文件，替换 glkote.min.js 即可。

4.3 构建项目

如果你需要重新构建 Quixe 的压缩 JavaScript 文件，可以使用 build.py 脚本：

python build.py

5. 总结

Quixe 是一个功能强大的 Glulx 虚拟机解释器，能够在浏览器中运行 Glulx 格式的游戏文件。通过本技术文档，你应该能够顺利安装、配置和使用 Quixe 来运行你的游戏。