Channels (@runmu.sh/ext-channels, id channels)

The Channels panel of μClient (R-CHAN): the game's chat channels as a rail of chips, the selected channel's messages with search, a colour and alert setting per channel, a ❯ composer, and a pop-out per channel.

First-party, on the marketplace. Install it from ☰ → Extensions → Discover, then turn it on per world in Extensions → Installed. Until 1.0.0 the panel was part of the client core. The core still tracks every session's channels (messages, unread counts, mentions, read markers). Since 1.2.0 this extension owns the channel settings: mute, alerts and colour per channel, the reply format and the Channel alerts toggle.

Where the channels come from

The host keeps the channels per session and fills them from:

| Source | Contract | What | |---|---|---| | GMCP Comm.Channel.List (in) | schema/list.json, CommChannelList | The channels in rail order: a name, or { name, caption?, command? } (caption is shown, command is sent) | | GMCP Comm.Channel.Text (in) | schema/text.json, CommChannelText | A message: channel, talker/sender/from, text (ANSI stripped), reactions ({ "+": 2 }) | | GMCP Comm.Channel.Players (in) | schema/players.json, CommChannelPlayers | The online counts on the chips | | Another extension: mu.channels.push(channel, sender, text) | — | A message |

The contracts are declared in the manifest (muclient.contributes.gmcp[0].messages), so the host checks a payload before it is used. Extra fields are allowed. The TypeScript shapes are in src/types.ts (shipped in the package). The extension itself sends no GMCP.

The host also tracks mentions (a message that names your character, from Char.Name / Char.Status or the Character name setting) and unread counts. This panel reads them with mu.channels.watch and applies its own channel settings on top.

What it shows

• Rail: one chip per channel. The active chip is a solid accent fill. A chip shows the unread count as a badge, @ and a gold name when an unread message mentions you, the online count in --ok, and a struck-through name when the channel is muted (a muted chip shows no unread count and no @). With a colour set, the chip name takes it. Click a chip to switch to it. Right-click it to open its settings, unless another extension added an entry to the chip's menu (kind channels.channel); the menu opens then. Each chip has a spoken label with its state (ooc, 4 unread, mentioned, 3 online, muted).
• Head: the channel title, its topic in italics, and the tools Settings, Search, Mute (reads Muted while on) and Pop out.
• Settings strip: the colour swatches (default, then the SDK's CHANNEL_COLORS: accent, bright accent, gold, alert, ok, text, dim text; theme tokens only, so a colour follows the theme) and Alerts: Every message, Mentions only (default) or None. Colour, alerts and mute are saved per world in the extension's config setting.
• Search (also Ctrl+F / ⌘F inside the panel) follows the terminal's rules. Plain text matches case-insensitively, and /regex/flags is a regular expression. The search runs over sender: text. Matching rows take the terminal's hit tint and the active hit is outlined. The count shows n/N, no match, or not a valid regex. Enter or ↑ goes to the previous hit, Shift+Enter or ↓ to the next, and Esc closes the search and clears the query.
• Messages: the time, the sender (in the channel colour, gold by default) and the text, one line each, with the reactions after the text. A message that mentions you has a gold left rule. Messages from the same sender within five minutes are grouped: the later ones drop the time and name and are indented. A new divider marks where the unread messages began when you opened the channel. The view keeps to the bottom as messages arrive. If you have scrolled up, a ↓ N new messages button counts what arrived and takes you back down.
• Reply: hover a message (or focus it) for the ↩ tool, or right-click it for Reply to X / Copy message (context kind channels.message). A Reply to X bar shows over the composer. What you send goes out as @X: text. Cancel or Esc drops the reply.
• Keyboard: in the message list, ↑ ↓ Home End move between messages, and each one reads as sender, time: text.
• Composer: ❯ message <channel>. Enter sends through the input pipeline with the world's Reply format setting (default {channel} {text}), via mu.channels.send(text, key, sid, { format }).
• Pop out opens the channel as its own panel (channel, instance = the channel key, titled Channel · <caption>). The pop-out shows only that channel, keeps its own composer and survives a layout reload. While it is shown it marks its channel read. If the game no longer has the channel, it says channel X is not open here.

Reading a channel clears its unread count and mention: the main panel selects the channel, and a pop-out marks its own channel read. Text scales with the dock's per-panel font size (--shell-font-size). The message list is the focus region channels. Alt+C (Go to channels, command focus.channels) focuses it: the extension registers the command and calls mu.panels.focus('channels'), then 'channel' for a pop-out. It does not open a closed panel. Rebind it in Settings → Keys.

Behaviour

• Panel channels: singleton, right bottom, Views order 20, title Channels. Always offered. Its tab shows the session's unread count (unmuted channels).
• Alerts: a stored message raises a mention (mu.notify.mention: badge, toast, sound and desktop notification per Settings → Alerts) when Channel alerts is on, the channel is not muted, it was not read on another device, and the channel's alert setting is Every message, or Mentions only and the message names your character. When the game sends a seq, the mention is keyed on it, so it alerts once across your clients. The host raises no channel alert of its own while the extension is on (mu.channels.onMessage(fn, { ownsSettings: true })).
• Unmuting a channel marks it read, so what came in while it was muted does not show as unread.
• Panel channel: not a singleton, right bottom, not in Views, order 21, opened with params.channel (and params.instance).
• When a session's channels are first known, the panel is offered and added once if it is not open (mu.panels.touch, R-AUTO-PANELS). The host does this once per world on this device, so a panel you closed stays closed.
• It sends nothing to the game except what you type in the composer. It adds no Core.Supports of its own: the backend's base set already has Comm.Channel 1.

Settings

Settings → Extensions → Channels, declared in the manifest (muclient.contributes.settings) so the host has them before the extension activates:

| Key (ext.channels.…) | Kind, scope | Default | Replaces the core pref | |---|---|---|---| | config | json, per world | {} | channels.config | | replyFormat | text, global or per world | {channel} {text} | channels.replyFormat | | alerts | toggle, global or per world | on | alerts.channels |

config maps a channel key to { muted?, alert?: 'all' | 'mentions' | 'none', color? } (a colour from CHANNEL_COLORS). Set it from the strip in the panel. Channel alerts also shows as a Channels section on Settings → Alerts.

Each setting has migrateFrom: on the first activation for an account, the host copies the player's stored values of the old core pref (global and per world) into it, so settings made before 1.2.0 carry over. A world pack sets defaults with contributes.settings: { "values": { "ext.channels.replyFormat": "…" } }. A pack's old channelsReplyFormat still applies until the pack sets the new key. Character name stays a core setting.

SDK

Needs SDK 1.14 (muclient.api ^1.14). Capability: send-commands (the composer). It uses mu.channels.watch, select, markRead, send (with { format }) and onMessage (ownsSettings), mu.settings.define / get / set / watch (with migrateFrom and a section on the Alerts page), mu.notify.mention, mu.menus.kind (channels.message, channels.channel), context and target, mu.commands.register and mu.panels.focus (focus.channels, Alt+C), plus CHANNEL_COLORS, mu.sessions.each / list, mu.panels.register, vue, open, touch and badge, mu.ui.css and mu.ui.style. It no longer calls the deprecated mu.channels.configure or reads ChannelView.muted, alert and color.

Another extension can add entries to the message and chip menus with mu.menus.context({ target: 'channels.message' | 'channels.channel', … }). The targets carry data: { key, message } and data: { key }. The types are in src/settings.ts (ContextKinds augmentation).

It exposes no runtime API to other extensions (ctx.api('channels') is empty). The package's module exports, for tests and embedding:

| Export | What | |---|---| | default | The extension (activate) | | setup(mu) | Registers everything, returns a dispose (1.0.0 returned nothing) | | SETTINGS, SETTING, DEFAULT_REPLY_FORMAT | The settings schema and keys (1.2.0) | | KINDS, KIND_MESSAGE, KIND_CHANNEL | The context kinds (1.2.0) | | FOCUS_COMMAND | focus.channels (1.2.0) | | COPY | Every visible string | | CHANNELS_CSS | The stylesheet | | types CommChannelList, CommChannelText, CommChannelPlayers | The GMCP payload shapes |

src/logic.ts (pure helpers) keeps all of 1.0.0's exports and adds groupedIds, GROUP_MS, firstUnreadId, newerThan, atBottom, BOTTOM_SLACK, replyText, badgeOf and moveIndex (1.1.0), and normConfig, patchConfig, withConfig, alertFor, mentionOf and ALERTS (1.2.0). Since 1.2.0 the rail and selection helpers take the panel's view (withConfig(host view, config)).

Develop

Made with npm create @runmu.sh/extension (the quickstart).

npm install
npm run build        # src/index.ts → dist/index.js, then the manifest check
npm run typecheck
npm test             # tests/*.test.mjs: the pure helpers, the panel through a fake mu, and the build in @runmu.sh/dev/test
npm run dev          # dev server with hot reload (☰ → Extensions → Advanced → Developer)

| Path | What | |---|---| | src/index.ts | setup(mu): the settings, the stylesheet, both panels, the per-session touch and badge, the alerts, the menu kinds and entries, the focus command | | src/settings.ts | The settings schema (also in the manifest) and the context kinds | | src/types.ts | The GMCP payload shapes (also schema/*.json) | | src/panel.ts | The panel, a Vue component in render functions (vue is the host's, external) | | src/logic.ts | The pure parts: matcher and search, count and stepping, keys, colour and tint, channel settings and alerts, rail, selection and unread | | src/style.ts | The CSS, every rule under .ext-panel[data-ext="channels"] .mu-channels, tokens only | | src/copy.ts | Every visible string |

Licence

MIT