ChatDiag

模组

· 作者 Lau6L

专为服务器活动设计的简单、非交互式聊天对话(独白!)。兼容数据包。

0 本站下载 0 关注 更新于 4 个月前

需要前置:Fabric API

最新 1.0.0+1.21.11 · 1.21.11 · Fabric

一键开服(送7天)

这个轻量级模组为聊天添加了结构化、定时的消息:通过精确的每分钟字数(WPM)计时和逐行递送来创建独白!

ChatDiag 的对话可以由数据包、命令方块、玩家执行或模组集成提供。它们专为服务器事件中的故事讲述和地图制作而设计。

对话支持格式化代码,以及自定义声音、字体和命令。

执行对话

要开始渲染对话,请使用新的 /chatdiag 或 /cdiag 管理员命令。

语法

按命名空间执行已定义的对话

/chatdiag [players] id [dialog-id]

示例:

/chatdiag @s id example:example_dialog

id dialog usage

按数据执行已定义的对话

/chatdiag [players] data [dialog-object]

示例:

/cdiag @a data {"prefix": "<ChatDiag> ", "lines": ["Hello!", "This dialog was not defined in any file."]}

data dialog usage

开发

数据包

数据驱动的对话通过命名空间资源定义。这些定义必须位于 chatdiag/ 目录下(data/<namespace>/chatdiag/<file>.json,加载为 <namespace>:<file>),适用于模组资源或数据包。

/reload 会重新加载数据包中的对话。

模组集成

ChatDiag 为模组提供了 ChatDiag.api() 集成入口点。

对话可以保持相同的可完成未来状态跨链式对话,因此结果仅在整条链完成后才完成。

为了在您的模组中声明对 ChatDiag 的依赖,请将以下内容添加到您的 build.gradle 中:

repositories {
    // ...
    maven { url = "https://api.modrinth.com/maven" }
}
dependencies {
    // ...

    // chatdiag_version 示例,用于 1.0.0+1.21.11: 7GbCgI5k
    modImplementation "maven.modrinth:chatdiag:${project.chatdiag_version}"
}
对话定义

对话

对话由一系列**行(Lines)**列表组成,以及可选的设置以添加自定义行为。这些行为包括:

  • WPM。每分钟字数。控制每行的延迟。默认为 120,必须为正数。
  • 前缀。在每行之前渲染。
  • 后缀。在每行之后渲染。
  • 声音。可以是单个条目或数组。为每行播放。
  • 下一个对话。用于将对话链接在一起。必须是命名空间的对话标识符。在给定对话结束后,下一个对话将开始。
  • 下一个命令。必须是有效的 Minecraft/模组命令。在当前对话结束时执行。通过对话运行的命令继承其源的权限。因此,如果从数据包执行,某人可能会使用它们运行一些恶作剧命令,所以请确保您了解正在执行的对话,不要盲目地运行共享对话。小心!

对话行可以是:

  • 具有其对话行为的字符串,或者
  • 具有自定义行为的 DialogLine 对象。定义的自定义行为能够覆盖或添加到其对话的设置中。

DialogLine 对象可以通过其 replace_prefix、replace_suffix 和 replace_sound 布尔标志替换其父对话的行为。 此外,DialogLines 可以使用其 command 属性执行命令。这与 Dialogs 的 next_command 不同,因为 command 在渲染时运行,而 next_command 在最后一条行的延迟过后运行。

Sound 对象包含一个命名空间声音 Id,以及以下可选属性:

  • 音高。默认为 1。范围在 0.5 到 2.0 之间。
  • 音量。默认为 1。必须为正数。
  • 位置。默认为每个玩家的客户端。可以是列表或单个条目。每个条目定义为向量或描述实体选择器的字符串。这对于任意位置特别有用,因为可以使用标记实体。 如果玩家未安装 ChatDiag,则未指定位置的声音将在每个玩家的位置处播放。因此,如果玩家移动,声音将定位到声音开始播放时他们站立的位置(就像 /playsound 命令一样)。因此,建议同时在服务器和客户端上安装 ChatDiag,但并非必需。
对话定义示例
{
  "wpm": "number",

  "sound": {
    "id": "string",
    "pitch": "number"
  },

  "prefix": "string",
  "suffix": "string",

  "lines": [
    "string",

    {
      "line": "string",

      "replace_sound": "boolean",
      "replace_prefix": "boolean",
      "replace_suffix": "boolean",

      "sound": [
        {
          "id": "string",
          "pitch": "number",
          "position": "string"
        },
        {
          "id": "string",
          position: [
            ["number", "number", "number"],
            "string",
            "string"
          ]
        }
      ],

      "prefix": "string",
      "suffix": "string",

      "delay": "number",

      "command": "string"
    }
  ],

  "next_command": "string",
  "next_dialog": "string",
}
开发技巧
  • 在处理对话链和分支时,通常建议利用文件夹结构。例如,example:entity/mission/success 和 example:entity/welcome/0 在拥有多个实体和任务对话的情况下,大多优于 example:entity_mission_success 和 example:entity_welcome_start。
  • 不要在 next_command 属性中调用新对话。如果你希望在一个对话结束后立即开始另一个对话(无需等待最后一行的延迟),可以将最后一行转换为 DialogLine 对象,并指定 "delay": 0。
  • 指定声音位置时,不建议使用数据包宏(datapack macros)。如果值不发生变化,最好将其放在向量位置;如果会变化,标记实体选择器往往更加灵活。

欢迎在你的整合包中使用此模组!

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源