npm 包 twinejson-cli 使用教程

阅读时长 4 分钟读完

简介

twinejson-cli 是一个 npm 包,用于将 Twine 中创建的交互小说中的数据导出为 JSON 格式,以便在 Web 应用程序中使用。本教程将介绍如何安装、使用、以及扩展 twinejson-cli。

安装

使用以下命令安装 twinejson-cli:

使用

twinejson-cli 提供了以下命令:

  • twinejson-cli init:在当前目录初始化 Twine 项目。
  • twinejson-cli parse:从 Twine 项目中解析数据并生成 JSON 文件。
  • twinejson-cli help:显示 twinejson-cli 的帮助信息。

初始化

在一个空目录下使用以下命令初始化 Twine 项目:

然后,twinejson-cli 将自动下载 Twine 编辑器并在当前目录下创建一个新的 Twine 项目。

解析

在 Twine 项目中创建完整的交互小说后,可以使用以下命令从 Twine 项目中解析出数据并生成 JSON 文件:

生成的 JSON 文件将保存在当前目录下的 twinejson.json 文件中。如果要保存到其他位置,则可以运行以下命令:

扩展

twinejson-cli 是可以扩展的。如果您使用的 Twine 版本支持 SugarCube 插件,则可以通过 SugarCube 插件将更多数据添加到生成的 JSON 文件中。

以下是一个示例插件:

-- -------------------- ---- -------
---- --------

---
 - --------- --------- ------
 -
 - -------- ---------- ----- ----
 - ------- - ------ -- -
 --

-- ------------------------------------- -- ------------------ --- -------------- -

  ---
   - -------- --- --------- ------
   -
   - ---------- ----- ----
   - - ------ -- -
   --
  --------------------- -
    ------- - -------- -- -

      --- ---- - ----------

      -- ----- --- --------- ---- -------
      --- ------ - ---
      --- ---- - - -- - - ------------ - -- -- -
        --- --- - --------
        --- ----- - ------ - ---
        ----------- - ------
      -

      -- ----- --- --------- ---- ------ ---- --- --------- -------
      --- --------- - ------------------------------
      -- --------------------------------------- -
        ------------------ - ---
      -
      --------------------------------- --------
    -
  ---
-

此插件允许在 Twine 中使用以下语法:

将在生成的 JSON 文件中添加以下部分:

总结

使用 twinejson-cli 可以方便地将 Twine 项目导出为 JSON 文件,以便在 Web 应用程序中使用。此外,通过 SugarCube 插件,可以将更多数据添加到生成的 JSON 文件中。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005595181e8991b448d6b6b

纠错
反馈