Skip to content
McSnurtle edited this page Aug 14, 2025 · 4 revisions

Once the program is installed and setup (see Installation), simply run the scripts as follows, running batch scripts (.bat) on Windows and shell scripts (.sh) for Unix:

Examples 👀

For a group call:

Client Configuration File:

Category Option Value
Networking server_ip The IPv4 of your group call server.
Networking server_port The port of your group call server.
Audio chunk_size Match server value
Audio mystery_number Match server value
Audio sample_rate Match server value

CAUTION: Better compatibility is likely to change the above sample_rate requirement in the future.

Server Configuration File:

There must be one central server the group call is hosted on, with each client connecting to it.

Category Option Value
Networking server_ip "0.0.0.0"
Networking relay_audio true
Audio chunk_size Match client options
Audio mystery_number Match client
Audio sample_rate Match client

For a LAN pc-to-pc call:

  • Both machines have their server's server_ip set to 0.0.0.0.
  • Both machines have each other's local IPv4 addresses as their clients' target server_ip.
  • Both machines have each other's servers' ports as their clients' target server_port.
  • It is strongly recommended that both machines have their servers' relay_audio to false.
  • Both machines share a chunk_size, mystery_number, and sample_rate to avoid glitchiness. CAUTION: Better compatibility is likely to change this requirement in the future.

Sending Microphone 🎙️

To send your microphone data to a server:

  • Specify the server's address and port (as given by your server provider) in the server_ip and server_port fields of usr/conf/client.json.
  • Initiate a connection to the server by running the client script in scripts/.

Receiving Audio 🔈

To receive all incoming audio traffic on your host machine:

  • Specify your server's port in the server_port field of usr/conf/server.json.
  • Run the server script in scripts/.

Clone this wiki locally