zumble's Introduction

Zumble

A mumble server for FiveM.

Goal is to have an external server handling voice chat for FiveM servers instead of using the built-in voice chat.

This is a work in progress. Use it at your own risk.

Features

100% compatible with FiveM -> drop in replacement for client natives
Http api to mimic server side native calls (MumbleIsPlayerMuted / MumbleSetPlayerMuted / MumbleCreateChannel)
Performance (multithreaded server, separated from game network)
Can be installed on a separate machine
prometheus metrics

Installation

Clone this repository
Build the server using cargo: cargo build --release

Future versions will include pre-built binaries in release section of GitHub.

Usage

USAGE:
    zumble [OPTIONS] --http-password <HTTP_PASSWORD>

OPTIONS:
        --cert <CERT>
            Path to the certificate file for the TLS certificate [default: cert.pem]

    -h, --http-listen <HTTP_LISTEN>
            Listen address for HTTP connections for the admin api [default: 0.0.0.0:8080]

        --help
            Print help information

        --http-password <HTTP_PASSWORD>
            Password for the http server api basic authentification

        --http-user <HTTP_USER>
            User for the http server api basic authentification [default: admin]

        --https
            Use TLS for the http server (https), will use the same certificate as the mumble server

        --key <KEY>
            Path to the key file for the TLS certificate [default: key.pem]

    -l, --listen <LISTEN>
            Listen address for TCP and UDP connections for mumble voip clients (or other clients
            that support the mumble protocol) [default: 0.0.0.0:64738]

    -V, --version
            Print version information