M U M B L E

 A voice chat utility for gamers

      http://mumble.info/

      #mumble on freenode

Mumble is a voice chat program for gamers written on top of Qt and Opus.

There are two modules in Mumble; the client (mumble) and the server
(murmur). The client works on Win32/64, Linux and Mac OS X, while the
server should work on anything Qt can be installed on.

Note that when we say Win32, we mean Windows XP or newer.

Running Mumble
==============

On Windows, after installation, you should have a new Mumble folder in your
Start Menu, from which you can start Mumble.

On Mac OS X, to install Mumble, drag the application from the downloaded
disk image into your /Applications folder.

Once Mumble is launched, you need a server to connect to. Either create your
own or join a friend's.

Running Murmur on Unix-like systems
===================================

Murmur should be run from the command line, so start a shell (command prompt)
and go to wherever you installed Mumble. Run murmur as

murmurd [-supw <password>] [-ini <inifile>] [-fg] [v]

-supw   Set a new password for the user SuperUser, which is hardcoded to
        bypass ACLs. Keep this password safe. Until you set a password,
        the SuperUser is disabled. If you use this option, murmur will
        set the password in the database and then exit.

-ini    Use an inifile other than murmur.ini, use this to run several instances
        of murmur from the same directory. Make sure each instance is using
        a separate database.

-fg     Run in the foreground, logging to standard output.

-v      More verbose logging.

Running Murmur on Mac OS X
==========================

Murmur is distributed separately from the Mumble client on Mac OS X.
It is called Static OS X Server and can be downloaded from the main webpage.

Once downloaded it can be run in the same way as on any other Unix-like system.
For more information please see the 'Running Murmur on Unix-like systems' above.

Running Murmur on Win32
=======================

Doubleclick the Murmur icon to start murmur. There will be a small icon on your
taskbar from which you can view the log.

To set the superuser password, run murmur with the parameters '-supw <password>'.

Bandwidth usage
===============

Mumble will use 10-40 kbit/s outgoing, and the same incoming for each user.
So if there are 10 other users on the server with you, your incoming
bandwidth requirement will be 100-400 kbit/s if they all talk at the same time.

OpenGL Overlay
==============

The OpenGL overlay works by intercepting the call to switch buffers, and just
before the buffer switch, we draw our nice GUI.

To load a game with the overlay enabled, start the game like this:
  LD_PRELOAD=/path/to/libmumble.so.1.1 gamename

If you have Mumble installed through the binary packages, this can be done by
simply typing:
  mumble-overlay gamename

Global Keyboard Events
======================

On Linux, Mumble supports reading the kernel input devices. To use this,
make sure mumble can open /dev/input/event* for reading. To test it out,
that should only require:
  sudo chmod a+r /dev/input/event*
However, be aware that this will most likely only last until the next reboot
(at which point devfs is recreated) and you also allow any program run by any
user to monitor the physical keyboard.

Without this, Mumble will continuously poll the mouse and keyboard state for
changes, which will use a tiny bit of processing power.

Mumble - A voice chat utility for gamers
=======================================

[![Build Status](https://dev.azure.com/Mumble-VoIP/Mumble/_apis/build/status/Mumble-CI?branchName=master)](https://dev.azure.com/Mumble-VoIP/Mumble/_build/latest?definitionId=1?branchName=master)

> *http://mumble.info/*
> *#mumble on freenode*

Mumble is a voicechat program for gamers written on top of Qt and Opus.

There are two modules in Mumble; the client (mumble) and the server
(murmur). The client works on Win32/64, Linux and Mac OS X, while the
server should work on anything Qt can be installed on.

Note that when we say Win32, we mean Windows XP or newer.

## Running Mumble

On Windows, after installation, you should have a new Mumble folder in your
Start Menu, from which you can start Mumble.

On Mac OS X, to install Mumble, drag the application from the downloaded
disk image into your `/Applications` folder.

Once Mumble is launched, you need a server to connect to. Either create your
own or join a friend's.

## Running Murmur on Unix-like systems

Murmur should be run from the command line, so start a shell (command prompt)
and go to wherever you installed Mumble. Run murmur as

```
murmurd [-supw <password>] [-ini <inifile>] [-fg] [v]

-supw   Set a new password for the user SuperUser, which is hardcoded to
        bypass ACLs. Keep this password safe. Until you set a password,
        the SuperUser is disabled. If you use this option, murmur will
        set the password in the database and then exit.

-ini    Use an inifile other than murmur.ini, use this to run several instances
        of murmur from the same directory. Make sure each instance is using
        a separate database.

-fg     Run in the foreground, logging to standard output.

-v      More verbose logging.
```

## Running Murmur on Mac OS X

Murmur is distributed separately from the Mumble client on Mac OS X.
It is called Static OS X Server and can be downloaded from the main webpage.

Once downloaded it can be run in the same way as on any other Unix-like system.
For more information please see the 'Running Murmur on Unix-like systems' above.

## Running Murmur on Win32

Doubleclick the Murmur icon to start murmur. There will be a small icon on your
taskbar from which you can view the log.

To set the superuser password, run murmur with the parameters `-supw <password>`.

## Bandwidth usage

Mumble will use 10-40 kbit/s outgoing, and the same incoming for each user.
So if there are 10 other users on the server with you, your incoming
bandwidth requirement will be 100-400 kbit/s if they all talk at the same time.

         M U M B L E

 A voicechat utility for gamers

      http://mumble.info/

      #mumble on freenode


What is Murmur?
===============

Murmur is the server component of Mumble, an open-source voice chat utility.

This package is a statically compiled version of Murmur for Linux. It is
independent of your distribution's package manager, and is intended to be
run as-is, or with minimal set up.


Running Murmur
==============

In this build of Murmur, the binary is called 'murmur.x86'. To get Murmur
up and running, simply execute the following command at your shell:

 $ ./murmur.x86 -fg -ini murmur.ini

This will spawn a foregrounded (Murmur will, by default, run in daemon mode,
which means it will launch itself as a background process on your system).


The First Run
=============

When Murmur runs for the first time, it performs a few special initialization
steps, such as setting up its database, as well as generating a certificate
for its initial server and a password for the SuperUser user.

This password is important for setting up the Murmur server, so make a note
of it. It is output by the Murmur server the first time it runs, and will
look something like this:

  <W> HH:MM:DD 1 => Password for 'SuperUser' set to '<YourSuperUserPassword>'


Initial User Setup
==================

Murmur has the concept of a 'SuperUser', which is the initial administrative user
used to configure your server.  Typically, this user will only be used for initial
setup, and in recovery situations. A regular user, with some administrative privileges
is usually set up as a first step.  To do this, follow the steps below:

 1. In your Mumble client, ensure that you have a certificate for your user.
    (A certificate is generated by Mumble by default, but you can create a new
     one if you wish -- or use an existing S/MIME email certificate if you wish.)

 2. Connect to your server with the user that you wish to grant administrative
    privileges to. (Your username will be stored on the server when you register
    yourself, so pick something you'd like to keep!)

 3. Once connected, right click your user name in the server view and choose
    'Register'.  This will register your user to the server (this makes the
    server remember you as a user -- but you still will not have administrative
    privileges).

 4. Once registered, you can disconnect from the server.  Now it is time to
    connect using the SuperUser account that the server created for you
    when you launched it the first time.

    Simply specify SuperUser as your username, and the password that Murmur
    gave you as the password.

 5. After connecting as the SuperUser, right click the 'Root'-channel and
    choose Edit.  In the Edit dialog, click the Groups tab.

    In the Groups dropdown, choose the admin group.

    Then, under Members three lists should appear, showing Members, Excluded
    Members and Inherited Members. We're only interested in Members. Expand
    the drop down below the member list and find the username of the user
    you registered in step 3.

    Click Add to add the user to the admin group.

 6. Your user is now an administrator.

For more advanced setup and usage of Murmur, please visit the Mumble Wiki,
at http://mumble.info/. Some pages of interest are available at:

   http://wiki.mumble.info/wiki/Running_Murmur
   http://wiki.mumble.info/wiki/ACL_and_Groups
   http://wiki.mumble.info/wiki/Murmurguide

Additional Murmur Options
=========================

The above instructions use a very bare-bones approach to running Murmur.
Several other command line options are available. These are listed below:

murmur.x86 [-supw <password>] [-ini <inifile>] [-fg] [v]

-supw   Set new password for the user SuperUser, which is hardcoded to
        bypass ACLs. Keep this password safe. If you use this option,
        Murmur will set the password in the database and then exit.

-ini    Use an ini file other than murmur.ini, use this to run several
        instances of Murmur from the same directory. Make sure each
        instance is using a separate database. (Specified in the ini file.)

-fg     Run in the foreground, logging to standard output.

-v      More verbose logging.

         M U M B L E

 A voicechat utility for gamers

      http://mumble.info/

      #mumble on freenode


What is Murmur?
===============

Murmur is the server component of Mumble, an open-source voice chat utility.

This package is a statically compiled version of Murmur for OS X.


Running Murmur
==============

In this build of Murmur, the binary is called 'murmurd'. To get Murmur
up and running, simply execute the following command at your shell:

 $ ./murmurd -fg -ini murmur.ini

This will spawn a foregrounded (Murmur will, by default, run in daemon mode,
which means it will launch itself as a background process on your system).


The First Run
=============

When Murmur runs for the first time, it performs a few special initialization
steps, such as setting up its database, as well as generating a certificate
for its initial server and a password for the SuperUser user.

This password is important for setting up the Murmur server, so make a note
of it. It is output by the Murmur server the first time it runs, and will
look something like this:

  <W> HH:MM:DD 1 => Password for 'SuperUser' set to '<YourSuperUserPassword>'


Initial User Setup
==================

Murmur has the concept of a 'SuperUser', which is the initial administrative user
used to configure your server.  Typically, this user will only be used for initial
setup, and in recovery situations. A regular user, with some administrative privileges
is usually set up as a first step.  To do this, follow the steps below:

 1. In your Mumble client, ensure that you have a certificate for your user.
    (A certificate is generated by Mumble by default, but you can create a new
     one if you wish -- or use an existing S/MIME email certificate if you wish.)

 2. Connect to your server with the user that you wish to grant administrative
    privileges to. (Your username will be stored on the server when you register
    yourself, so pick something you'd like to keep!)

 3. Once connected, right click your user name in the server view and choose
    'Register'.  This will register your user to the server (this makes the
    server remember you as a user -- but you still will not have administrative
    privileges).

 4. Once registered, you can disconnect from the server.  Now it is time to
    connect using the SuperUser account that the server created for you
    when you launched it the first time.

    Simply specify SuperUser as your username, and the password that Murmur
    gave you as the password.

 5. After connecting as the SuperUser, right click the 'Root'-channel and
    choose Edit.  In the Edit dialog, click the Groups tab.

    In the Groups dropdown, choose the admin group.

    Then, under Members three lists should appear, showing Members, Excluded
    Members and Inherited Members. We're only interested in Members. Expand
    the drop down below the member list and find the username of the user
    you registered in step 3.

    Click Add to add the user to the admin group.

 6. Your user is now an administrator.

For more advanced setup and usage of Murmur, please visit the Mumble Wiki,
at http://mumble.info/. Some pages of interest are available at:

   http://wiki.mumble.info/wiki/Running_Murmur
   http://wiki.mumble.info/wiki/ACL_and_Groups
   http://wiki.mumble.info/wiki/Murmurguide

Additional Murmur Options
=========================

The above instructions use a very bare-bones approach to running Murmur.
Several other command line options are available. These are listed below:

murmurd [-supw <password>] [-ini <inifile>] [-fg] [v]

-supw   Set new password for the user SuperUser, which is hardcoded to
        bypass ACLs. Keep this password safe. If you use this option,
        Murmur will set the password in the database and then exit.

-ini    Use an ini file other than murmur.ini, use this to run several
        instances of Murmur from the same directory. Make sure each
        instance is using a separate database. (Specified in the ini file.)

-fg     Run in the foreground, logging to standard output.

-v      More verbose logging.