# Sim Chat<\/p>\n
A Minecraft Forge mod that adds a slack\/discord-style chat interface for dialogues. Designed for modpack creators to script conversations via datapacks and commands.<\/p>\n
## Features<\/p>\n
– **Slack\/Discord-style UI**: Sidebar with conversation list, chat history panel with message bubbles
\n– **Team-based conversations**: Players share conversation history within their team
\n– **Datapack-driven dialogues**: Define dialogue trees in JSON, loaded as datapack resources
\n– **Action buttons**: Clickable response options that trigger commands or continue dialogue
\n– **Conditional actions**: Show\/hide buttons based on data, scores, or KubeJS callbacks
\n– **Template system**: Dynamic text with player names, team data, world info
\n– **Typing indicators**: Simulated typing delay before messages appear
\n– **Toast notifications**: Non-intrusive popups when new messages arrive
\n– **Custom avatars**: Load PNG images from config folder for sender portraits
\n– **Team data storage**: Store values, states, and scores per-team
\n– **KubeJS integration**: Register custom callbacks for conditions and templates
\n– **SQLite storage**: Persistent message history with lazy loading for large conversations
\n– **Scalable**: Handles 100k+ messages with smooth scrolling and instant UI response<\/p>\n
## Dependencies<\/p>\n
– Requires the `sqlite_jdbc` library mod (`minecraft-sqlite-jdbc`) on both client and server<\/p>\n
## Storage<\/p>\n
Conversation history is stored in a SQLite database at ` – **Scalability**: Handles 100k+ messages efficiently with lazy loading ## Commands<\/p>\n ### Basic Commands<\/p>\n “` ### Team Commands<\/p>\n “` Available colors: `black`, `dark_blue`, `dark_green`, `dark_aqua`, `dark_red`, `dark_purple`, `gold`, `gray`, `dark_gray`, `blue`, `green`, `aqua`, `red`, `light_purple`, `yellow`, `white`<\/p>\n ### Data Commands<\/p>\n Store values per-team for tracking progress, scores, states. All commands accept an optional `[target]` parameter (player name or team ID\/title) to operate on a specific team:<\/p>\n “` Examples: ### Callback Commands<\/p>\n “` ## Datapack Format<\/p>\n Dialogues are loaded from: `data\/ Example: `data\/mypack\/simchat\/contractor\/greeting.json`<\/p>\n “`json ### Dialogue Fields<\/p>\n | Field | Type | Description | ### Action Fields<\/p>\n | Field | Type | Description | ### Item Format<\/p>\n “`json ## Templates<\/p>\n Templates work in `entityName`, `entitySubtitle`, `text`, `label`, `reply`, and `commands`.<\/p>\n Prefix with `{compile:…}` (default) to resolve on the server when the message is created, or `{runtime:…}` to resolve on the client when the message is displayed. Runtime templates are stored and resolved client-side; the server only sees the compiled text. Runtime values refresh when the chat opens, when new messages arrive, or via the Refresh button.<\/p>\n Use `{resolver:name}` syntax in text, labels, and replies:<\/p>\n | Template | Description | Example | Example: ## Conditions<\/p>\n Use conditions to show\/hide action buttons. Prefix with `!` to negate.<\/p>\n | Condition | Description | Examples: ## KubeJS Integration<\/p>\n Register callbacks in `kubejs\/server_scripts\/simchat.js`:<\/p>\n “`javascript \/\/ Register a condition callback \/\/ Register a template callback \/\/ Register using team data \/\/ Time-based callback Example: `config\/simchat\/entities\/merchant.json`<\/p>\n “`json | Field | Description | ### Defaults<\/p>\n Create `default.json` and\/or `default.png` as fallbacks for entities without specific files.<\/p>\n All entity files hot-reload when modified.<\/p>\n ## Configuration<\/p>\n ### Client Config (`simchat-client.toml`)<\/p>\n | Option | Default | Description | ### Common Config (`simchat-common.toml`)<\/p>\n | Option | Default | Description | ### Color Overrides (`simchat-client.toml`)<\/p>\n Color settings live under the `[colors]` section and accept ARGB hex strings (e.g. `0xFF88AAFF`). Example:<\/p>\n “`toml [colors] Available color keys (all optional):<\/p>\n – `sidebarBackgroundColor` ## Keybinds<\/p>\n | Key | Action | ## JSON Schema<\/p>\n Validate your dialogues with the JSON schema at [`schemas\/dialogue.schema.json`](schemas\/dialogue.schema.json).<\/p>\n VS Code setup: ## License<\/p>\n MIT<\/p>\n","protected":false},"excerpt":{"rendered":" A chatclient inside minecraft with databack driven simulated conversations and dialog<\/p>\n","protected":false},"featured_media":139782,"template":"","meta":{"_minecraft_slug":"sim-chat","_minecraft_project_id":"oYh7N7U3","_minecraft_author":"Yarden-zamir","_minecraft_license":"MIT","_minecraft_downloads":857,"_minecraft_follows":0,"_minecraft_client_side":"required","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"sim-chat.zip","_minecraft_size_bytes":2273045,"_minecraft_version_count":11,"_minecraft_updated_at":"2026-05-15T19:30:21.904635Z","_minecraft_date_created":"2026-01-16T03:03:42.170721Z","_minecraft_date_modified":"2026-01-27T07:40:33.842911Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/sim-chat","_minecraft_icon_attachment_id":139782,"_minecraft_imported_at":"2026-06-08T06:54:27+00:00","_minecraft_import_hash":"938dfb0e11092a6f593b30a700a02e02","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[104],"mod_loader":[106],"minecraft_version":[36],"class_list":["post-139781","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-forge","mod_loader-forge","minecraft_version-1-20-1"],"yoast_head":"\n
\n– **Persistence**: Data survives server restarts and world reloads
\n– **Inspectability**: Messages stored as human-readable JSON (viewable in any SQLite browser)<\/p>\n
\n\/simchat send
\n\/simchat system
\n\/simchat clear
\n\/simchat open
\n\/simchat openmessage
\n\/simchat reload – Reload KubeJS callbacks
\n“`<\/p>\n
\n\/simchat team create
\n\/simchat team invite [player] – Invite player (or broadcast to all if omitted)
\n\/simchat team join
\n\/simchat team list – List all teams
\n\/simchat team info – Show current team info
\n\/simchat team title
\n\/simchat team color
\n“`<\/p>\n
\n\/simchat data get
\n\/simchat data set
\n\/simchat data add
\n\/simchat data remove
\n\/simchat data list [target] – List all data
\n“`<\/p>\n
\n“`
\n\/simchat data get gold – Get your team’s gold
\n\/simchat data get gold Steve – Get Steve’s team’s gold
\n\/simchat data set rank vip “Team Alpha” – Set string on Team Alpha
\n\/simchat data set gold 100 – Set number (auto-detected)
\n\/simchat data add points 10 abc1234 – Add 10 points to team abc1234
\n“`<\/p>\n
\n\/simchat callback list – List registered KubeJS callbacks
\n\/simchat callback run
\n“`<\/p>\n
\n{
\n “entityId”: “contractor”,
\n “entityName”: “Director Vex”,
\n “entitySubtitle”: “Helion Industries”,
\n “text”: “Hello {player:name}! Your team ({team:title}) has completed {data:contracts_done} contracts.”,
\n “actions”: [
\n {
\n “label”: “Accept Contract (+{data:reward} credits)”,
\n “commands”: [
\n “simchat data add contracts_done 1”,
\n “give @s emerald 10”
\n ],
\n “reply”: “I’ll take the job.”,
\n “nextState”: “mypack:contractor\/contract_details”,
\n “condition”: “data:has_clearance”
\n },
\n {
\n “label”: “Decline”,
\n “reply”: “Not interested.”,
\n “condition”: “!data:forced_contract”
\n }
\n ]
\n}
\n“`<\/p>\n
\n|——-|——|————-|
\n| `entityId` | string | Unique entity identifier (used for avatar lookup and conversation grouping) |
\n| `entityName` | string | Display name shown in chat |
\n| `entitySubtitle` | string | Optional subtitle (company, title) |
\n| `text` | string | Message content (supports templates) |
\n| `actions` | array | Response buttons (optional) |<\/p>\n
\n|——-|——|————-|
\n| `label` | string | Button text (supports templates) |
\n| `commands` | array | Commands to run when clicked |
\n| `reply` | string | Player’s reply shown in chat (supports templates) |
\n| `nextState` | string | Dialogue ID to trigger after this action |
\n| `condition` | string | Condition that must be true to show button |
\n| `itemsVisual` | array | Items to display on button |
\n| `itemsInput` | array | Items required from player (checked before enabling) |
\n| `itemsOutput` | array | Items given to player |<\/p>\n
\n{
\n “item”: “minecraft:diamond”,
\n “count”: 5
\n}
\n“`<\/p>\n
\n|———-|————-|———|
\n| `{player:name}` | Player’s username | “Steve” |
\n| `{player:uuid}` | Player’s UUID | “069a79f4…” |
\n| `{team:id}` | Team ID | “a1b2c3d” |
\n| `{team:title}` | Team name | “The Builders” |
\n| `{team:memberCount}` | Number of team members | “3” |
\n| `{team:color}` | Team color name | “dark_blue” |
\n| `{data:keyname}` | Team data value | “42” |
\n| `{world:day}` | Current world day | “15” |
\n| `{world:time}` | Time of day (0-24000) | “6000” |
\n| `{world:dimension}` | Dimension ID | “minecraft:overworld” |
\n| `{world:weather}` | Weather state | “clear”, “rain”, “thunder” |
\n| `{kjs:callbackName}` | KubeJS callback result | (any value) |<\/p>\n
\n“`json
\n{
\n “text”: “Day {world:day}: Hello {player:name}! You have {data:points} points.”
\n}
\n“`<\/p>\n
\n|———–|————-|
\n| `data:keyname` | True if team data is truthy (exists, non-zero, non-empty) |
\n| `kjs:callbackName` | True if KubeJS callback returns truthy |
\n| `score:objectiveName` | True if player’s scoreboard score > 0 |
\n| `permission:level` | True if player has permission level |<\/p>\n
\n“`json
\n{
\n “actions”: [
\n {
\n “label”: “VIP Option”,
\n “condition”: “data:is_vip”
\n },
\n {
\n “label”: “Regular Option”,
\n “condition”: “!data:is_vip”
\n },
\n {
\n “label”: “Admin Only”,
\n “condition”: “permission:2”
\n }
\n ]
\n}
\n“`<\/p>\n
\n\/\/ Clear old callbacks on reload
\nSimChat.clearCallbacks()<\/p>\n
\nSimChat.registerCallback(‘hasEnoughGold’, ctx => {
\n return ctx.player.persistentData.getInt(‘gold’) >= 100
\n})<\/p>\n
\nSimChat.registerCallback(‘goldAmount’, ctx => {
\n return ctx.player.persistentData.getInt(‘gold’)
\n})<\/p>\n
\nSimChat.registerCallback(‘isVeteran’, ctx => {
\n return ctx.team && ctx.team.data.missions_completed >= 10
\n})<\/p>\n
\nSimChat.registerCallback(‘greeting’, ctx => {
\n let time = ctx.player.level.dayTime % 24000
\n if (time < 6000) return 'Good morning'\n if (time < 12000) return 'Good afternoon'\n return 'Good evening'\n})\n\nSimChat.logStatus() \/\/ Log callback count\n```\n\n### Callback Context\n\nAvailable in callbacks via `ctx`:\n\n```javascript\n\/\/ Player (KubeJS wrapped - full access)\nctx.player\nctx.player.persistentData\nctx.player.level.dayTime\nctx.player.inventory\n\n\/\/ Team (null if no team)\nctx.team.id\nctx.team.title\nctx.team.memberCount\nctx.team.data \/\/ Map of all team data\nctx.team.data.keyname \/\/ Access specific key\nctx.team.hasData('key') \/\/ Boolean check\n\n\/\/ Entity (null if no entity context)\nctx.entity.id\nctx.entity.displayName\nctx.entity.messageCount\nctx.entity.lastMessage\nctx.entity.isTyping\n```\n\n### Usage in Dialogues\n\n```json\n{\n \"text\": \"{kjs:greeting}, {player:name}! You have {kjs:goldAmount} gold.\",\n \"actions\": [\n {\n \"label\": \"Buy Item (100 gold)\",\n \"condition\": \"kjs:hasEnoughGold\",\n \"commands\": [\"simchat data add purchases 1\"]\n }\n ]\n}\n```\n\n## Entity Files\n\nPlace entity configs and avatars in: `config\/simchat\/entities\/`\n\nEach entity can have:\n- `
\n– `
\n{
\n “name”: “Merchant Bob”,
\n “subtitle”: “Ironwood Trading Co.”,
\n “avatar”: “merchant”
\n}
\n“`<\/p>\n
\n|——-|————-|
\n| `name` | Default display name |
\n| `subtitle` | Default subtitle |
\n| `avatar` | Avatar ID (defaults to entityId) |<\/p>\n
\n|——–|———|————-|
\n| `notificationSound` | `minecraft:block.note_block.bell` | Sound on new message |
\n| `notificationVolume` | `0.5` | Sound volume (0.0-1.0) |
\n| `showToasts` | `true` | Show toast popups |
\n| `toastDuration` | `5.0` | Toast display time (seconds) |
\n| `sidebarWidth` | `240` | Conversation list width |
\n| `sidebarSortMode` | `0` | Sort: 0=recent, 1=alphabetical |
\n| `chatBackgroundColor` | `0xDD12121F` | Chat panel background (ARGB hex) |
\n| `lazyLoadBatchSize` | `30` | Messages to request when scrolling up |
\n| `lazyLoadThreshold` | `100` | Pixels from top before loading older messages |
\n| `closedCacheSize` | `400` | Messages to keep cached per conversation when chat closes |<\/p>\n
\n|——–|———|————-|
\n| `minDelay` | `0.3` | Minimum typing delay (seconds) |
\n| `maxDelay` | `3.0` | Maximum typing delay (seconds) |
\n| `charsPerSecond` | `100.0` | Simulated typing speed |
\n| `permissions.*` | `4` | Per-command permission levels (0-4) |
\n| `permissions.openmessage` | `0` | Allow opening message links |
\n| `teamJoin.joinBehavior` | `join_largest` | `join_largest`, `join_smallest`, `join_random`, `create_new` |
\n| `teamJoin.joinSizeCap` | `-1` | Auto-join cap (-1 disables, creates new if none eligible) |
\n| `initialMessageCount` | `30` | Messages per conversation on initial sync |
\n| `maxLazyLoadBatchSize` | `100` | Server-side cap for lazy load requests |<\/p>\n
\n[ui]
\nchatBackgroundColor = “0x8047BAFF”<\/p>\n
\nsidebarBackgroundColor = “0xFF1B2230”
\nheaderTextColor = “0xFFBBD7FF”
\nmessageTextColor = “0xFFE8F1FF”
\ncontextMenuBgColor = “0xFF202030”
\ntoastBackgroundColor = “0xFF243048”
\n“`<\/p>\n
\n– `dividerColor`
\n– `dividerHoverColor`
\n– `headerTextColor`
\n– `headerSubtitleColor`
\n– `emptyStateTextColor`
\n– `headerSeparatorColor`
\n– `refreshButtonColor`
\n– `refreshButtonHoverColor`
\n– `refreshTextColor`
\n– `sortButtonColor`
\n– `sortButtonHoverColor`
\n– `sortTextColor`
\n– `compactHintColor`
\n– `scrollbarColor`
\n– `inputBgColor`
\n– `outputBgColor`
\n– `disabledBgColor`
\n– `playerNameColor`
\n– `entityNameColor`
\n– `subtitleColor`
\n– `dayTextColor`
\n– `messageTextColor`
\n– `disabledTextColor`
\n– `whiteTextColor`
\n– `systemTextColor`
\n– `buttonDefaultColor`
\n– `buttonHoverColor`
\n– `borderDisabledColor`
\n– `borderHoverColor`
\n– `borderDefaultColor`
\n– `focusBorderColor`
\n– `contextMenuBgColor`
\n– `contextMenuBorderColor`
\n– `contextMenuTextColor`
\n– `contextMenuHighlightColor`
\n– `inputValidColor`
\n– `inputInvalidColor`
\n– `inputFieldBgColor`
\n– `inputFieldBorderColor`
\n– `inputFieldBorderFocusedColor`
\n– `inputCursorColor`
\n– `inputSendEnabledColor`
\n– `inputSendDisabledColor`
\n– `toastSenderColor`
\n– `toastPreviewColor`
\n– `toastBackgroundColor`
\n– `toastBorderColor`
\n– `toastHintColor`<\/p>\n
\n|—–|——–|
\n| `;` (semicolon) | Open chat screen |<\/p>\n
\n“`json
\n{
\n “$schema”: “https:\/\/raw.githubusercontent.com\/YardenZamir\/sim-chat\/main\/schemas\/dialogue.schema.json”,
\n “entityId”: “…”,
\n …
\n}
\n“`<\/p>\n