// ── Admin · Rust · Servers — chat titles and the voice (phase 17) ─────────
//
// Two things the servers page gained with BetterChat and PopupNotifications
// becoming optional (PLAN.md §33):
//
// • **A server's chat titles** (D135, D136): rules that rank the current wipe,
// in the operator's order, and how many a player shows. Saved with their own
// PUT, because they are not part of the server row — an operator retitling
// "Top Killer" must not have to re-type a sidecar address.
// • **The voice** (D140): the one styled permission group news and event lines
// are said in. A fleet setting, so it sits once at the foot of the page.
//
// Neither needs BetterChat to save. Titles are held by the plugin until BetterChat
// arrives, and the voice is said by our own plugin whether BetterChat is there or
// not; the "What this server has" line says which is which.
import { useState } from 'react'
import { ErrorState, Loading, useAsync } from '../../core.js'
import api from '../../api.js'
import { contrastInk } from '../../lib/format.js'
const MODES = [
{ id: 'first', label: 'The first title they earn', hint: 'The rule highest in the list wins.' },
{ id: 'all', label: 'Every title they earn' },
{ id: 'upto', label: 'Up to a number of titles', hint: 'In list order.' },
]
/**
* What a rule can rank (PLAN_REDESIGNS §5): the server's categories, each with
* the title it shows now (D175), then playtime, which has no title of its own.
*/
export function statOptions(categories) {
return [
...(categories || []).map((c) => ({ id: c.stat, label: c.label, title: c.current })),
{ id: 'playtime', label: 'Playtime', title: null },
// RunicNPC (runicnpc stage 4, D250): one NPC profile's kills. The rule names the profile.
{ id: 'profilekills', label: 'Kills of an NPC profile', title: null },
]
}
const statOf = (categories, id) => statOptions(categories).find((s) => s.id === id) || { id, label: id, title: null }
/** A rule's title as players see it: its own text, else its category's. */
export const ruleTitle = (rule, categories) => rule.text || statOf(categories, rule.stat).title || ''
/** One line summarising a server's titles, for its row on the list. */
export function titlesSummary(titles, push, categories) {
const rules = (titles && titles.rules) || []
if (!rules.length) return 'No chat titles.'
const list = rules.map((r) => `${ruleTitle(r, categories)} (top ${r.topN} ${statOf(categories, r.stat).label.toLowerCase()})`).join(', ')
const shown = push ? ` Last pushed: ${push.count} player${push.count === 1 ? '' : 's'} hold one${push.betterChat ? '' : ' — BetterChat is not loaded, so they are not showing in game yet'}.` : ''
return `Chat titles: ${list}.${shown}`
}
/** A title as the leaderboard will show it. */
function Chip({ text, color }) {
return (
{text || '…'}
)
}
export function TitlesForm({ server, categories, onSaved, onCancel }) {
const start = server.titles || { mode: 'first', max: 2, rules: [] }
const stats = statOptions(categories)
const { data: npc } = useAsync(() => api.servers.npcProfiles(server.id).catch(() => ({ profiles: [] })), [server.id])
const profiles = (npc && npc.profiles) || []
const [mode, setMode] = useState(start.mode)
const [max, setMax] = useState(start.max)
const [rules, setRules] = useState(start.rules.map((r) => ({ ...r })))
const [busy, setBusy] = useState(false)
const [error, setError] = useState('')
const setRule = (i, key) => (e) => {
const value = e.target.value
setRules((list) => list.map((r, n) => (n === i ? { ...r, [key]: key === 'topN' || key === 'profile' ? Number(value) : value } : r)))
}
const move = (i, by) => setRules((list) => {
const next = [...list]
const [r] = next.splice(i, 1)
next.splice(i + by, 0, r)
return next
})
const save = async (e) => {
e.preventDefault()
setBusy(true)
setError('')
try {
await api.admin.saveTitles(server.id, { mode, max: Number(max), rules })
onSaved()
} catch (err) {
setError(err.message || 'That did not save.')
} finally {
setBusy(false)
}
}
return (
)
}
/**
* The category titles (D175): one title per category for the whole site, which
* every rule of that category without its own text shows. Each row saves on its
* own, and Reset brings the module's default back.
*/
export function CategoryTitles({ categories, onSaved }) {
const [drafts, setDrafts] = useState({})
const [busy, setBusy] = useState('')
const [errors, setErrors] = useState({})
if (!categories || !categories.length) return null
const save = async (stat, text) => {
setBusy(stat)
setErrors((e) => ({ ...e, [stat]: '' }))
try {
await api.admin.saveTitleCategory(stat, text)
setDrafts((d) => {
const next = { ...d }
delete next[stat]
return next
})
onSaved()
} catch (err) {
setErrors((e) => ({ ...e, [stat]: err.message || 'That did not save.' }))
} finally {
setBusy('')
}
}
return (
Category titles
The title each category gives, on every server. A rule that has its own title keeps it; every other rule of the
category shows this one from the next push. Reset brings back the default.
)
}
/** A grid row's cells, without a wrapper element the grid would lay out as one cell. */
function Row({ children }) {
return <>{children}>
}
/** What a server says it has loaded, as one sentence (§33.2 `integrations`). */
export function integrationsLine(r) {
if (!r || !r.integrations) {
return r && r.ok === false
? `The game could not be asked (${r.status}).`
: 'This server’s plugin is older than protocol 12, so it cannot say which optional mods it has.'
}
const one = (name, x, without) => (x && x.loaded ? `${name} ${x.version || ''} is loaded`.trim() : `${name} is not loaded — ${without}`)
const line = `${one('BetterChat', r.integrations.betterChat, 'titles and group styles wait for it')}. ${one('PopupNotifications', r.integrations.popupNotifications, 'a popup is refused, and chat still works')}.`
const withEconomics = r.integrations.economics ? `${line} ${economicsLine(r.integrations.economics)}` : line
const withBackpacks = r.integrations.backpacks ? `${withEconomics} ${backpacksLine(r.integrations.backpacks)}` : withEconomics
const withTruePve = r.integrations.truePve ? `${withBackpacks} ${truePveLine(r.integrations.truePve)}` : withBackpacks
const withDynamicPvp = r.integrations.dynamicPvp ? `${withTruePve} ${dynamicPvpLine(r.integrations.dynamicPvp)}` : withTruePve
const withDt = r.integrations.dangerousTreasures ? `${withDynamicPvp} ${dangerousTreasuresLine(r.integrations.dangerousTreasures, r.console)}` : withDynamicPvp
const withGc = r.integrations.guardedCrate ? `${withDt} ${guardedCrateLine(r.integrations.guardedCrate, r.console)}` : withDt
return r.integrations.zLevels ? `${withGc} ${zLevelsLine(r.integrations.zLevels)}` : withGc
}
/**
* ZLevels Remastered (PLAN_REDESIGNS §14.3.6), from protocol 14. Only whether it is
* loaded: its levels never reach the site (D374), and its XP boosts are permissions
* an event lends like any other.
*/
export function zLevelsLine(z) {
if (!z.loaded) return 'ZLevels is not loaded — there are no XP boosts for an event to lend.'
return `${`ZLevels ${z.version || ''}`.trim()} is loaded — an event may lend its XP boosts (zlevelsremastered.vip1 to vip3) as permissions.`
}
/**
* Guarded Crate (PLAN_REDESIGNS §14.3.5), from protocol 14, with NpcSpawn beside it
* (D364): its crates on the feed and the map, and whether a step can place one,
* which needs NpcSpawn for the guards and the framework to run its console command.
*/
export function guardedCrateLine(gc, probe) {
const npc = gc.npcSpawn && gc.npcSpawn.loaded ? `NpcSpawn ${gc.npcSpawn.version || ''}`.trim() : null
if (!gc.loaded) {
return `Guarded Crate is not loaded — a step cannot place a guarded crate.${npc ? ` ${npc} is loaded.` : ''}`
}
const name = `Guarded Crate ${gc.version || ''}`.trim()
const events = Array.isArray(gc.events) && gc.events.length ? ` Its events: ${gc.events.join(', ')}.` : ''
if (!npc) {
return `${name} is loaded but NpcSpawn is missing: its events cannot start, and a step cannot place one.`
}
if (probe && probe.plugins === false) {
return `${name} is loaded with ${npc} — its crates show on the feed and the map, but this framework cannot run its console command, so a step cannot place one (Rust-Plugins#34).${events}`
}
return `${name} is loaded with ${npc} — its crates show on the feed and the map, and a step may place one.${events}`
}
/**
* Dangerous Treasures (PLAN_REDESIGNS §14.3.4), from protocol 14: its events on the
* feed and the map, and whether a step can start one, which needs the framework
* to run its console command (hello's `console.plugins`, D363).
*/
export function dangerousTreasuresLine(dt, probe) {
if (!dt.loaded) return 'Dangerous Treasures is not loaded — a step cannot start a treasure event.'
const name = `Dangerous Treasures ${dt.version || ''}`.trim()
if (probe && probe.plugins === false) {
return `${name} is loaded — its events show on the feed and the map, but this framework cannot run its console command, so a step cannot start one (Rust-Plugins#34).`
}
return `${name} is loaded — its events show on the feed and the map, and a step may start one.`
}
/** Dynamic PVP (PLAN_REDESIGNS §14.3.3), from protocol 14: its zones on the feed and the map. */
export function dynamicPvpLine(d) {
if (!d.loaded) return 'Dynamic PVP is not loaded — no PvP zones of its own on the feed or the map.'
return `${`Dynamic PVP ${d.version || ''}`.trim()} is loaded — its PvP zones show on the feed and the map.`
}
/** TruePVE (PLAN_REDESIGNS §14.3.2), from protocol 14: what a zone step may do with PvP. */
export function truePveLine(tp) {
if (!tp.loaded) return 'TruePVE is not loaded — a zone step cannot change PvP rules.'
return `${`TruePVE ${tp.version || ''}`.trim()} is loaded — a zone step may turn off PvP protection or name a ruleset.`
}
/**
* Backpacks (PLAN_REDESIGNS §11.3.2), from protocol 14. Its sizes are what a
* Bigger backpack step may lease (D337), so they are said.
*/
export function backpacksLine(b) {
if (!b.loaded) return 'Backpacks is not loaded — backpack views and bigger-backpack rewards wait for it.'
const name = `Backpacks ${b.version || ''}`.trim()
const sizes = Array.isArray(b.sizes) ? b.sizes : []
return sizes.length > 1
? `${name} is loaded — sizes ${sizes.join(', ')}; an event may lend any above ${sizes[0]}.`
: `${name} is loaded, but offers no size above its smallest, so an event has nothing bigger to lend.`
}
/**
* Economics (PLAN_REDESIGNS §11.2.2), from protocol 14. Its starting balance
* decides who the richest column ranks (D336), so a config the plugin could not
* read is said: the site then assumes Economics' default of 1000.
*/
export function economicsLine(e) {
if (!e.loaded) return 'Economics is not loaded — coin rewards, balances and the richest column wait for it.'
const name = `Economics ${e.version || ''}`.trim()
if (e.startingBalance === undefined || e.startingBalance === null) {
return `${name} is loaded, but its config could not be read — the site assumes a starting balance of 1,000.`
}
const wipes = e.wipesWithMap === true ? 'balances wipe with the map' : e.wipesWithMap === false ? 'balances carry over a wipe' : null
return `${name} is loaded — starting balance ${Number(e.startingBalance).toLocaleString()}${wipes ? `, ${wipes}` : ''}.`
}
export function VoiceCard() {
const [reloads, setReloads] = useState(0)
const { data, error: loadError } = useAsync(() => api.admin.voice(), [reloads])
const [busy, setBusy] = useState(false)
const [error, setError] = useState('')
if (loadError) return
if (!data) return
const choose = async (group) => {
setBusy(true)
setError('')
try {
await api.admin.saveVoice(group)
setReloads((n) => n + 1)
} catch (err) {
setError(err.message || 'That did not save.')
} finally {
setBusy(false)
}
}
const current = data.options.find((o) => o.group === data.voice)
return (
Announcement voice
News posts and event announcements said in game chat can wear the title and colours of one permission group that
has a chat style. The line has no sender, so no player’s name appears. It works whether or not BetterChat is
installed. Popups are plain text.
{data.voice && !current && (
The chosen group no longer has a chat style, so lines are said in plain chat until it has one again or another
voice is chosen.
)}
{current &&
The line: {current.format}
}
{!data.options.length && (
No group has a chat style yet. Give one a style under Permissions.