https://wiki.mumble.info/api.php?action=feedcontributions&user=Zsawyer&feedformat=atomMumble Wiki - User contributions [en]2024-03-29T14:32:24ZUser contributionsMediaWiki 1.31.0https://wiki.mumble.info/index.php?title=Murmurguide&diff=7837Murmurguide2013-11-24T02:08:26Z<p>Zsawyer: /* Becoming Administrator and Registering a User */ fixed broken link</p>
<hr />
<div>'''Please edit this page if you find a feature or step you think should be included; it's a wiki for a reason! Note you must register and wait about 3 days in order to be able to edit.'''<br />
=Setting Up a Murmur Server=<br />
<br />
Note that the instructions of this guide are Windows based, but all of the instructions should be adaptable to Linux. Once your IP is made static, and you get Murmur started, its ini configured, and its port is cleared through whatever firewalls are present, the setup is mostly client-side.<br />
<br />
Always remember that there are professional Mumble server hosters. Simply Googling "mumble server hosting" will come up with many excellent, reliable hosts that offer servers at a very cheap price. We also have a list of hosters [[Hosters|here]].<br />
<br />
If you have any questions, that you cannot find answers to on this page, check the [[FAQ|FAQ]].<br />
<br />
==Preparations==<br />
<br />
===Configure OS===<br />
<br />
====Windows====<br />
Before you can have Murmur completely working, you need to make a few changes to your network on Windows. <br />
<br />
First, make your IP static. Unless you're just going to run this server a few times, or it is a LAN server only to be found via [[Bonjour]], you need to make your IP static so that a person outside of your network can dependably connect to your Murmur server. If you have no idea how to make your IP static, read [http://portforward.com/networking/static-xp.htm this guide] for doing in on Windows XP, and [http://portforward.com/networking/static-vista.htm this guide] for doing it on Windows Vista.<br />
<br />
====Linux====<br />
<br />
Generally, the config file for setting a static IP involves either using your distro's GUI network tool or editing configuration files (for example, ''/etc/network/interfaces''). It is recommended that you [http://www.google.com/ Google] for instructions to set a static IP for your specific distribution. Generally something like "Ubuntu static IP" will get what you need.<br />
<br />
===Configure Network===<br />
<br />
Now you need to open a port on your computer and/or networking equipment. This port will be the port that Murmur runs on, and the default is 64738 (using the TCP and UDP protocols). If you wish to use a port different than this one, use it instead of port 64738 used in this example. If you are just using Windows' built-in firewall then when you start Murmur it should ask whether or not to allow it. If you are using a third-party software firewall you will need to find the instructions for opening a port on it on your own. To learn how to open the port on your network equipment, we recommend you go to [http://www.portforward.com/english/routers/port_forwarding/routerindex.htm Portforward] and select your specific devices from the list. Though Murmur is not currently on the Portforward website, just use some other program in place of it (for instance read the instructions for opening the ports for Call of Duty) but '''only open the port you want to use for ''Murmur''''', ensuring that you are using both TCP and UDP for the port. Remember that ANY device with a firewall between you and the internet ''must'' allow the port you are going to use for Murmur on both the TCP and UDP protocols. That means your [wireless] router, Cable or DSL modem, and anything else that has a firewall.<br />
<br />
After you have forwarded the port, you can check to make sure it is open by going to http://www.canyouseeme.org/ from the computer that has the port forwarded.<br />
<br />
'''Note that if your network seems to have the port forwarded completely, and you ''still'' cannot connect, you may still have some hidden software firewall blocking the port on your server. Check ''very'' carefully to make sure you do not.'''<br />
<br />
===Install Murmur===<br />
<br />
====Windows====<br />
<br />
Now you need to install Murmur. Download the latest stable Win32 release [https://sourceforge.net/projects/mumble/files/ here]. Start the installation, and when you come to the installation selection, select at least the Murmur server. You can choose to install Mumble and Bonjour if you want, but it is not a requirement. Once you have it installed, it is recommended that you make a shortcut to it in order to easily start it. Go to ''C:\Program Files\Mumble'' (or wherever you installed Murmur to), right click on ''murmur.exe'' and click "Create Shortcut." Find the shortcut (it will be in the same folder as ''murmur.exe''), right click it, and click "Rename." Type "Murmur" (without the quotes) and press enter. Now drag the Murmur icon onto your desktop.<br />
<br />
'''Windows Server users note:''' you may have an old murmur.sqlite database if you are upgrading to 1.2.x. Mumble may not remove this database on installation, so unless you want to keep it, you can delete it at ''C:\Users\<username>\murmur.sqlite''.<br />
<br />
====Linux====<br />
<br />
For nearly all Linux distributions, you can simply use the [http://mumble.info/snapshot/ static binary]. However, if your specific distribution supports Murmur (such as Ubuntu), you should look into using the specific packages for it. These are listed on the [[Installing_Mumble#Linux|Linux section of the Installing Mumble]] page.<br />
<br />
==Set Up Server== <br />
<br />
===Configuring ini File===<br />
In ''C:\Program Files\Mumble'' (or wherever you installed Mumble to) there is a file called ''[[Murmur.ini]]'' this contains all the basic settings for Murmur. If you change any of the settings in this ini file, you have to restart Murmur for the changes to apply. It is suggested that you look over and/or configure the lines that start with the following:<br />
welcometext=<br />
port=<br />
serverpassword=<br />
bandwidth=<br />
users=<br />
registerName=<br />
You do not need to change any of these fields for your server to work, but you should change them if you ''need'' to. For instance if you do ''not'' want your server to be public (that is, any user of Mumble has the potential to enter it) you should set <br />
serverpassword=<br />
to<br />
serverpassword=Password_of_your_choice<br />
(''Password_of_your_choice'' being whatever you want your server password to be.)<br />
Uncomment <br />
#registerName=<br />
(change it to) <br />
registerName= <br />
and set it. This line sets the name of the Root channel of your Murmur server. It is the top channel of the server and if you do not set it, it will have a name of "Root." For instance if you wanted to name the server "FPS Fun" you would set the line to<br />
registerName=FPS Fun<br />
''Do not'' fill out the other<br />
#register* <br />
fields or uncomment them if you are going to have a server password set.<br />
If you ''want'' it to be public you ''must'' leave<br />
serverpassword= <br />
blank<br />
and you must set the following lines with the proper information and remove the # from them. (# at the beginning of a line comments the entire line, telling the program that reads it to completely ingore the line.) The lines below register the server with the central Mumble server list and make it so that one who browses the servers on the "Server Browser" tab of the connect window can see your server. Read the commented lines in the ini for specific information about these three lines.<br />
#registerName=<br />
#registerPassword=<br />
#registerUrl=<br />
The<br />
#registerHostname=<br />
line is optional and only set it if you have an external static IP. If you are on a home-based DSL or Cable network, you probably should not set this field. <br />
<br />
Carefully read the commented text in the ini file for explanations of each of the ini settings you wish to change or set.<br />
<br />
===Regular Expressions===<br />
If you want to use a character that the server does not allow, you need to use regular expressions. These are, in themselves, rather complex, but for Mumble, you don't need to learn them. Here's a quick guide to regular expressions:<br />
<br />
If you want to use the character "%" in a channel name, then uncomment this line in Murmur.ini: <br />
#channelname=[ \\-=\\w\\#\\[\\]\\{\\}\\(\\)\\@\\|]+ <br />
so that it is <br />
channelname=[ \\-=\\w\\#\\[\\]\\{\\}\\(\\)\\@\\|]+<br />
then add the character, which will make it look like this: <br />
channelname=[ \\-=\\w\\#\\[\\]\\{\\}\\(\\)\\@\\|\\%]+<br />
See? It's easy. You just add each character that you want, putting ''\\'' between each character. <br />
<br />
If you want to add the ability for users to use spaces in their username, then uncomment this line<br />
#username=[-=\\w\\[\\]\\{\\}\\(\\)\\@\\|\\.]+<br />
so that it is<br />
username=[-=\\w\\[\\]\\{\\}\\(\\)\\@\\|\\.]+<br />
then make it look like this:<br />
username=[ \\-=\\w\\[\\]\\{\\}\\(\\)\\@\\|\\.]+<br />
(See the space at the very beginning, right after the ''['' ?)<br />
<br />
===Starting Murmur===<br />
<br />
'''In server versions up to 1.2.2, the server must have been run normally at least once, to generate the database properly. Also, if you are using a custom config file location, you must remember to specify it on the command line using the ''-ini <path>'' flag while setting the password.'''<br />
<br />
====Windows====<br />
<br />
Once you have configured the .ini file to your liking and are ready to start Murmur, start it by double clicking the Murmur icon you put on your desktop. The server should start and you should see a little icon similar to Mumble's in your system tray (the little icons in the bottom right corner of your screen). You can right click this icon and select either "Show Log" to view the log that Murmur generates (users that connect, settings initialized, etc.) or "Quit Murmur" to shut down the Murmur server. <br />
<br />
If you want Murmur to automatically start with Windows, select the Murmur icon, right click it, and click "Copy." Now right click on your start button, select "Open All Users" and open "Programs\Startup." Right click in an empty space and select "Paste." Now Murmur should start with Windows.<br />
<br />
=====Running as a Windows Service=====<br />
<br />
Apparently it's possible to run Murmur as a service using Microsoft's SRVANY.EXE tool, per [https://sourceforge.net/tracker/index.php?func=detail&aid=2951513&group_id=147372&atid=768008 this Feature Request thread]. Someone more familiar with the process should write up some clean instructions here.<br />
<br />
====Linux====<br />
<br />
If you are using the static binary, simply CD to wherever you extracted it, chmod it, and then do<br />
./murmur.x86 [-ini <path>]<br />
<br />
If you are using a package for your distribution, the command is usually <br />
murmurd<br />
<br />
However, most packages will automatically start from init.d; you should check to make sure yours does not before manually starting it. For Debian-based distributions, you should use the PPA repository found here: https://launchpad.net/~slicer/+archive/ppa and then use the following commands:<br />
sudo apt-get update<br />
sudo apt-get install mumble-server<br />
sudo dpkg-reconfigure mumble-server<br />
after that, Mumble should be running. The config file for Mumble on Debian-based systems should be at ''/etc/mumble-server.ini''.<br />
<br />
===Setting SuperUser Password===<br />
<br />
Now you will need to set the SuperUser Password. The server should be running at this point.<br />
<br />
====Windows====<br />
<br />
To set the SuperUser password, press the Windows key and hold it down (it's right between left control and right control) and then press the R key. In the input box of the window that pops up, type ''cmd'' and press enter. Now type <br />
cd %ProgramFiles%\Mumble<br />
and press enter. If you installed Murmur to a folder different from this, you need to cd to wherever you decided to install it to. <br />
<br />
After you have done that, type <br />
murmur.exe [-ini <path>] -supw Password_of_your_choice<br />
(''Password_of_your_choice'' being whatever password you want to give SuperUser) and press enter. A window should pop up that says something like "Superuser password set on server1." Note that ''this does not start the Murmur server'', it only sets the SuperUser password.<br />
<br />
====Linux====<br />
<br />
If you're using the static binary, CD to where you extracted it, and run<br />
<br />
./murmur.x86 [-ini <path>] -supw Password_of_your_choice<br />
<br />
===Connecting to Murmur Server===<br />
<br />
Now that Murmur is started, start Mumble. When it is started, click the ''Add New...'' button. Then fill the fields with your servers information.<br />
<br />
The ''Servername'' field contains the name that will be displayed in your server list.<br />
<br />
The ''Address'' field is the external IP of your server; if you do not know the external IP, go here (from the computer hosting Murmur): http://whatismyipaddress.com/ ; or your servers bonjour name (prefixed with @). '''Your external IP is ''never'' 192.168.x.x'''<br />
<br />
The ''Username'' field takes your users Name. Be aware that names are case sensitive. If you want to connect as SuperUser mind the capitalization. Since you are going to want to add your user as an admin, put in that username for now.<br />
<br />
Note that in contrast to 1.1.8 there is no password field. This is because 1.2.x relies on certificate authentication. If for some reason a password is needed the client will present you with a prompt.<br />
<br />
===Becoming Administrator and Registering a User===<br />
<br />
In 1.2.x you don't need any 3rd party scripts, servers, or programs to add a user. First, you probably want to become a member of the administrator group. <br />
<br />
'''Note that as an administrator, you can manage the registered users by going to Server -> Registered Users.'''<br />
<br />
Becoming an admin:<br />
<br />
# Start the Mumble client. <br />
# Go through the Certificate Wizard and either import or create a certificate. You can skip the Audio Wizard if you want, although you will need to run through it in order to set up your mic properly, so you might want to do that anyway.<br />
# Open Configure -> Settings and check "Advanced" at the bottom left.<br />
# Join your server following the [[Murmurguide#Connecting_to_Murmur_Server|previous step]]<br />
# When you are connected to the server, right click on your username, and then click "Register" - if you do not see this option, ensure that you have an @all ACL that has "Register Self" set to Allow, Applies to sub-channels unchecked.<br />
# Reconnect as the SuperUser - Go back to your server list, and on the main Mumble window click Server -> Connect. You will see the server you added in the previous step. Right click it and select "Edit..." Change ''Username'' to SuperUser, click OK, then click Connect.<br />
# Right click the "Root" Channel (it will be above your username; it will be whatever you named it if you set the registerName in Murmur.ini) and click ''Edit''.<br />
# Go to the Groups tab <br />
# In the drop-down box at the top select the "admin" group <br />
# In the "Members" drop-down box at the bottom left, type your username and press enter<br />
# Click OK<br />
# Follow step 3 to change your username back to the user you added with SuperUser<br />
# Connect back to the server <br />
# Test your administration ability by right clicking the root channel, clicking ''Add'', and adding a new channel<br />
<br />
The default settings allow users to register themselves. This can be disabled within the ACLs. Members of the admin group can always ''right click->Register'' a user to register them manually. Note that this only works if the user provided a certificate (meaning that they have completed the certificate wizard).<br />
<br />
'''''Make sure that you instruct everyone on your server to back up their certificate. The certificate wizard forces you to do this, but you should always back it up to a secure storage medium like a flash drive, your email inbox, or any external storage medium. If you ever lose your certificate, you will have to re-register and be manually added back into all your various ACLs!'''''<br />
<br />
If you want to learn more about ACLs see [[ACL_and_Groups|this guide]].<br />
<br />
For a quick overview of what a certificate is, and how they are used to identify people, see [[Authentication|this page]].<br />
<br />
===Permissions===<br />
Note that you '''must''' have '''Advanced Config''' checked at Configure -> Settings in order to see the ACL tab for a channel.<br />
<br />
====ACLs====<br />
<br />
Many people have complained about the complexity of ACLs - that they are complicated, hard, and cumbersome. ''They are none of these if used correctly.'' You see, the ACLs ''can'' be as complicated as you want. It is basically a full permissions suite similar to what you would deal with on an Apache server. But it doesn't ''have'' to be that complicated! <br />
<br />
Do you know what ACL means? Access Control List. That is all. An ACL simply defines where and what a "Group" can do. A Group is simply a bunch of users defined by a name. That is all.<br />
<br />
Here is a basic guide that you can use to create the most essential permissions for your server:<br />
<br />
Ok. You have made one admin so far. If you want to add ''another'' admin, the other person you know must register himself. After that, you can open the ACL editor and add him in the same way that you used SuperUser to add yourself.<br />
<br />
But now you want to make a channel that only certain people can get in. Very simple.<br />
<br />
# Make sure that everyone you want to add is registered with the server<br />
# Make the channel for the people who want it (for this example, make an MMO channel)<br />
# Right click on the root channel, click "Edit", then go to the Groups tab<br />
# Click, in the empty box at the top, and type the name of the group you want to add. For example, if you wanted to make a channel for MMO players, you might name your group "MMOplayers." Type that into the box and press enter. A new group has been made. <br />
# Now you need to add members to this group. In the box at the bottom left, type a member name and press enter after each name. The names that you add should appear in the box above the input box.<br />
<br />
Finally, you need to create an ACL for the channel. Close the current window, and then right click on the MMO channel and select Edit. Click the ACL tab. <br />
<br />
# Here is where it ''appears'' to become complicated, when in fact it is not at all. What you first see is inherited ACLs. All inherited means is that the permissions of the above channel are automatically applied to this one. Since we don't want that, uncheck "Inherit ACLs."<br />
# Now if you just left it like it is now, then the @all permissions would be in effect for this channel. Anyone who went into this channel (except for those in the admin group; they override this) would have the permissions you see at the right.<br />
# But we want to make some ACLs. Start off by adding an "@all." Just click "Add" and it will be created. By default, the Group will be ''all''. All the ''@'' means is "apply to." For this group, you probably just want to set "Deny" for all the permissions. However, you don't have to manually click "Deny" on everything. The group that is defined before it, the "@all" in italics, already has set permissions. For example, it defaults to deny "Write ACL." So, in the "@all" ACL below it, if you don't check either "Deny" or "Allow" and it will default to "Deny." '''Also note that lower ACLs take priority over ones above them. For instance, you can make an @all that denies permissions for everything, and make an @all below that one, that allows permissions for everything, and everyone in the server will be given administrator-level access to the server.'''<br />
# Now click "Add" again. However, this time you need to click the "Group" box at the bottom left. Delete the "all" text from there and type ''MMOplayers'', then press enter. <br />
# Now you need to define what exactly ''MMOPlayers'' can do. The recommended settings would probably be "Allow" on all the permissions except for "Write ACL" and "Make channel"; those two permissions should be set to "Deny".<br />
# Now only people in the ''MMOplayers'' group should be able to join the channel (and those in the admin group, of course).<br />
<br />
====Access Tokens====<br />
Another nice feature of Mumble 1.2.x is Access Tokens. These are what you could call passwords; basically, if you have a token that is the same name as the channel's ACL Access Token group, you can enter the channel. Think of Access Tokens as groups where you can add yourself to the group if you know the "password" (token).<br />
<br />
# Go to Server -> Access Tokens and add a token.<br />
# Add an ACL for a channel you want to give permissions to. Do exactly the same as you would with a normal ACL, but when you assign a group for the ACL, type ''#TOKEN_NAME'' (TOKEN_NAME being the name of the token that you added in the above step). <br />
# Now each individual user can click themselves, click Server -> Access Tokens, and add the tokens for the channels they want to enter. Remember, channel owners should only give out the token name to those they want to enter their channel, and it is best to pick a unique, hard-to-guess name for your token.<br />
<br />
==Server Configuration Methods==<br />
<br />
As of Mumble 1.2.x, nearly all administration tasks can be handled directly through the client. However, if you are a dedicated server hoster, you will probably want to start virtual servers, and have some way of configuring and applying the '''murmur.ini''' parameters without having to shut down Murmur. See below for more information.<br />
<br />
===Remote Controlling the Server===<br />
<br />
For a 3rd party application there are two methods, [[Ice]] and [[DBus]], to interact with the server. These can be used from a variety of programming languages and give you low-level access to a lot of functionality.<br />
<br />
The easiest way to set up a remote interface is to use Mumble-Django or [https://sourceforge.net/projects/mumpi/ MumPI]. <br />
<br />
If you are using a Debian-based distribution, you can install Mumble-Django with<br />
<br />
sudo apt-get install mumble-django<br />
<br />
and follow the included documentation.<br />
<br />
You can find a list of all the various web-interfaces [[3rd_Party_Applications]].<br />
<br />
'''This is not a required step in this guide.'''<br />
<br />
[[Category:Documentation]]<br />
[[Category:Documentation English]]</div>Zsawyerhttps://wiki.mumble.info/index.php?title=Positional-Audio&diff=7827Positional-Audio2013-11-06T21:52:01Z<p>Zsawyer: /* How do I create Positional Audio for an unsupported Game */</p>
<hr />
<div>= Positional Audio =<br />
<br />
== What is Positional Audio ==<br />
Positional Audio is a feature of Mumble that places the people talking to you in a certain position relative to your own depending on their actual position in the game you are playing. This way you can hear the person like his actual avatar in-game would be talking to you.<br />
<br />
If someone is NOT using Positional Audio, you would hear that audio source always from the same spot, equally loud from each of your stereo speakers.<br />
<br />
[[File:StationaryAudio.gif|center|alt=Shows Audiowaves without Postional Audio in cyberspace]]<br />
<br />
If someone uses Positional Audio, and is in the same context [[Games|(game)]] you will hear him louder from one speaker than from the other in such a way that correctly represents his angle and distance to you.<br />
<br />
[[File:Positional_Audio.gif|center|alt=Shows Audiowaves with Postional Audio in cyberspace]]<br />
<br />
== How does Mumble get informations about the virtual positions of the clients ==<br />
<br />
There are two different approaches for Mumble to get this information.<br />
* One: The [[Games#Supported_Games|Game]] itself has a routine that transmits this data from within the program to the mumble client.<br />
* Two: The Mumble client can use a specially crafted plugin to peek into the memory of a game to get the needed information. This approach is done from outside of the program. If a program gets updated and stores the position on a different memory offset the plugin has to be updated as well to work again.<br />
<br />
Either way Mumble tries to gain the following information:<br />
* Position/Heading of your avatar [[Games#Supported_Games|in-game]]<br />
* Position/Heading of the [[Games#Supported_Games|in-game]] camera<br />
* A so called "context" uniquely identifying the game (as in server/realm and so on) you are playing on<br />
* A so called "identity" uniquely identifying the client amongst other clients with the same "context". It is also used to store additional information like team or class depending on the game.<br />
<br />
The server will only transmit positional audio data to client with matching context information. That means if you play a game on two different servers you will not hear each other positionally. The context and identity information are not forwarded to the other clients though. They can be used by server side applications which could, for example, place players in different channels/groups depending on the server/team they are currently playing on/in.<br />
<br />
== How to activate Positional Audio ==<br />
[[File:Audio-Output.jpg|thumb|This shows the Settings Page of the Audio output.]]<br />
Postional Audio is activated by default. If you wish to configure it you will have to open settings pages of Mumble and check the <br />
<br />
<br />
(1) Advanced Config settings<br />
<br />
on the Audio Output is a check box (2) to General enable or disable Positional Audio for your client.<br />
<br />
<div style="clear:right;"></div><br />
<br />
----<br />
<br />
[[File:Plugin.jpg|thumb|left|the Plug-ins Config Page]]<br />
<br />
On this Page you are able to generally allow Mumble to see if you run a program that matches one of the plugins in Box (2)<br />
The check box in the plug-in list (2) enables or disables the plug-in. This way you can decide if you want positonal audio for a certain program or not.<br />
The Button (3) "reload Plugins" tells the client to reload the .dll's from the filesystem and check if there is a new Plugin in the plugin folder on your local drive.<br />
<br />
<br />
Mumble does this lookup on startup and futher more checks on the internet for updated versions of the plugins. If there is a newer version the client downloads it automatic and places it into the right folder. Be aware that if there is an old .dll it gets replaced.<br />
(4) shows you addtional Infos about the selected plugin in (2) the main box.<br />
<br />
If the Plugin can be configured you can use Button (5) Configure to get into the options of the selected Plugin.<br />
<br />
<br />
<br />
Currently the only Plugin that has such a page is the ''"Manual Positonal Audio"'' Plugin (see --> Games [[Games#Special_Plugins]])<br />
<br />
<div style="clear:left;"></div><br />
<br />
== What Programs/Games does Mumble Support with Positional Audio ==<br />
<br />
see --> [[Games]]<br />
<br />
== How do I create Positional Audio for an unsupported Game == <br />
<br />
See [[Pluginguide]] for a step-by-step explanation on how to create plugins and [[HackPositionalAudio]] for a more abstract explanation with more methods for retrieving the data.<br />
<br />
If you can mod the game you might be able to use [[Link]]. Check in advance if the game's modding API allows you access to the relevant data! <br />
<br />
{{Docs en}}</div>Zsawyerhttps://wiki.mumble.info/index.php?title=Games&diff=7826Games2013-11-06T20:21:38Z<p>Zsawyer: /* Supported Games */ added ArmA2OA and ArmA3 Mod; updated Minecraft Mod info (has extended support and is moddable)</p>
<hr />
<div>= Overlay =<br />
Our overlay is not technically game-specific but rendering-engine-specific. Thus it works for all games using supported rendering APIs.<br />
<br />
For more information on the overlay, see our page [[Overlay]].<br />
<br />
= Positional audio =<br />
[[File:Positional_Audio.gif|left|alt=Shows Audiowaves with Postional Audio in cyberspace]]<br />
Please note that Mumble works with all games as a regular voice chat application. Those listed on this page are the games for which we are providing [[Positional-Audio|positional sound]] support, so that the voice of your teammates comes from their direction in game. This feature '''can be enabled as follows''':<br />
1) Check "Advanced" in the ''Configure|Settings'' menu<br />
2) Go to ''Plugins'' and check "Link to Game and Transmit Position"<br />
<br />
If you deselected ''Enable positional audio'' during setup you have to re-enable it in the wizard.<br />
<br />
'''Just because your game says it is a different version from the plugin does not necessarily mean that the plugin will not work.'''<br />
<br />
It is possible that some plugins are outdated in the current release; in that case please check the lists below.<br />
<br />
If there is no update for the plugin, please [http://sourceforge.net/tracker/?atid=768005&group_id=147372&func=browse report a bug here].<br />
<br />
For additional info on what positional audio is and how it works in Mumble, see --> [[Positional-Audio|here]]<br />
<br />
If you want to add support for a game and you are able to modify the source of this game you can use the [[Link]] plugin. If you cannot modify the source of the game you want to add, [[Pluginguide | this guide]] should help. For an overall look at retrieving positional data from a game, see [[HackPositionalAudio | here]].<br />
<div style="clear:left;"></div><br />
<br />
== Supported Games ==<br />
<br />
The following table displays which games positional audio is available for, and from which game version on (/for which version).<br />
<br />
Games that provide native positional data via the link plugin are marked in <span style="background-color:#e8e8ff">blue</span> (that means they won’t get outdated). ''Basic support'' means that the games don't use the extended positional audio features that were introduced with Mumble 1.2.<br />
<br />
{|border="0" cellpadding="2" cellspacing="1" style="background:#e2e2e2;" class="sortable"<br />
! Game<br />
! Supported Game Version<br />
! Platform<br />
! Extended Support (Context, Identity)?<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Age of Chivalry<br />
| Build 4104<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Armed Assault 2<br />
| 1.08<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic Support<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [https://dev-heaven.net/projects/mumblelink ArmA 2: Operation Arrowhead Mod]<br />
| >= 1.60<br />
| Win<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [https://dev-heaven.net/projects/mumblelink ArmA 3 Mod]<br />
| >= 0.5<br />
| Win<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Battlefield 1942<br />
| 1.61b<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic Support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Battlefield 2<br />
| 1.50<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Battlefield 2142<br />
| 1.50<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Battlefield 3<br />
| Build v944019<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Battlefield Bad Company 2<br />
| Build 795745<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Battlefield Heroes<br />
| ??<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic Support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Borderlands<br />
| 1.40<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Breach<br />
| 1.1.0<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic Support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Call of Duty 2<br />
| 1.3<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Call of Duty 4: Modern Warfare<br />
| 1.7.568<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Call of Duty: World at War<br />
| 1.7.1263<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Call of Duty: Modern Warfare 2<br />
Multiplayer + Special Ops<br />
| 1.1<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic Support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Counter-Strike 1.6<br />
| 1.6<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://store.steampowered.com/app/240/ Counter-Strike: Source]<br />
| >= Feb 5 2013 <sup>[http://store.steampowered.com/news/9893/ ref]</sup><br />
| Any<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://www.dayofdefeat.com/ Day of Defeat: Source]<br />
| >= 1.0.0.46 (01:24:57 Oct 26 2012 (5101)) <sup>[http://store.steampowered.com/news/9221/ ref]</sup><br />
| Any<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Dystopia<br />
| Build 4104<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Enemy Territory: Quake Wars<br />
| 1.50<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://ethernet.wasted.ch Revenge of the Cats: Ethernet]<br />
| >= prototype 1.6<br />
| Any<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://ezquake.sf.net ezQuake]<br />
| 2.0 alpha<br />
| Any<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Garry's Mod 11<br />
| Build 4426<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Grand Theft Auto IV<br />
| 1.0.7.0<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Guild Wars<br />
| ??<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [https://www.guildwars2.com/ Guild Wars 2]<br />
| >= Build 2/26/13 <sup>[https://forum-en.guildwars2.com/forum/info/news/Game-Update-Notes-February-26-2013 ref]</sup><br />
| Any<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://store.steampowered.com/app/320/ Half-Life 2: Deathmatch]<br />
| >= 1.0.0.37 (01:24:57 Oct 26 2012 (5101)) <sup>[http://store.steampowered.com/news/9221/ ref]</sup><br />
| Any<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://store.steampowered.com/app/222880/ Insurgency]<br />
| ?<br />
| Any<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Insurgency: Modern Infantry Combat<br />
| Build 4044<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#e8e8ff"<br />
| ioquake3<br />
| ?<br />
| Any<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://www.minecraftforum.net/viewtopic.php?f=1032&t=235800 Minecraft Mod]<br />
| >= Beta 1.3<br />
| Any<br />
| style="background-color:#abf8a1" | Yes ([http://www.minecraftforum.net/topic/217587-164-mod-mumblelink-forge-smp-lan-mumble-realism-directional-voip/#developmentAddons moddable])<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Left 4 Dead<br />
| Build 4440<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Left 4 Dead 2<br />
| Build 4777<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Link<br />
| 1.2.0<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| League of Legends<br />
| 1.0.0.139<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Lord of the Rings Online<br />
| Update 6<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Nuclear Dawn<br />
| >= 6.9 <sup>[http://store.steampowered.com/news/9647/ ref]</sup><br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Planetside 2<br />
| Coming soon!<br />
| Win32<br />
| style="background-color:#abf8a1" | ?<br />
<br />
|-style="background-color:#e8e8ff"<br />
| Regnum-Online<br />
| ?<br />
| Any<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://sauerbraten.org/ Sauerbraten]<br />
| >= 2008_06_17_ctf_edition<sup>[http://sauerbraten.org/docs/history.html ref]</sup><br />
| Any<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#e8e8ff"<br />
| Source Engine ([http://www.teamfortress.com/ TF2], DOD:S, HL2:DM)<br />
| >= ?<sup>[http://store.steampowered.com/news/9221/ ref]</sup><br />
| Any<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Sub Rosa<br />
| 0.07b<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Star Trek Online<br />
| ST.0.20100208b.4<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://www.teamfortress.com/ Team Fortress 2]<br />
| >= 1.2.3.5 (01:24:57 Oct 26 2012 (5101))<br />
<sup>[http://store.steampowered.com/news/9221/ ref]</sup><br />
| Any<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Unreal Tournament 2004<br />
| Build 3369<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic Support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Unreal Tournament (UT99)<br />
| ??<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Unreal Tournament 3<br />
| 2.1<br />
| Win32<br />
| style="background-color:#ddffdd" | Basic Support<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://www.warsow.net/ Warsow]<br />
| >= 0.6 <sup>[http://www.warsow.net/forum/thread/t/191271#post-191271 ref (0.6 changelog)]</sup><br/>Improved >= 1.0 <sup>[http://www.warsow.net/forum/thread/t/206086#post-206086 ref]</sup><br />
| Any<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#e8e8ff"<br />
| [http://www.warsow.net/forum/thread/t/158000#post-158000 Warsow Mumble Mod]<br />
| Any<br />
| Any<br />
| style="background-color:#ddffdd" | Basic support<br />
<br />
|-style="background-color:#f8f8ff"<br />
| Wolfenstein: Enemy Territory<br />
| 2.60b<br />
| Win32<br />
| style="background-color:#abf8a1" | Yes<br />
<br />
|-style="background-color:#f8f8ff"<br />
| World of Warcraft<br />
| 4.2.2<br />
| Win32<br />
| style="background-color:#dff5e3"| Outdated<br />
<br />
|}<br />
<br />
"Outdated" plugins are plugins that work only for the "Supported" version mentioned, most plugins continue to work even with non-matching "Game" & "Supported" versions.<br />
<br />
== Manual Positional Audio Plugin ==<br />
<br />
[[File:POS-Audio-plugin.jpg|thumb|right|the config page of the manual postitonal audio plugin]]<br />
In addition to the mentioned plugins, there is a special plugin called ''manual placement plugin''. It does not require a game. Instead you can configure the plugin itself to set your own position from which other people in the same channel can hear you.<br />
<br />
'''1''' set yourself on the canvas from where others should hear you. '''Make sure to choose a position other than X;Y;Z 0;0;0''' or you won't hear or send positionally.<br />
<br />
'''2''' set your own orientation where you want your virtual avatar to look at on a 360° Scale<br />
<br />
'''3''' set your own azimuth (if you look up or down while you talk)<br />
<br />
'''4''' and '''5''' set the context and identity of your avatar only the people with the same context will hear you positionally.<br />
<br />
'''6''' Link or Unlink the plugin to Mumble so the settings are transfers to the server for processing<br />
<br />
'''7''' Activate or Deactivate the Plugin<br />
<br />
'''8''' Unhinge the settings window so it stays open even with the configuration settings Page closed therefore you can still change the positional audio settings without keeping the overall mumble settings open.<br />
<br />
'''9''' set standard values for all settings<br />
<br />
'''10''' close the page<br />
<br />
[[Category:Documentation]]<br />
[[Category:Documentation English]]</div>Zsawyerhttps://wiki.mumble.info/index.php?title=Installing_Mumble&diff=7825Installing Mumble2013-11-06T19:56:52Z<p>Zsawyer: /* SUSE */ added hint where to find other package versions</p>
<hr />
<div>=Introduction=<br />
<br />
This page shows you directions on how to install and use Mumble (client) and Murmur (server). For complete usage information, see [[Mumbleguide|Mumbleguide]], [[Murmurguide|Murmurguide]], and/or the respective subsections on the main page.<br />
<br />
__TOC__<br />
<br />
=Getting and Installing Mumble and Murmur=<br />
<br />
==Windows==<br />
<br />
Just head to [http://sourceforge.net/project/showfiles.php?group_id=147372 SourceForge downloads page], get the Windows executable and run it. Follow the installer instructions and you are done. The installer includes both the client and the server.<br />
<br />
(for Win2000 see [[Tips_Tricks]])<br />
<br />
==Mac OS X==<br />
<br />
'''Precompiled Mac OS X universal binaries''' are available from the [http://sourceforge.net/project/showfiles.php?group_id=147372 SourceForge downloads page]. <br />
<br />
Note that the official releases of Mumble 1.2.x are ''not currently compatible with Mac OS X 10.4'', but you can try the experimental snapshots found [http://www.scorpius-project.org/mumble-osx-10.4/ here] '''warning: use at your own risk; these have not been thoroughly tested, and may have bugs'''.<br />
<br />
In order to be able to use the '''[[Overlay]]''' it has to be installed separately. To install it launch Mumble, go into ''Mumbles settings'' into the Overlay section and you should see an ''option to install it''. The reason for the separate installation is that Mumble itself does not need administrative rights to install, but the overlay does.<br />
<br />
==Linux==<br />
<br />
For most Linux distributions, the client package name is ''mumble'' and the server package name is ''mumble-server'' or ''murmur''. For many Debian- and RPM-based distributions, there is ''mumble-server-web'', which is a turnkey installation of ICE for Murmur.<br />
<br />
On the popular Linux distributions, Mumble should be available in either third party repositories or the official repository. See the distribution sections below.<br />
<br />
==== Debian ====<br />
<br />
'''Note that for the mumble-server package on Debian or Debian-based distributions, you should not start the server manually. After you install and configure it, it will start on its own.'''<br />
<br />
Debian unstable has the latest release at all times in it's repository, and snapshots in experimental. Backports to current stable are done as soon as the package reaches testing (usually a week after release).<br />
<br />
apt-get install mumble<br />
or<br />
apt-get install mumble-server<br />
dpkg-reconfigure mumble-server<br />
<br />
==== Ubuntu ====<br />
<br />
Ubuntu carries whatever Mumble version was current at the time of the release in the universe repository. We also maintain a PPA that has the latest version for recent Ubuntu versions<br />
<br />
sudo add-apt-repository ppa:mumble/release<br />
sudo apt-get update<br />
<br />
sudo apt-get install mumble<br />
or<br />
sudo apt-get install mumble-server<br />
sudo dpkg-reconfigure mumble-server<br />
<br />
=== RHEL (and its derivatives, such as CentOS) ===<br />
<br />
Please see the [[Install CentOS5]] page for both packaged and manual murmur installation instructions. Mumble is not easily built on this platform at this time, and there are no official packages (yet?).<br />
<br />
For CentOS 6 see the [[Install CentOS6]] page.<br />
<br />
=== Fedora ===<br />
<br />
Since Fedora 13, use yum:<br />
<br />
yum install mumble<br />
<br />
There are additional packages available as <tt>mumble-*</tt>, such as <tt>mumble-overlay</tt> and <tt>mumble-server-web</tt>. Please consult your package manager for more information.<br />
<br />
=== SUSE ===<br />
<br />
Mumble packages are available from [http://software.opensuse.org/package/mumble software.opensuse.org].<br />
<br />
You can follow these steps while running openSUSE:<br />
# Open a web browser and go to [http://software.opensuse.org/package/mumble software.opensuse.org/package/mumble]<br />
# Assuming you're running 32bit, click on '''1-Click Install''' located at the first result<br />
# When asked to download a file, tell your browser you want to open the file<br />
# Once YaST is opened, click ''Next'' (leave defaults), then ''Next'' again, and again<br />
# Enter your root password if asked; Mumble will now download<br />
# Click '''Finish'''<br />
# To run Mumble:<br />
## Open the Kickoff application launcher and type '''mumble''', then --> '''Run mumble'''<br />
## Or: open a terminal and type '''mumble''' and press enter<br />
<br />
<br />
''Note: If you are asked to accept a certificate just press '''OK'''''<br />
<br />
''Note: Latest mumble version can usually be found at [http://software.opensuse.org/package/mumble opensuse.org] under "Show other versions" either at "openSUSE Factory" or under "Show unstable packages" of your openSUSE version.''<br />
<br />
Some packages can also be found in the [http://download.opensuse.org/repositories/home:/lnussel:/mumble:/unstable/ Build Service].<br />
<br />
=== Arch Linux ===<br />
To install Mumble, use pacman:<br />
pacman -S mumble<br />
<br />
For the Mumble Server Murmur:<br />
pacman -S murmur<br />
<br />
There are also unstable packages in AUR:<br />
* Mumble Unstable (updated directly from Git): http://aur.archlinux.org/packages.php?ID=26865<br />
* Murmur Unstable (updated directly from Git): http://aur.archlinux.org/packages.php?ID=32900<br />
* Murmur ICE (with ICE support): http://aur.archlinux.org/packages.php?ID=19980<br />
* umurmur (minimalistic murmur): http://aur.archlinux.org/packages.php?ID=38982<br />
<br />
=== Mandriva/ROSA/Unity ===<br />
<br />
Mumble is available since 2010.0.<br />
<br />
urpmi mumble<br />
<br />
It's best to install the package from Cooker - it has many fixes.<br />
<br />
=== Others ===<br />
<br />
If all of the above options fail to work, you can always try [[BuildingLinux|compiling Mumble from source]], however installing a package is considered "best practice".<br />
<br />
== Smartphones ==<br />
Mumble is currently being ported/reimplemented for various mobile phone platforms.<br />
<br />
=== iPhone ===<br />
There is currently an iPhone version of Mumble in the works; you can find more information about it from the [http://mumble.git.sourceforge.net/git/gitweb.cgi?p=mumble/mumble-iphoneos;a=summary iPhone Git repository]. Any help with the project is always appreciated.<br />
<br />
If you are on a jailbroken device you can point your iOS device [http://mumble-ios.appspot.com/wdist here] and it will automatically install the latest build of Mumble.<br />
<br />
Precompiled builds can be found [http://sites.google.com/site/mumbleforios/ here] with instructions to install to a jailbroken iOS device. The build is unsupported as it was not compiled by an official Mumble developer.<br />
<br />
=== Maemo (Nokia) ===<br />
Maemo builds can be found [http://maemo.org/packages/view/mumble/ here]. These builds are unsupported, as they were not made by official Mumble developers. That does not, of course, mean you shouldn't use them; it just means there's no guarantee we can help you if you have a problem.<br />
<br />
{{Docs en}}</div>Zsawyer