Mumble is an open-source, low-latency, high quality voice chat software.
Go to file
Martin Skilnand 8fced497a8 Pixmap for Game plugin screen
git-svn-id: https://mumble.svn.sourceforge.net/svnroot/mumble/trunk@140 05730e5d-ab1b-0410-a4ac-84af385074fa
2005-09-15 17:07:19 +00:00
dependencies Update libspeex makefile to match dynamic libs 2005-09-04 02:23:57 +00:00
icons Pixmap for Game plugin screen 2005-09-15 17:07:19 +00:00
installer Positional Audio 2005-09-14 20:56:32 +00:00
plugins Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
scripts Turn cvs log into CHANGES, and restart CHANGES to get rid of cvs log messages for it 2005-09-10 00:25:42 +00:00
About.cpp Positional Audio 2005-09-14 20:56:32 +00:00
About.h Forgot to checkin the new about dialog. Ahem. 2005-09-03 15:14:04 +00:00
Audio.cpp Centralized configuration dialog 2005-09-12 01:14:29 +00:00
Audio.h Centralized configuration dialog 2005-09-12 01:14:29 +00:00
AudioConfigDialog.cpp New icons used in config 2005-09-13 20:42:42 +00:00
AudioConfigDialog.h Adjustable jitter buffer initial size 2005-09-13 14:20:48 +00:00
AudioInput.cpp Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
AudioInput.h Finish basic config widget for audio 2005-09-12 13:58:52 +00:00
AudioOutput.cpp Positional Audio 2005-09-14 20:56:32 +00:00
AudioOutput.h Positional Audio 2005-09-14 20:56:32 +00:00
AudioStats.cpp Positional Audio 2005-09-14 20:56:32 +00:00
AudioStats.h Audio statistics window 2005-09-10 22:15:11 +00:00
CHANGES *** empty log message *** 2005-09-10 00:26:41 +00:00
ConfigDialog.cpp Positional Audio 2005-09-14 20:56:32 +00:00
ConfigDialog.h Finish basic config widget for audio 2005-09-12 13:58:52 +00:00
ConnectDialog.cpp When using nested layouts, Qt barfs if a widget already has a parent, so make sure it doesn't. 2005-09-12 12:29:23 +00:00
ConnectDialog.h Add changes file 2005-09-07 17:25:24 +00:00
Connection.cpp Positional Audio 2005-09-14 20:56:32 +00:00
Connection.h Discover the magic of QObject::sender() and fix some leftover bugs from the refactorization 2005-09-08 14:33:15 +00:00
Database.cpp Remove compile warnings, and there sure were a lot of them 2005-09-08 14:09:32 +00:00
Database.h Turn g_ into Global, part 2 2005-09-08 12:38:15 +00:00
DXAudioInput.cpp Use selected device from DXConfig. Still needs to close/reopen on ConfigDialog exit. 2005-09-13 23:53:07 +00:00
DXAudioInput.h Remove m_ from everything 2005-09-08 12:07:25 +00:00
DXAudioOutput.cpp Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
DXAudioOutput.h Positional Audio 2005-09-14 20:56:32 +00:00
DXConfigDialog.cpp Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
DXConfigDialog.h Positional Audio 2005-09-14 20:56:32 +00:00
Global.cpp Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
Global.h Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
GlobalShortcut_win.cpp QHash, foreach() and STL iterators. What ever gave me the idea QMap was a hash to begin with? 2005-09-09 23:21:01 +00:00
GlobalShortcut_win.h QHash, foreach() and STL iterators. What ever gave me the idea QMap was a hash to begin with? 2005-09-09 23:21:01 +00:00
GlobalShortcut.h Actually poll the DirectInput devices too. 2005-09-05 13:14:49 +00:00
INSTALL Add readme 2005-09-05 16:30:18 +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
Log.cpp New icons used in config 2005-09-13 20:42:42 +00:00
Log.h Global Log class, which remembers what should be logged to console and TTS 2005-09-12 21:31:31 +00:00
main.cpp Positional Audio 2005-09-14 20:56:32 +00:00
MainWindow.cpp Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
MainWindow.h Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
Message.cpp Remove compile warnings, and there sure were a lot of them 2005-09-08 14:09:32 +00:00
Message.h Remove m_ from everything 2005-09-08 12:07:25 +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 Export symbol files for debugging of release builds 2005-09-11 14:19:59 +00:00
mumble.pro Positional Audio 2005-09-14 20:56:32 +00:00
mumble.qrc New icons used in config 2005-09-13 20:42:42 +00:00
mumble.rc Initial setup of project 2005-08-31 21:14:21 +00:00
murmur.cpp Proper connect dialog 2005-09-04 16:18:30 +00:00
murmur.pro Add scripts to release source code 2005-09-04 15:19:45 +00:00
Player.cpp Switch a few QMutex to QReadWriteLock, and start using QMutexLocker, QReadLocker etc 2005-09-11 23:11:07 +00:00
Player.h Switch a few QMutex to QReadWriteLock, and start using QMutexLocker, QReadLocker etc 2005-09-11 23:11:07 +00:00
PlayerModel.cpp ToolTips and WhatsThis for rest of application. 2005-09-13 01:56:34 +00:00
PlayerModel.h ToolTips and WhatsThis for rest of application. 2005-09-13 01:56:34 +00:00
Plugins.cpp Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
Plugins.h Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
README Added readme to installer 2005-09-05 17:43:26 +00:00
Server.cpp Deaf implies Mute logic in Server, and add ability to mute/deaf players again (added PlayerModel::getPlayer from index) 2005-09-09 23:35:43 +00:00
Server.h QHash, foreach() and STL iterators. What ever gave me the idea QMap was a hash to begin with? 2005-09-09 23:21:01 +00:00
ServerHandler.cpp Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
ServerHandler.h Discover the magic of QObject::sender() and fix some leftover bugs from the refactorization 2005-09-08 14:33:15 +00:00
Settings.cpp Bugfixes for positional Audio 2005-09-14 23:47:03 +00:00
Settings.h Positional Audio 2005-09-14 20:56:32 +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 Text-To-Speech 2005-09-05 14:41:39 +00:00
VersionCheck.cpp Model-player-list. Work in progress 2005-09-09 14:19:20 +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 [-loop] [-pw <password>] [-port <port>]

-loop   Enable loop test mode, where you will also hear yourself speak.
        Great for testing, but very annoying if there's another person on.

-pw     Set connection password. Players connection without this password
        will be rejected.

-port   Set the port to bind to. The default is 64738.

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.

To keep the jitter-buffers happy and always perfectly tuned, Mumble
transmits data contignously. If you have VAD or Push-To-Talk enabled, it
transmits frames of silence when there's no talking; it does not stop 
transmitting. 
The only exception to this is if you mute yourself. Be aware that after
unmuting there will be about a 400ms delay before the jitter buffers on 
the recieving ends are aligned again.