sim-chat

模组

· 作者 Yarden-zamir

一个 Minecraft 内置的聊天客户端,支持基于数据驱动的模拟对话和交互

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

最新 0.12.0 · 1.20.1 · Forge

一键开服(送7天)

Sim Chat

一个 Minecraft Forge 模组,为对话添加类 Slack/Discord 风格的聊天界面。旨在供整合包制作者通过数据包和命令来编写对话脚本。

功能特性

  • Slack/Discord 风格 UI:侧边栏显示对话列表,聊天历史面板带有消息气泡
  • 基于团队的对话:玩家在其所属团队内共享对话历史
  • 数据包驱动的对话:在 JSON 中定义对话树,作为数据包资源加载
  • 操作按钮:可点击的回复选项,用于触发命令或继续对话
  • 条件动作:根据数据、分数或 KubeJS 回调显示/隐藏按钮
  • 模板系统:支持包含玩家名称、团队数据、世界信息的动态文本
  • 输入指示器:消息出现前模拟打字延迟
  • Toast 通知:收到新消息时显示非侵入式弹窗
  • 自定义头像:从配置文件夹加载 PNG 图像作为发送者肖像
  • 团队数据存储:按团队存储数值、状态和分数
  • KubeJS 集成:注册用于条件和模板的自定义回调
  • SQLite 存储:持久化消息历史,针对大型对话采用懒加载
  • 可扩展性:支持处理 100k+ 条消息,具备流畅滚动和即时 UI 响应

依赖项

  • 需要 sqlite_jdbc 库模组 (minecraft-sqlite-jdbc),客户端和服务端均需安装

存储

对话历史记录存储在 SQLite 数据库中,路径为 <world>/data/simchat/simchat.db。这提供了:

  • 可扩展性:通过懒加载高效处理 100k+ 条消息
  • 持久性:数据在服务器重启和世界重载后保留
  • 可检查性:消息以人类可读的 JSON 格式存储(可在任何 SQLite 浏览器中查看)

命令

基本命令

/simchat send <player> <dialogueId>    - 向玩家发送对话
/simchat system <player> <entityId> <message>  - 发送系统消息
/simchat clear <player> [entityId]     - 清除聊天历史
/simchat open <player> [entityId]      - 为玩家打开聊天屏幕
/simchat openmessage <messageId>       - 打开聊天至特定消息
/simchat reload                        - 重新加载 KubeJS 回调

团队命令

/simchat team create <name>            - 创建新团队
/simchat team invite [player]          - 邀请玩家(如果省略则向所有人广播)
/simchat team join <teamId>            - 通过 ID 加入团队
/simchat team list                     - 列出所有团队
/simchat team info                     - 显示当前团队信息
/simchat team title <newTitle>         - 更改团队名称
/simchat team color <color>            - 更改团队颜色(仅名称)

可用颜色:black, dark_blue, dark_green, dark_aqua, dark_red, dark_purple, gold, gray, dark_gray, blue, green, aqua, red, light_purple, yellow, white

数据命令

按团队存储数值以跟踪进度、分数和状态。所有命令均接受可选的 [target] 参数(玩家名称或团队 ID/标题),以便对特定团队进行操作:

/simchat data get <key> [target]       - 获取值
/simchat data set <key> <value> [target]   - 设置值(自动检测数字)
/simchat data add <key> <amount> [target]  - 向数值添加数量
/simchat data remove <key> [target]    - 移除键
/simchat data list [target]            - 列出所有数据

示例:

/simchat data get gold                 - 获取你团队的金币
/simchat data get gold Steve           - 获取 Steve 所在团队的金币
/simchat data set rank vip "Team Alpha"    - 为 Team Alpha 设置字符串
/simchat data set gold 100             - 设置数字(自动检测)
/simchat data add points 10 abc1234    - 向团队 abc1234 添加 10 点

回调命令

/simchat callback list                 - 列出已注册的 KubeJS 回调
/simchat callback run <name> [player]  - 执行回调并显示结果

数据包格式

对话从以下位置加载:data/<namespace>/simchat/<path>.json

示例:data/mypack/simchat/contractor/greeting.json

{
  "entityId": "contractor",
  "entityName": "Director Vex",
  "entitySubtitle": "Helion Industries",
  "text": "Hello {player:name}! Your team ({team:title}) has completed {data:contracts_done} contracts.",
  "actions": [
    {
      "label": "Accept Contract (+{data:reward} credits)",
      "commands": [
        "simchat data add contracts_done 1",
        "give @s emerald 10"
      ],
      "reply": "I'll take the job.",
      "nextState": "mypack:contractor/contract_details",
      "condition": "data:has_clearance"
    },
    {
      "label": "Decline",
      "reply": "Not interested.",
      "condition": "!data:forced_contract"
    }
  ]
}

对话字段

字段 类型 描述
entityId string 唯一实体标识符(用于头像查找和对话分组)
entityName string 聊天中显示的显示名称
entitySubtitle string 可选副标题(公司、头衔)
text string 消息内容(支持模板)
actions array 回复按钮(可选)

动作字段

字段 类型 描述
label string 按钮文本(支持模板)
commands array 点击时运行的命令
reply string 聊天中显示的玩家回复(支持模板)
nextState string 此动作后触发的对话 ID
condition string 显示按钮必须满足的条件
itemsVisual array 按钮上显示的物品
itemsInput array 玩家必需的物品(启用前检查)
itemsOutput array 给予玩家的物品

物品格式

{
  "item": "minecraft:diamond",
  "count": 5
}

模板

模板适用于 entityName、entitySubtitle、text、label、reply 和 commands。

使用前缀 {compile:...}(默认)在消息创建时于服务器端解析,或使用 {runtime:...} 在消息显示时于客户端解析。运行时模板会在客户端存储并解析;服务器仅看到编译后的文本。当聊天窗口打开、收到新消息或点击刷新按钮时,运行时值会刷新。

在文本、标签和回复中使用 {resolver:name} 语法:

模板 描述 示例
{player:name} 玩家用户名 "Steve"
{player:uuid} 玩家 UUID "069a79f4..."
{team:id} 队伍 ID "a1b2c3d"
{team:title} 队伍名称 "The Builders"
{team:memberCount} 队伍成员数量 "3"
{team:color} 队伍颜色名称 "dark_blue"
{data:keyname} 队伍数据值 "42"
{world:day} 当前世界天数 "15"
{world:time} 一天中的时间 (0-24000) "6000"
{world:dimension} 维度 ID "minecraft:overworld"
{world:weather} 天气状态 "clear", "rain", "thunder"
{kjs:callbackName} KubeJS 回调结果 (任意值)

示例:

{
  "text": "Day {world:day}: Hello {player:name}! You have {data:points} points."
}

条件

使用条件来显示/隐藏操作按钮。使用前缀 ! 表示取反。

条件 描述
data:keyname 如果队伍数据为真(存在、非零、非空)则为 True
kjs:callbackName 如果 KubeJS 回调返回真值则为 True
score:objectiveName 如果玩家的计分板分数 > 0 则为 True
permission:level 如果玩家拥有权限等级则为 True

示例:

{
  "actions": [
    {
      "label": "VIP Option",
      "condition": "data:is_vip"
    },
    {
      "label": "Regular Option",
      "condition": "!data:is_vip"
    },
    {
      "label": "Admin Only",
      "condition": "permission:2"
    }
  ]
}

KubeJS 集成

在 kubejs/server_scripts/simchat.js 中注册回调:

// Clear old callbacks on reload
SimChat.clearCallbacks()

// Register a condition callback
SimChat.registerCallback('hasEnoughGold', ctx => {
    return ctx.player.persistentData.getInt('gold') >= 100
})

// Register a template callback
SimChat.registerCallback('goldAmount', ctx => {
    return ctx.player.persistentData.getInt('gold')
})

// Register using team data
SimChat.registerCallback('isVeteran', ctx => {
    return ctx.team && ctx.team.data.missions_completed >= 10
})

// Time-based callback
SimChat.registerCallback('greeting', ctx => {
    let time = ctx.player.level.dayTime % 24000
    if (time < 6000) return 'Good morning'
    if (time < 12000) return 'Good afternoon'
    return 'Good evening'
})

SimChat.logStatus() // Log callback count

回调上下文

在回调中通过 ctx 可用:

// Player (KubeJS wrapped - full access)
ctx.player
ctx.player.persistentData
ctx.player.level.dayTime
ctx.player.inventory

// Team (null if no team)
ctx.team.id
ctx.team.title
ctx.team.memberCount
ctx.team.data           // Map of all team data
ctx.team.data.keyname   // Access specific key
ctx.team.hasData('key') // Boolean check

// Entity (null if no entity context)
ctx.entity.id
ctx.entity.displayName
ctx.entity.messageCount
ctx.entity.lastMessage
ctx.entity.isTyping

在对话中使用

{
  "text": "{kjs:greeting}, {player:name}! You have {kjs:goldAmount} gold.",
  "actions": [
    {
      "label": "Buy Item (100 gold)",
      "condition": "kjs:hasEnoughGold",
      "commands": ["simchat data add purchases 1"]
    }
  ]
}

实体文件

将实体配置和头像放置在:config/simchat/entities/

每个实体可以包含:

  • <entityId>.json - 包含名称、副标题、头像设置的配置文件
  • <entityId>.png - 头像图片(任意大小,显示为 36x36)

示例:config/simchat/entities/merchant.json

{
  "name": "Merchant Bob",
  "subtitle": "Ironwood Trading Co.",
  "avatar": "merchant"
}
字段 描述
name 默认显示名称
subtitle 默认副标题
avatar 头像 ID(默认为 entityId)

默认值

创建 default.json 和/或 default.png 作为没有特定文件的实体的回退项。

所有实体文件在修改时会热重载。

配置

客户端配置 (simchat-client.toml)

选项 默认值 描述
notificationSound minecraft:block.note_block.bell 新消息时的声音
notificationVolume 0.5 声音音量 (0.0-1.0)
showToasts true 显示弹出通知
toastDuration 5.0 通知显示时间(秒)
sidebarWidth 240 对话列表宽度
sidebarSortMode 0 排序方式:0=最近,1=字母顺序
chatBackgroundColor 0xDD12121F 聊天面板背景色(ARGB 十六进制)
lazyLoadBatchSize 30 向上滚动时请求的消息数量
lazyLoadThreshold 100 距离顶部多少像素后加载旧消息
closedCacheSize 400 聊天关闭时每条对话保留缓存的消息数量

通用配置 (simchat-common.toml)

选项 默认值 描述
minDelay 0.3 最小打字延迟(秒)
maxDelay 3.0 最大打字延迟(秒)
charsPerSecond 100.0 模拟打字速度
permissions.* 4 各命令的权限等级 (0-4)
permissions.openmessage 0 允许打开消息链接
teamJoin.joinBehavior join_largest join_largest, join_smallest, join_random, create_new
teamJoin.joinSizeCap -1 自动加入上限(-1 禁用,若无符合条件的则创建新队)
initialMessageCount 30 初始同步时每条对话的消息数量
maxLazyLoadBatchSize 100 服务器端懒加载请求的上限

颜色覆盖 (simchat-client.toml)

颜色设置位于 [colors] 部分,接受 ARGB 十六进制字符串(例如 0xFF88AAFF)。示例:

[ui]
chatBackgroundColor = "0x8047BAFF"

[colors]
sidebarBackgroundColor = "0xFF1B2230"
headerTextColor = "0xFFBBD7FF"
messageTextColor = "0xFFE8F1FF"
contextMenuBgColor = "0xFF202030"
toastBackgroundColor = "0xFF243048"

可用的颜色键(均为可选):

  • sidebarBackgroundColor
  • dividerColor
  • dividerHoverColor
  • headerTextColor
  • headerSubtitleColor
  • emptyStateTextColor
  • headerSeparatorColor
  • refreshButtonColor
  • refreshButtonHoverColor
  • refreshTextColor
  • sortButtonColor
  • sortButtonHoverColor
  • sortTextColor
  • compactHintColor
  • scrollbarColor
  • inputBgColor
  • outputBgColor
  • disabledBgColor
  • playerNameColor
  • entityNameColor
  • subtitleColor
  • dayTextColor
  • messageTextColor
  • disabledTextColor
  • whiteTextColor
  • systemTextColor
  • buttonDefaultColor
  • buttonHoverColor
  • borderDisabledColor
  • borderHoverColor
  • borderDefaultColor
  • focusBorderColor
  • contextMenuBgColor
  • contextMenuBorderColor
  • contextMenuTextColor
  • contextMenuHighlightColor
  • inputValidColor
  • inputInvalidColor
  • inputFieldBgColor
  • inputFieldBorderColor
  • inputFieldBorderFocusedColor
  • inputCursorColor
  • inputSendEnabledColor
  • inputSendDisabledColor
  • toastSenderColor
  • toastPreviewColor
  • toastBackgroundColor
  • toastBorderColor
  • toastHintColor

快捷键

按键 操作
; (分号) 打开聊天界面

JSON Schema

使用 schemas/dialogue.schema.json 中的 JSON Schema 验证你的对话内容。

VS Code 配置:

{
  "$schema": "https://raw.githubusercontent.com/YardenZamir/sim-chat/main/schemas/dialogue.schema.json",
  "entityId": "...",
  ...
}

许可证

MIT

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

评论 0

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

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源