Mumble is an open-source, low-latency, high quality voice chat software.
Go to file
Thorvald Natvig d7cdbc3580 Spelling fixes
git-svn-id: https://mumble.svn.sourceforge.net/svnroot/mumble/trunk@392 05730e5d-ab1b-0410-a4ac-84af385074fa
2006-10-02 19:23:41 +00:00
debian Added a more informative description. 2006-10-02 12:09:49 +00:00
dependencies Add fftpwrap for speex compile 2005-12-03 03:57:22 +00:00
icons New temporary icon for shortcuts as requested by lead developer. 2006-10-02 18:47:06 +00:00
installer Added local mute and updated icons. 2006-09-19 21:50:39 +00:00
overlay Updated overlay to compile with newer DX SDK 2006-08-25 10:23:17 +00:00
plugins WoW 1.10 2006-03-29 16:00:33 +00:00
scripts Add pch files to tarball and mention PCH in INSTALL 2006-09-28 13:03:58 +00:00
About.cpp Bump version 2006-10-02 08:30:09 +00:00
About.h 2006 updates 2006-09-22 09:58:38 +00:00
ACL.cpp 2006 updates 2006-09-22 09:58:38 +00:00
ACL.h 2006 updates 2006-09-22 09:58:38 +00:00
ACLEditor.cpp Spelling fixes 2006-10-02 19:23:41 +00:00
ACLEditor.h 2006 updates 2006-09-22 09:58:38 +00:00
ALSAAudio.cpp 2006 updates 2006-09-22 09:58:38 +00:00
ALSAAudio.h 2006 updates 2006-09-22 09:58:38 +00:00
ASIOInput.cpp Spelling fixes 2006-10-02 19:23:41 +00:00
ASIOInput.h 2006 updates 2006-09-22 09:58:38 +00:00
Audio.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Audio.h 2006 updates 2006-09-22 09:58:38 +00:00
AudioConfigDialog.cpp Spelling fixes 2006-10-02 19:23:41 +00:00
AudioConfigDialog.h 2006 updates 2006-09-22 09:58:38 +00:00
AudioInput.cpp Older speex libraries don't have speex_echo_ctl 2006-09-28 13:06:49 +00:00
AudioInput.h 2006 updates 2006-09-22 09:58:38 +00:00
AudioOutput.cpp 2006 updates 2006-09-22 09:58:38 +00:00
AudioOutput.h 2006 updates 2006-09-22 09:58:38 +00:00
AudioStats.cpp Spelling fixes 2006-10-02 19:23:41 +00:00
AudioStats.h 2006 updates 2006-09-22 09:58:38 +00:00
BanEditor.cpp 2006 updates 2006-09-22 09:58:38 +00:00
BanEditor.h 2006 updates 2006-09-22 09:58:38 +00:00
CHANGES Changelog update 2006-09-22 10:08:31 +00:00
Channel.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Channel.h 2006 updates 2006-09-22 09:58:38 +00:00
Commands.txt More command interface. 2005-09-30 20:23:51 +00:00
ConfigDialog.cpp 2006 updates 2006-09-22 09:58:38 +00:00
ConfigDialog.h 2006 updates 2006-09-22 09:58:38 +00:00
ConnectDialog.cpp 2006 updates 2006-09-22 09:58:38 +00:00
ConnectDialog.h 2006 updates 2006-09-22 09:58:38 +00:00
Connection.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Connection.h 2006 updates 2006-09-22 09:58:38 +00:00
Database.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Database.h 2006 updates 2006-09-22 09:58:38 +00:00
DXAudioInput.cpp 2006 updates 2006-09-22 09:58:38 +00:00
DXAudioInput.h 2006 updates 2006-09-22 09:58:38 +00:00
DXAudioOutput.cpp 2006 updates 2006-09-22 09:58:38 +00:00
DXAudioOutput.h 2006 updates 2006-09-22 09:58:38 +00:00
DXConfigDialog.cpp 2006 updates 2006-09-22 09:58:38 +00:00
DXConfigDialog.h 2006 updates 2006-09-22 09:58:38 +00:00
firmumble.inc ASIO Audio Input 2005-09-18 01:11:35 +00:00
FMODAudio.cpp 2006 updates 2006-09-22 09:58:38 +00:00
FMODAudio.h 2006 updates 2006-09-22 09:58:38 +00:00
Global.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Global.h 2006 updates 2006-09-22 09:58:38 +00:00
GlobalShortcut_unix.cpp Dumped DI actions in favor of raw.. Which enables more fancy combinations, but DIA was standardized.. If only the config dialog had been prettier. 2006-10-02 18:36:44 +00:00
GlobalShortcut_win.cpp Add icon to dialog, fix a few bugs 2006-10-02 19:06:17 +00:00
GlobalShortcut_win.h Dumped DI actions in favor of raw.. Which enables more fancy combinations, but DIA was standardized.. If only the config dialog had been prettier. 2006-10-02 18:36:44 +00:00
GlobalShortcut.h Dumped DI actions in favor of raw.. Which enables more fancy combinations, but DIA was standardized.. If only the config dialog had been prettier. 2006-10-02 18:36:44 +00:00
Group.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Group.h 2006 updates 2006-09-22 09:58:38 +00:00
iasiothiscallresolver.h ASIO Audio Input 2005-09-18 01:11:35 +00:00
INSTALL Add pch files to tarball and mention PCH in INSTALL 2006-09-28 13:03:58 +00:00
LICENSE 2006 updates 2006-09-22 09:58:38 +00:00
licenses.h 2006 updates 2006-09-22 09:58:38 +00:00
link.pl *** empty log message *** 2005-10-13 14:35:56 +00:00
Log.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Log.h 2006 updates 2006-09-22 09:58:38 +00:00
main.cpp 2006 updates 2006-09-22 09:58:38 +00:00
MainWindow.cpp Spelling fixes 2006-10-02 19:23:41 +00:00
MainWindow.h Dumped DI actions in favor of raw.. Which enables more fancy combinations, but DIA was standardized.. If only the config dialog had been prettier. 2006-10-02 18:36:44 +00:00
Message.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Message.h 2006 updates 2006-09-22 09:58:38 +00:00
mumble_es.ts Spelling fixes 2006-10-02 19:23:41 +00:00
mumble_pch.h Support no-exception compile to avoid mingw lib dependency. 2006-09-18 16:32:30 +00:00
mumble.ico Temporary icon for alpha and beta stage 2005-09-05 16:49:56 +00:00
mumble.png.0 Need all 3 icon sizes 2005-09-05 19:02:32 +00:00
mumble.png.1 Need all 3 icon sizes 2005-09-05 19:02:32 +00:00
mumble.png.2 Need all 3 icon sizes 2005-09-05 19:02:32 +00:00
mumble.pri Bump version 2006-10-02 08:30:09 +00:00
mumble.pro Prepare for Spanish translation. 2006-10-02 19:10:21 +00:00
mumble.qrc Add icon to dialog, fix a few bugs 2006-10-02 19:06:17 +00:00
mumble.rc Initial setup of project 2005-08-31 21:14:21 +00:00
murmur_pch.h Forgot to check in pch headers 2006-01-17 18:06:19 +00:00
murmur.cpp 2006 updates 2006-09-22 09:58:38 +00:00
murmur.ini Support max # users limitation on server. 2005-12-25 05:48:48 +00:00
murmur.pl Password resend 2006-09-22 19:48:43 +00:00
murmur.pro Minor updates 2006-03-29 15:58:59 +00:00
Overlay_win.cpp Spelling fixes 2006-10-02 19:23:41 +00:00
Overlay.h Overlay nothing/all/talking as config option 2006-10-02 08:52:30 +00:00
Player.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Player.h 2006 updates 2006-09-22 09:58:38 +00:00
PlayerModel.cpp 2006 updates 2006-09-22 09:58:38 +00:00
PlayerModel.h 2006 updates 2006-09-22 09:58:38 +00:00
Plugins.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Plugins.h 2006 updates 2006-09-22 09:58:38 +00:00
README The client now works on Linux, and FMOD is no longer used. 2006-06-05 19:11:03 +00:00
Server.cpp 2006 updates 2006-09-22 09:58:38 +00:00
Server.h 2006 updates 2006-09-22 09:58:38 +00:00
ServerDB.cpp 2006 updates 2006-09-22 09:58:38 +00:00
ServerDB.h 2006 updates 2006-09-22 09:58:38 +00:00
ServerHandler.cpp 2006 updates 2006-09-22 09:58:38 +00:00
ServerHandler.h 2006 updates 2006-09-22 09:58:38 +00:00
Settings.cpp Overlay nothing/all/talking as config option 2006-10-02 08:52:30 +00:00
Settings.h Overlay nothing/all/talking as config option 2006-10-02 08:52:30 +00:00
TextToSpeech_unix.cpp Changelog update 2006-09-22 10:08:31 +00:00
TextToSpeech_win.cpp 2006 updates 2006-09-22 09:58:38 +00:00
TextToSpeech.h 2006 updates 2006-09-22 09:58:38 +00:00
TrayIcon_unix.cpp 2006 updates 2006-09-22 09:58:38 +00:00
TrayIcon_win.cpp 2006 updates 2006-09-22 09:58:38 +00:00
TrayIcon.h 2006 updates 2006-09-22 09:58:38 +00:00
VersionCheck.cpp 2006 updates 2006-09-22 09:58:38 +00:00
VersionCheck.h 2006 updates 2006-09-22 09:58:38 +00:00


           M U M B L E

 A voicechat utility for gamers

  http://mumble.sourcforge.net/


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

There are two modules in Mumble; the client (mumble) and the server
(murmur). The client works on Win32 and Linux, 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
==============

After installation, you should have a new Mumble folder in your Start Menu,
from which you can start Mumble. You need a server to connect to, either
create your own or join a friend's.

Note that it's perfectly possible to make the internal state of the audio
preprocessor incosistant so that voice activity and noise filtration doesn't
work. Disconnection and reconnection your microphone will cause this, as
will rubbing it with paper -- anything that causes signals that are way out
of the normal range. If this happens, use Audio|Reset (or the bound
shortcut) to reset it.

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

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

murmur [-supw <password>] [-ini <inifile>]

-supw   Set 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 a inifile other than murmur.ini, use this to run several isntances
        of murmur from the same directory. Make sure each instance is using
        a separate database.

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.