Mumble is an open-source, low-latency, high quality voice chat software.
Go to file
Thorvald Natvig bc1d415786 *** empty log message ***
git-svn-id: https://mumble.svn.sourceforge.net/svnroot/mumble/trunk@312 05730e5d-ab1b-0410-a4ac-84af385074fa
2005-12-16 04:33:32 +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 rename from libspeex.dll to just speex.dll 2005-12-13 00:07:43 +00:00
overlay Immediate update of overlay on parameter change 2005-10-05 17:50:15 +00:00
plugins sub,a,b,c groups 2005-10-04 19:38:01 +00:00
scripts Fixups for release script 2005-09-16 14:32:30 +00:00
About.cpp Bump version 2005-10-12 18:33:06 +00:00
About.h About Speex dialog, still waiting for the icon. 2005-09-18 03:24:47 +00:00
ACL.cpp Ping support 2005-11-09 22:15:24 +00:00
ACL.h Ping support 2005-11-09 22:15:24 +00:00
ACLEditor.cpp sub,a,b,c groups 2005-10-04 19:38:01 +00:00
ACLEditor.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
ASIOInput.cpp Enable ASIO with 32bit input. Needs verification. 2005-12-09 22:46:39 +00:00
ASIOInput.h Enable ASIO with 32bit input. Needs verification. 2005-12-09 22:46:39 +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 Bugfixing bandwidth limits 2005-12-16 04:28:20 +00:00
AudioConfigDialog.h Variable number of frames / packet 2005-10-01 22:58:55 +00:00
AudioInput.cpp Bugfixing bandwidth limits 2005-12-16 04:28:20 +00:00
AudioInput.h Maximum bandwidth setting serverside. 2005-12-16 03:50:52 +00:00
AudioOutput.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
AudioOutput.h 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
AudioStats.cpp Visualize all parts of the echo weights. 2005-12-13 05:01:56 +00:00
AudioStats.h Visualize all parts of the echo weights. 2005-12-13 05:01:56 +00:00
BanEditor.cpp Banlist editor. 2005-10-13 15:55:51 +00:00
BanEditor.h Banlist editor. 2005-10-13 15:55:51 +00:00
CHANGES *** empty log message *** 2005-12-15 18:58:29 +00:00
Channel.cpp *** empty log message *** 2005-09-30 14:49:06 +00:00
Channel.h Experimentation with non-actionmapped directinput; will be a lot of GUI work though. 2005-09-30 13:53:55 +00:00
Commands.txt More command interface. 2005-09-30 20:23:51 +00:00
ConfigDialog.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
ConfigDialog.h Move config into registrars. 2005-09-28 12:12:01 +00:00
ConnectDialog.cpp Removed TCP voice support; with Nagle it will always be laggy. 2005-10-13 14:21:59 +00:00
ConnectDialog.h Version 0.3.2. 2005-09-19 20:24:08 +00:00
Connection.cpp Use class references in headers instead of .h files, reduces dependency path to more sane levels. 2005-09-29 02:06:13 +00:00
Connection.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
Database.cpp Version 0.3.2. 2005-09-19 20:24:08 +00:00
Database.h Fix a few missing Q_OBJECT 2005-09-16 01:21:58 +00:00
DXAudioInput.cpp Move config into registrars. 2005-09-28 12:12:01 +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 Use class references in headers instead of .h files, reduces dependency path to more sane levels. 2005-09-29 02:06:13 +00:00
DXAudioOutput.h Single-threaded directsound output 2005-09-16 23:03:53 +00:00
DXConfigDialog.cpp Move config into registrars. 2005-09-28 12:12:01 +00:00
DXConfigDialog.h Positional Audio 2005-09-14 20:56:32 +00:00
firmumble.inc ASIO Audio Input 2005-09-18 01:11:35 +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 Maximum bandwidth setting serverside. 2005-12-16 03:50:52 +00:00
GlobalShortcut_win.cpp Various bugfixes. 2005-10-01 14:06:01 +00:00
GlobalShortcut_win.h Experimentation with non-actionmapped directinput; will be a lot of GUI work though. 2005-09-30 13:53:55 +00:00
GlobalShortcut.h Various bugfixes. 2005-10-01 14:06:01 +00:00
Group.cpp Debugging of ~sub 2005-10-04 20:20:51 +00:00
Group.h sub,a,b,c groups 2005-10-04 19:38:01 +00:00
iasiothiscallresolver.h ASIO Audio Input 2005-09-18 01:11:35 +00:00
INSTALL Update INSTALL to reflect we now require Boost 2005-12-04 22:30:00 +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 Updates to enable compilation on Linux, even if it's missing features. 2005-12-12 08:57:16 +00:00
MainWindow.cpp Maximum bandwidth setting serverside. 2005-12-16 03:50:52 +00:00
MainWindow.h Banlist editor. 2005-10-13 15:55:51 +00:00
Message.cpp Maximum bandwidth setting serverside. 2005-12-16 03:50:52 +00:00
Message.h Maximum bandwidth setting serverside. 2005-12-16 03:50:52 +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 2005-10-12 18:33:06 +00:00
mumble.pro *** empty log message *** 2005-12-13 00:01:43 +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.cpp Bold speec probability when we would transmit. 2005-10-01 23:46:57 +00:00
murmur.ini Serverside commands through SQL. 2005-09-30 16:52:27 +00:00
murmur.pl Allow _ in email addresses (darn@the-space.net) 2005-12-15 18:49:38 +00:00
murmur.pro *** empty log message *** 2005-10-13 14:35:56 +00:00
Overlay_win.cpp Support graceful failure of loading the overlay (For Win2k support) 2005-12-08 20:38:16 +00:00
Overlay.h make "Toggle overlay" a tristate; show only talking, show all or show none. 2005-10-14 19:12:16 +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 Connection table in sqlite 2005-09-29 20:02:11 +00:00
PlayerModel.cpp Banlist editor. 2005-10-13 15:55:51 +00:00
PlayerModel.h Rename player support. 2005-10-12 18:32:18 +00:00
Plugins.cpp Move config into registrars. 2005-09-28 12:12:01 +00:00
Plugins.h Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
README .ini files for the server, updating documentation to reflect this. 2005-09-25 22:49:17 +00:00
Server.cpp *** empty log message *** 2005-12-16 04:33:32 +00:00
Server.h Maximum bandwidth setting serverside. 2005-12-16 03:50:52 +00:00
ServerDB.cpp Banlist (serverside). 2005-10-12 19:30:55 +00:00
ServerDB.h Banlist (serverside). 2005-10-12 19:30:55 +00:00
ServerHandler.cpp Maximum bandwidth setting serverside. 2005-12-16 03:50:52 +00:00
ServerHandler.h Ping support 2005-11-09 22:15:24 +00:00
Settings.cpp Config for overlay. 2005-10-04 07:28:00 +00:00
Settings.h Config for overlay. 2005-10-04 07:28:00 +00:00
TextToSpeech_win.cpp Remove compile warnings, and there sure were a lot of them 2005-09-08 14:09:32 +00:00
TextToSpeech.h Start of unix compiles for mumble 2005-09-18 22:33:13 +00:00
TrayIcon_win.cpp Minimize to tray. 2005-09-19 01:08:55 +00:00
TrayIcon.h Minimize to tray. 2005-09-19 01:08:55 +00:00
VersionCheck.cpp Provide feedback if an error occured. 2005-09-19 13:51:02 +00:00
VersionCheck.h Check version against sourceforge 2005-09-07 21:30:29 +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 only works on Win32, 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.