快速入门
BTC Studio 为 TypeWriter(面向 Paper 服务器的任务与叙事引擎)开发扩展。本文档介绍每个扩展:它的功能、安装方法,以及它添加的每个条目及其全部字段。
五分钟了解 TypeWriter
TypeWriter 用一个网页面板取代配置文件。你在服务器中打开面板(/typewriter connect),搭建由条目组成的页面,将它们相互连接,然后发布:服务器无需重启即可应用更改。
| 概念 | 说明 |
|---|---|
| 页面(Page) | 条目的容器。序列页面存放对话和动作,静态页面存放定义(构件、说话者、NPC 定义),清单页面存放始终处于激活状态的内容(受众、展示),过场动画页面存放时间轴。 |
| 条目(Entry) | 一个构建单元,由其类型标识(例如 schematic_block)。每个条目都有可在检查器中填写的字段。 |
| 触发器(Trigger) | 从一个条目指向下一个条目的链接:事件触发动作,动作再触发对话…… |
| 事实(Fact) | 按玩家存储或计算的值,用于条件中判断某个条目是否执行,并可由修改器更改。 |
| 受众(Audience) | 对玩家的筛选器(位于某区域内、手持某物品、处于某任务步骤)。名牌、假方块或 HUD 等展示会向某个受众显示。 |
| 构件(Artifact) | 由扩展拥有的持久化数据(已放置的结构、商店库存、统计数据)。 |
扩展会为这个工具箱添加新的条目类型。安装扩展后,它的条目会出现在面板搜索栏中,以及对应页面类型的 + 按钮下。
安装扩展
- 在 Paper 服务器上安装 TypeWriter,并确认面板可以打开。
- 下载扩展:免费扩展从其 GitHub Releases 下载,付费扩展从 Voxel 或 BuiltByBit 获取。下载按钮位于每个扩展页面的顶部。
- 安装扩展页面中 Requires 下列出的插件。
- 将 JAR 放入
plugins/Typewriter/extensions/并重启服务器。 - 打开面板:新条目会出现在搜索栏中。
版本
每个扩展页面都会显示其文档对应的版本以及所需的 TypeWriter 版本。更新 TypeWriter 时,请同时将其扩展更新到匹配的版本。
如何查阅本文档
- **扩展目录**列出所有扩展,并可按可用性和主题筛选。
- 每个扩展页面采用相同的结构:概览、功能、安装、快速上手、命令、权限、占位符、条目、故障排查。
- 每个条目页面展示该条目在面板中的样子(标识符、类别、图标),以及其字段表,包含类型、默认值和说明。这些表格由扩展源码生成,因此与发布的代码保持一致。
| 可用性 | 含义 |
|---|---|
| 免费 | 开源,可从 GitHub 下载。 |
| 付费 | 高级集成,在 Voxel 和 BuiltByBit 上出售。 |
| 私有 | 运行于 BornToCraft 服务器网络的 TypeWriter BTC 构建版本;文档仅供参考,不对外分发。 |
| 即将推出 | 开发中;条目仍可能变化。 |
获取帮助
请在 BTC Studio Discord 提问。如果免费扩展出现 bug,请在其 GitHub 仓库提交 issue,并附上扩展版本、TypeWriter 版本以及服务器日志中的第一条错误。