Mumble is an open-source, low-latency, high quality voice chat software.
Go to file
Thorvald Natvig 30c2bedb30 Compiles on Linux again
git-svn-id: https://mumble.svn.sourceforge.net/svnroot/mumble/trunk@349 05730e5d-ab1b-0410-a4ac-84af385074fa
2006-05-31 14:36:12 +00:00
dependencies Add fftpwrap for speex compile 2005-12-03 03:57:22 +00:00
icons New icons for ASIO and OSD settings 2005-10-05 20:37:28 +00:00
installer QT 4.1.3 updates 2006-05-27 12:31:43 +00:00
overlay Immediate update of overlay on parameter change 2005-10-05 17:50:15 +00:00
plugins WoW 1.10 2006-03-29 16:00:33 +00:00
scripts Fixups for release script 2005-09-16 14:32:30 +00:00
About.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
About.h Precompiled header support 2005-12-31 01:46:58 +00:00
ACL.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
ACL.h Precompiled header support 2005-12-31 01:46:58 +00:00
ACLEditor.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
ACLEditor.h Precompiled header support 2005-12-31 01:46:58 +00:00
ASIOInput.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
ASIOInput.h Precompiled header support 2005-12-31 01:46:58 +00:00
Audio.cpp Centralized configuration dialog 2005-09-12 01:14:29 +00:00
Audio.h Use class references in headers instead of .h files, reduces dependency path to more sane levels. 2005-09-29 02:06:13 +00:00
AudioConfigDialog.cpp Qt 4.1.1 2006-03-17 13:01:58 +00:00
AudioConfigDialog.h Qt 4.1.1 2006-03-17 13:01:58 +00:00
AudioInput.cpp Initial Linux testing work 2006-01-18 15:49:14 +00:00
AudioInput.h Initial Linux testing work 2006-01-18 15:49:14 +00:00
AudioOutput.cpp Updates for new speex jitter buffer 2006-05-05 17:03:21 +00:00
AudioOutput.h Fixed FMOD 2006-01-17 17:43:17 +00:00
AudioStats.cpp Compiles on Linux again 2006-05-31 14:36:12 +00:00
AudioStats.h Precompiled header support 2005-12-31 01:46:58 +00:00
BanEditor.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
BanEditor.h Precompiled header support 2005-12-31 01:46:58 +00:00
CHANGES *** empty log message *** 2005-12-17 18:39:16 +00:00
Channel.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
Channel.h Precompiled header support 2005-12-31 01:46:58 +00:00
Commands.txt More command interface. 2005-09-30 20:23:51 +00:00
ConfigDialog.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
ConfigDialog.h Precompiled header support 2005-12-31 01:46:58 +00:00
ConnectDialog.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
ConnectDialog.h Precompiled header support 2005-12-31 01:46:58 +00:00
Connection.cpp Minor updates 2006-03-29 15:58:59 +00:00
Connection.h Qt 4.1.1 2006-03-17 13:01:58 +00:00
Database.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
Database.h Precompiled header support 2005-12-31 01:46:58 +00:00
DXAudioInput.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
DXAudioInput.h Failing to open DirectSound shouldn't be fatal, just a messagebox error 2005-09-16 13:50:45 +00:00
DXAudioOutput.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
DXAudioOutput.h Create DSound buffer in same thread it's used, and let buffers linger for 5 secs before destroying them; some soundcards don't handle buffer creation very well. 2005-12-23 05:01:18 +00:00
DXConfigDialog.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
DXConfigDialog.h Precompiled header support 2005-12-31 01:46:58 +00:00
firmumble.inc ASIO Audio Input 2005-09-18 01:11:35 +00:00
FMODAudio.cpp Initial Linux testing work 2006-01-18 15:49:14 +00:00
FMODAudio.h Initial Linux testing work 2006-01-18 15:49:14 +00:00
Global.cpp Use boost::shared_ptr<> for objects shared between threads that we need to delete(). (AudioInput and Output mostly). 2005-12-04 22:21:29 +00:00
Global.h Precompiled header support 2005-12-31 01:46:58 +00:00
GlobalShortcut_unix.cpp Linux compiles clean 2006-01-17 19:09:03 +00:00
GlobalShortcut_win.cpp Various bugfixes. 2005-10-01 14:06:01 +00:00
GlobalShortcut_win.h Precompiled header support 2005-12-31 01:46:58 +00:00
GlobalShortcut.h Various bugfixes. 2005-10-01 14:06:01 +00:00
Group.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
Group.h Precompiled header support 2005-12-31 01:46:58 +00:00
iasiothiscallresolver.h ASIO Audio Input 2005-09-18 01:11:35 +00:00
INSTALL Textfile changes for the Linux release. 2006-01-18 15:55:17 +00:00
LICENSE licenses for about dialog 2005-09-02 16:53:27 +00:00
licenses.h Dynamic release, only need licenses in installer/as files 2005-09-04 02:02:37 +00:00
link.pl *** empty log message *** 2005-10-13 14:35:56 +00:00
Log.cpp Move config into registrars. 2005-09-28 12:12:01 +00:00
Log.h Use class references in headers instead of .h files, reduces dependency path to more sane levels. 2005-09-29 02:06:13 +00:00
main.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
MainWindow.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
MainWindow.h Precompiled header support 2005-12-31 01:46:58 +00:00
Message.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
Message.h Precompiled header support 2005-12-31 01:46:58 +00:00
mumble_pch.h Linux compiles clean 2006-01-17 19:09:03 +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 Linux compiles clean 2006-01-17 19:09:03 +00:00
mumble.pro Compiles on Linux again 2006-05-31 14:36:12 +00:00
mumble.qrc Audio bugfixing. 2005-10-05 20:55:04 +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 Precompiled header support 2005-12-31 01:46:58 +00:00
murmur.ini Support max # users limitation on server. 2005-12-25 05:48:48 +00:00
murmur.pl Allow _ in email addresses (darn@the-space.net) 2005-12-15 18:49:38 +00:00
murmur.pro Minor updates 2006-03-29 15:58:59 +00:00
Overlay_win.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
Overlay.h Precompiled header support 2005-12-31 01:46:58 +00:00
Player.cpp Kick off ghost connections, refuse connections with same name for anonymous users. 2005-09-29 20:19:25 +00:00
Player.h Precompiled header support 2005-12-31 01:46:58 +00:00
PlayerModel.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
PlayerModel.h Initial Linux testing work 2006-01-18 15:49:14 +00:00
Plugins.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
Plugins.h Precompiled header support 2005-12-31 01:46:58 +00:00
README Textfile changes for the Linux release. 2006-01-18 15:55:17 +00:00
Server.cpp Qt 4.1.1 2006-03-17 13:01:58 +00:00
Server.h Precompiled header support 2005-12-31 01:46:58 +00:00
ServerDB.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
ServerDB.h Precompiled header support 2005-12-31 01:46:58 +00:00
ServerHandler.cpp Qt 4.1.1 2006-03-17 13:01:58 +00:00
ServerHandler.h Precompiled header support 2005-12-31 01:46:58 +00:00
Settings.cpp Qt 4.1.1 2006-03-17 13:01:58 +00:00
Settings.h Qt 4.1.1 2006-03-17 13:01:58 +00:00
TextToSpeech_unix.cpp Linux compiles clean 2006-01-17 19:09:03 +00:00
TextToSpeech_win.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
TextToSpeech.h Precompiled header support 2005-12-31 01:46:58 +00:00
TrayIcon_unix.cpp Linux compiles clean 2006-01-17 19:09:03 +00:00
TrayIcon_win.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
TrayIcon.h Precompiled header support 2005-12-31 01:46:58 +00:00
VersionCheck.cpp Precompiled header support 2005-12-31 01:46:58 +00:00
VersionCheck.h Precompiled header support 2005-12-31 01:46:58 +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.

This program may use
FMOD Sound System, copyright © Firelight Technologies Pty, Ltd., 1994-2005.