Introduction

Inari is a web application that you host yourself. It lets players talk to each other through a proximity-based voice chat: the volume and direction of a voice depend on the position and head orientation of the speaker’s in-game character.

How it works

Inari is made of three parts:

Part	Role
Server (Rust)	Handles WebSocket signalling and routes audio with WebRTC (mediasoup).
Frontend (Angular)	The web page players open in their browser to send and receive voice.
Connector	A plugin, addon or mod running on your game server. It tells Inari where each player is.

1. A player opens the Inari web page and joins a channel with a personal code.
2. The connector, authenticated with the API key, sends the list of players with their positions every ~300 ms.
3. Inari matches each code to a connected browser and decides who can hear whom.

A player can hear another one when:

• they are within MAX_DISTANCE of each other,
• they are in the same group (players without a group share default),
• the speaker is not force-muted by the connector,
• the listener is not deafened.

Note

Inari does not do anything on its own: it requires a connector linking it to your game server. See the connector reference to write one, or the example-connector folder of the repository for a working Node.js example.

Branches

The main branch contains the stable/nightly production code. develop is the active development branch and may be unstable.

Next steps

• Install Inari
• Configure it
• Set up a reverse proxy
• Player guide
• Build a connector
• Let players connect