Connecting players
Players open the Inari web page and join with two values:
| Value | Description |
|---|---|
channel |
The voice channel. Falls back to DEFAULT_CHANNEL when absent. |
code |
A personal code, at least 6 characters and unique in the channel. |
The code is how Inari links a browser to an in-game character: the connector must report the player under the same code.
Direct link
Section titled “Direct link”Both values can be passed in the URL, which is handy for a command or a clickable message in game:
https://inari.example.com/?channel=default&code=a1b2c3d4Typical flow
Section titled “Typical flow”- The player runs a command in game (e.g.
/voice). - Your plugin generates a code for that player and sends them either the link above or just the code (the player then enters it manually on the Inari page).
- The player opens the link (or enters the code) and allows microphone access.
- Your connector includes
{ "code": "a1b2c3d4", ... }in its next state sync.
A player whose code is not reported by the connector connects but is not heard by anyone.
Muting and deafening
Section titled “Muting and deafening”Players can mute and deafen themselves from the web page. The connector can also:
- force mute a player (
is_force_muted), for example a dead or spectating player, - toggle a player’s muted or deafened state using
actions, for example from an in-game keybind.