Permissions

Admin commands複製段落連結

All of them require the socketsvc.admin permission, which ops have by default; the / can be omitted in the console. The four mute commands require socketsvc.admin.mute as well, so moderation can be handed out without the rest of the console. All core server settings can be applied through reload, and a connection address change triggers automatic voice reconnects.

Testing a player's connection複製段落連結

/ssvc-server test <player> answers the question status cannot: is this player's voice actually working? It sends a real WebSocket ping to their client and waits up to 3 seconds for the pong, then reports the round trip together with everything the server already knows about their session.

> /ssvc-server test Alex
Pinging Alex's voice connection...
SocketSVC connection test: Alex
  Result: connected and responding
  Round trip: 42 ms
  Remote address: /203.0.113.7:51234
  Audio protocol: v2 (sequenced, loss concealment)
  Extensions: spatial=true, status=true, soundboard=true
  Self deafened: false, speaking now: false
  Permissions: speak=true, listen=true, soundboard=true
  Server mute: none
  Audible to 3 player(s); can hear 3 player(s)
  Queued frames: 0

The player name must be an exact, case-sensitive match against someone online; tab completion offers online names. The command answers asynchronously — the pong arrives on a network thread — so it never blocks the server, and two admins testing the same player share one ping rather than making the client answer twice.

Reading the result複製段落連結

The first line is the verdict; the rest is the evidence behind it.

no voice connection is the common one, and the server genuinely cannot tell its causes apart from here — the client either never reached it or never tried. The usual three are: no SocketSVC client mod installed, a public-url that is unreachable from the player's network (see Configuration), or first-time setup never finished. The report prints them as a reminder.

The remaining lines are for narrowing down audio problems that are not connectivity problems:

• Audio protocol — v1 means an older client with no packet-loss concealment, which sounds choppier on a lossy link.
• Extensions — status=false means the client cannot report deafen; spatial=false means plugin speakers will not reach them.
• Audible to / can hear — how many connected players are in range of them right now, and vice versa, applying every rule the relay applies. Both being 0 while others are connected points at range, worlds, visible-players-only or spectator mode rather than at the connection.
• Server mute — none, or the mute in force with its remaining time, who issued it and the reason. This is usually the answer when a player says they can hear everyone and nobody can hear them.
• Queued frames — a persistently non-zero backlog means the socket is not draining as fast as audio arrives, i.e. the player's downstream link is saturated.

Permission nodes複製段落連結

socketsvc.speak/socketsvc.listen/socketsvc.soundboard can be revoked for individual players or groups through a permissions plugin (such as LuckPerms):

• socketsvc.speak revoked: that player's microphone audio is never relayed to anyone. This is the right tool for a standing policy; for silencing a person who is doing something now, use a mute instead — it carries a reason, an expiry and a notice the player can actually see.
• socketsvc.listen revoked: that player receives no voice from any other player — a server-side forced deafen, independent of the client's own deafen setting.
• socketsvc.soundboard revoked: soundboard frames triggered by that player are dropped by the server before routing, without disconnecting. This blocks the player or group regardless of what the client does.

Group permissions複製段落連結

The three group nodes only matter while voice groups are switched on in the config; with groups.enabled false the capability is never negotiated and none of them is ever consulted.

• socketsvc.groups revoked: no group menu, and any group request from that player is refused (it does not disconnect them) — except leaving, which stays allowed so someone already in a group when the node is taken away is not stuck in it.
• socketsvc.groups.create revoked: they can join groups other people made but cannot make one. groups.allow-player-created: false does the same thing to everyone at once.
• socketsvc.groups.admin granted: they bypass group passwords and may disband or retype any group. It is the only one of the three that fails closed for a player the permission cache has not seen yet.

Each client is told what that player may do as part of the group snapshot, so its menu hides what would be refused — but every request is checked again on arrival, so the menu is a courtesy and not the enforcement.

The bridge permission複製段落連結

socketsvc.bridge decides whose voice may leave SocketSVC for a plugin through the microphone tap — a voice-mod bridge, a Discord relay, recording or transcription.

It does nothing at all unless an operator has set microphone-tap.enabled: true. That switch is what keeps the feature off, which is why this node defaults to true rather than to op: a node defaulting to false would leave an operator who deliberately turned the switch on still hearing nothing, with nothing to say why.

• socketsvc.bridge revoked: that player's microphone is never handed to any tap. They talk and are heard by the room exactly as before — this removes them from the tap, not from voice chat.
• It is checked per frame, not once when a plugin subscribes, against a permission answer SocketSVC refreshes every second. Revoking it stops that player's audio within a second rather than at their next reconnect.
• It fails closed for a player the permission cache has not seen yet — the opposite of socketsvc.speak. Not having been checked yet is not consent.

A tap is fed from the same point the relay is, after the mute check and after socketsvc.speak, so a muted or silenced player is silent to a tap too. Soundboard and instrument audio are not tapped.

The Cross System Bridge reads this node for players on both mods. A Simple Voice Chat player holds no SocketSVC session for socketsvc.speak to be checked against, so socketsvc.bridge is what decides whether SocketSVC players hear them — and that direction does not need microphone-tap.enabled, so revoking the node is how you keep one Simple Voice Chat player out of it.

Soundboard permission複製段落連結

The soundboard is an audio channel independent of the microphone: muting the mic does not silence it, but a listener's own deafen state still blocks it, the same way it blocks mic audio (both go through the same canListen check). For the player-side soundboard guide, see Soundboard.

• The hot-reloadable soundboard-enabled setting is a server-wide switch, true by default. When disabled, the server still negotiates the dedicated protocol but drops every soundboard frame, so clients cannot fall back to the microphone channel to bypass it.
• Per-player socketsvc.soundboard checks apply only while the global switch is enabled.
• For protocol and routing details, see Voice protocol.

Caching and when changes apply複製段落連結

These permissions are read when a player joins and then cached, refreshed once a second per player, so a change takes effect within a second, with no reconnect or /ssvc-server reload needed. (They used to be re-read every tick, which cost a server nine permission lookups per player twenty times a second for answers that rarely change.) A player who has just joined and has not been read yet is allowed (fail-open).

Action bar notices複製段落連結

When a permission blocks a player, an English notice is shown in the action bar:

Notices are shown only when something is actually blocked: the listen notice only appears when the audio would otherwise have been audible, not for speakers out of range, deafened or not visible. Each reason has a 5-second cooldown per player to avoid spam.

Permission backends per loader複製段落連結

Addon permissions複製段落連結

Addon plugins built on the Spatial audio API can define their own permissions for their own commands. For example, the optional speaker example plugin uses socketsvc.speaker.admin, default op.