@6i/ink-tools 中文文档教程

Question

ink-tools

将 inkle 的故事 Ink 文件编译成 JSON，带有观看模式。

Features

ink-utils 是一个使用 commander.js。 它的设计是为了促进与 inkjs 的集成，inkle 的 ink 脚本语言的 javascript 实现，并使用 ink story到 Web 应用程序（SPA、React、Angular …）

中 ink-utils 可以：

• Compile a ink file into Json.
• Watch for ink file changes, in order to perform compilation each time.

Installation

使用 npm 或 纱线。

全局安装：

$ yarn global add @6i/ink-tools

作为本地开发依赖项：

$ yarn add @6i/ink-tools --dev

Usages

Options

compile 命令有很多选项：

options	description
-s, --silent	Do not output any message
-vǀ-vvǀ-vvv, --verbose	Increase the verbosity level : level 1 for normal information, 2 more verbose for debugging and 3 for full debug.
-o, --output	Change the output where JSON file is created.
-w, --watch	Enable watch mode, to detect if ink file has changed and start compilation each time.

Make a single compilation

compile 命令等待 *.ink 文件作为第一个参数。 如果没有其他选项，它将编译成一个与输入墨水文件同名且相同文件夹的 json 文件。

# Simple usage
$ ink-tools compile .\ink\story-basic.ink

=== Start compilation ===
[success] Inklecate compilation has finished !

您可以使用 -v 添加详细信息，并使用 --output 更改输出，如下所示：

# Change output JSON
$ ink-tools compile .\ink\story-basic.ink -v --output .\myStory.json

=== Start compilation ===
[info] Ink name file: story-basic.ink
[info] Ink path file: D:\6i\ink-tools\ink\story-basic.ink
[info] Output JSON: D:\6i\ink-tools\myStory.json
[info] Inklecate bin: D:\6i\ink-tools\bin\inklecate\inklecate_win.exe
[info] Ink compilation is starting.
[success] Inklecate compilation has finished !

Watch for ink file change

要启用监视模式，只需添加 --watch< /code> compile 命令中的选项。

$ ink-tools compile .\ink\story-basic.ink --watch -v

该程序可以监听墨水文件的变化，并在每次检测到变化时开始编译。 它使用文件的 MD5 校验和来检查文件是否真的改变了。

Ink story

Ink 是 < a href="http://www.inklestudios.com">inkle 用于编写交互式叙述的脚本语言，既适用于以文本为中心的游戏，也适用于包含高度分支故事的更多图形游戏。 它旨在易于学习，但具有足够强大的功能以允许高级结构化。

License

在 MIT 许可下发布。

Copyright

版权所有 (c) 2020 by 2o1oo vb20100bv@gmail.com