ReadMe for mod_MumbleLink v2.5.5 at http://www.minecraftforum.net/viewtopic.php?f=1032&t=235800 by zsawyer, 2012-12-22 About: This is a Minecraft mod based on ModLoader. It's purpose is to be able to use Minecraft in conjunction with Mumble's positional audio feature. (http://mumble.sourceforge.net/) This means: Directional and positionally attenuated VOIP in relation to the game world. It uses the Mumble Link Plugin v1.2.0 and adds native mumble support. Tested with Mumble 1.2.2, 1.2.3 and PR_Mumble1.0 . Prerequisites: - Minecraft 1.4.6 - ModLoader installed (http://www.minecraftforum.net/viewtopic.php?t=80246) - Mumble + advanced option "Link to Game and Transmit Position" activated (Configure -> Settings -> Tick "Advanced" -> "Plugins" -> Tick "Link to Game and Transmit Position") Installing the Mod: 1. Close both Mumble and Minecraft. 2. install ModLoader 3. unzip and put the "MumbleLink" folder (from within the .zip) and its contents into your mods-folder within the .minecraft-folder so that the "mod_MumbleLink.class" file is located at: Windows: %Appdata%\.minecraft\mods\MumbleLink\mod_MumbleLink.class Linux: ~/.minecraft/mods/MumbleLink/mod_MumbleLink.class 4. setup Mumble: activate advanced option "Link to Game and Transmit Position" Configure -> Settings -> Tick "Advanced" -> "Plugins" -> Tick "Link to Game and Transmit Position" Upgrading from earlier Versions: 1. Close both Mumble and Minecraft. 2. install latest ModLoader 2. unzip and put the "MumbleLink" folder (from within the .zip) and its contents into your mods-folder, replace/overwrite all files if prompted for Advanced Mumble Configuration Instead of hearing people from indefinitely far away you can set up mumble to only hear them when they are close. In return you (and they!) will need to bind an extra key to communicate with those far away (imagine it being a "walkie-talkie" button). To set this up you will need to do some special settings which differ from the defaults, in return it might enhance your audio experience. - In settings dialog check "Advanced" (bottom left) -- "Link to Game and Transmit Position" activated, -- restart after setting this option -- (this mod will not work without it!!!) - Maximum Distance: 70m -- (this value will determine when others are too far away to be heard) - Minimum Volume: 0% -- (this value makes you not hear people beyond Maximum Distance) - untick "Attenuate applications by..." "while other users talk" and "while you talk" -- (mumble would dampen Minecraft's audio if ticked) - bind a key ("Shortcut") to "Shout/Wisper" "Shout to Channel" select "Current" Channel and make sure to check "Ignore positional audio" -- (this will enable you to speak to everyone no matter how far away they are or what their settings are) Notes: - suggested Mumble settings (differing from defaults): -- advanced option "Link to Game and Transmit Position" activated (restart after setting this option) -- Maximum Distance: 70m -- Minimum Volume: 0% -- untick "Attenuate applications by..." "while other users talk" and "while you talk" - link delay: 10 seconds - normal link delay appears to be about 10 seconds after joining a minecraft server. This may vary depending on the PC. - starting order: as of v2.2 starting order does not matter, Minecraft or Mumble - either can be started first - Library locations: -- Libs should be located in --- .minecraft/mods/MumbleLink/natives/mod_MumbleLink.dll --- .minecraft/mods/MumbleLink/natives/mod_MumbleLink_x64.dll --- .minecraft/mods/MumbleLink/natives/libmod_MumbleLink.so --- .minecraft/mods/MumbleLink/natives/libmod_MumbleLink_x64.so --- .minecraft/mods/MumbleLink/natives/libmod_MumbleLink.dylib --- .minecraft/mods/MumbleLink/natives/libmod_MumbleLink_x64.dylib -- placing the Libs from "MumbleLink/natives" into the execution directory of your Minecraft executable will work as well Troubleshooting: - Please check the ModLoader.txt in your .minecraft-folder for an error message. -- messages from this mod will be indicated by "[MumbleLink{version}]" infront of the message - Errors will occur as "Minecraft has crashed!" -- This either indicates installation errors where libraries were placed into a wrong location -- or incompatibility to your operating system -- or you are using an outdate version of the mod -- check the error report or ModLoader.txt for details FAQ: - How do I know that I am linked/the mod works? After connecting to a Minecraft-Server (joining a game) Mumble's log will show a message "Minecraft linked." after a few seconds. Additionally within Minecraft you will see a chat message "Mumble linked." after you have joined any world. - Mumble does not Link: - in "ModLoader.txt" search for: "Mod Loaded: "mod_MumbleLink {version}" from mod_MumbleLink.class" - If this is missing the .class was either not copied to the correct location: .minecraft/mods/MumbleLink/mod_MumbleLink.class - or your do not have ModLoader installed. - Minecraft crashes with: "Minecraft has crashed! ... -- Head -- Stacktrace: at UpdateData.set(UpdateData.java:93) at mod_MumbleLink.onTickInGame(mod_MumbleLink.java:134) at ModLoader.onTick(ModLoader.java:1164) ..." - You are using an incompatible mod version. - Get the appropriated one from https://sourceforge.net/projects/modmumblelink/files/ "Minecraft has crashed! ... Minecraft has stopped running because it encountered a problem; Error in mod MumbleLink: Couldn't load library. ... java.lang.UnsatisfiedLinkError: Library files not found! Searched in: "C:\Users\zsawyer\AppData\Roaming\.minecraft\mods\MumbleLink\natives\" ..." - Libraries were not found in the expected locations. - the "Searched in"-path tells you where they were expected at - .minecraft/mods/MumbleLink/natives/mod_MumbleLink.dll - .minecraft/mods/MumbleLink/natives/mod_MumbleLink_x64.dll - .minecraft/mods/MumbleLink/natives/libmod_MumbleLink.so - .minecraft/mods/MumbleLink/natives/libmod_MumbleLink_x64.so - .minecraft/mods/MumbleLink/natives/libmod_MumbleLink.dylib - .minecraft/mods/MumbleLink/natives/libmod_MumbleLink_x64.dylib "Minecraft has crashed! ... Minecraft has stopped running because it encountered a problem; Error in mod MumbleLink: Couldn't load library. ... java.lang.UnsatisfiedLinkError: Required library could not be loaded, available libraries are incompatible! ..." - None of the found libraries can be loaded on your system. Your operating system is not supported by this mod. Sorry. Please try to compile the required libraries yourself or submit a request. (If you successfully compiled them yourself please share :D) - the ModLoader.txt sais: "SEVERE: [MumbleLink][SEVERE] Library files not found! Searched in: "C:\Users\Dr. Zoidberg\AppData\Roaming\.minecraft\mods\MumbleLink\natives\" Libraries were not found in the expected locations. - the "Searched in"-path tells you where they were expected at - .minecraft/mods/MumbleLink/natives/mod_MumbleLink.dll - .minecraft/mods/MumbleLink/natives/mod_MumbleLink_x64.dll - .minecraft/mods/MumbleLink/natives/libmod_MumbleLink.so - .minecraft/mods/MumbleLink/natives/libmod_MumbleLink_x64.so - .minecraft/mods/MumbleLink/natives/libmod_MumbleLink.dylib - .minecraft/mods/MumbleLink/natives/libmod_MumbleLink_x64.dylib "SEVERE: [MumbleLink][SEVERE] Required library could not be loaded, available libraries are incompatible!" None of the found libraries can be loaded on your system. Your operating system is not supported by this mod. Sorry. Please try to compile the required libraries yourself or submit a request. (If you successfully compiled them yourself please share :D) "FINER: Adding mods from C:\Users\zsawyer\AppData\Roaming\.minecraft\mods\MumbleLink.zip" This is due to the mod still being inside the .zip file. The mod needs to be unpacked. Therefore the mod_MumbleLink.class should be located at: .minecraft/mods/MumbleLink/mod_MumbleLink.class - Mumble sais "Minecraft linked." but I still don't hear people positionally. Multiple possibilities: 1. Mumble is not setup correctly: Make sure "Link to Game and Transmit Position" is checked (Configure -> Settings -> Tick "Advanced" -> "Plugins" -> Tick "Link to Game and Transmit Position") 2. The others are not using this mod. Get them to install it! - Minecraft has no sound/it is really low now this is probably due to Mumble itself, it will lower other applications' volumes on default In Mumble advanced settings, within "Audio Output" untick both: "Attenuate applications by..." "while other users talk" and "while you talk" - Minecraft simply stalls on the black screen and doesn't crash Make sure that the "META-INF"-folder has been removed from minecraft.jar (this is required for ModLoader to work) Tested Platforms: - Windows 7 Home Premium 64-bit Known Issues: - Does not work with PRMumble(0.5Beta) even after copying the link.dll (1.2.0) into PRMumble's plugin folder - it will say "linked" but the audio will not be positional (Deprecated since PR_Mumble1.0 is supported now :)) Change Log: v2.5.4 - updated for Minecraft 1.4.4 (+ MCP7.21 + ModLoader) v2.5.4 - updated for Minecraft 1.4.4 (+ MCP7.21 + ModLoader) - compatible with Minecraft 1.4.5 v2.5.3 - updated for Minecraft 1.4.2 (+ MCP7.19 + ModLoader) v2.5.2 - updated for Minecraft 1.3.2 (+ MCP7.2 + ModLoader (preliminary)) v2.5.1 - updated for Minecraft 1.3.1 (+ MCP7.0a + ModLoader) v2.5 - complete reworking of the code (unreleased) - using json to transport the mumble context - extended use of settings file, - mod_MumbleLink.conf - a simple text file that you can put into your minecraft execution directory - syntax follows a key value pair seperated by colon (:) per line - introduced new settings: - mumbleContext:[MinecraftAllTalk|world] - default: MinecraftAllTalk - specifies which group of players you belong to (which context you will use) - if the contexts of two players match then mumble will calculate positional audio - MinecraftAllTalk: a general, non-specific context saying "i am playing minecraft" - world: a world specific context, only players in the same world will hear each other positionally - libraryName:someFileName - default: mod_MumbleLink - you can specifiy to use a certain native library useful if there is a naming conflict - the mod will also try OSX, Windows and Unix as well as x64 specific filename variations if the file could not be found right away - libraryFolderPath:/some/folder/path/natives/ - default: none - you can specify which directory should be searched for the required native library files - useful when running minecraft from a custom directory v2.4.4 - updated for Minecraft 1.2.5 snapshot (+ MCP6.2 + ModLoader) v2.4.3 - updated for Minecraft 1.2.4 (+ MCP6.1 + ModLoader) v2.4.2 - updated for Minecraft 1.2.3 (+ MCP6.0 + ModLoader) v2.4.1 - updated for Minecraft 1.1 (+ MCP5.6 + ModLoader) v2.4 - updated for Minecraft 1.0.0 (+ MCP5.0 + ModLoader) - added: chat notification when linked v2.3.4 - update for MACOSX 64-Bit (added .dylib file) v2.3.3 - update for MACOSX 32-Bit (added .dylib file) v2.3.2 - recompiled with MCP3.1 + ModLoader v2.3.1 - update for Linux 64-Bit, updated and recompiled linux libraries (.so-files) v2.3 - using the mods-folder as supported by latest ModLoader v2.2.2 - updated for Minecraft beta 1.5_01 (+ MCP2.12_test1 + ModLoader) v2.2.1 - updated for Minecraft beta 1.4_01 (+ MCP2.11 + ModLoader) v2.2 - updated for Minecraft beta 1.4 (+ MCP2.10 + ModLoader) - fixed: starting order of Mumble vs Minecraft now does not matter - added: optional feature: world dependent linking (for future use) v2.1 - fixed some remnants of data corruption - Hotfix for WinXP32 EXCEPTION_ACCESS_VIOLATION (and possibly on other systems as well) v2.0 - fixed internal data corruption - added support for Ubuntu 10.10 32-bit (and possibly other distros) v1.1 - added 64-Bit Java support (new x64-bit DLL) - optimized DLLs - now there is no need for the msvcr100.dll -> removed - sources ready for release v1.0 - initial release (no sources) Additional: TheSkorm has forked this Project (v2.3.3, r72). https://github.com/TheSkorm/mod_mumblelink Acknowledgements: Mumble Team : Thanks for Mumble! Mojang : Thanks for Minecraft! The MCP Team : Thanks for Minecraft Coder Pack! Risugami : Thanks for ModLoader! SilentWalker : Thanks for testing on XP64, Ubuntu32 and other invaluable support. talkingBEERmug : Thanks for testing and decompiling the 128-bit encryption Steeve : Thanks for providing the Mumble-Server we tested on xDownSetx, Zebra: Thanks for helping with testing dalawrence : Thanks for providing the source code of a similar project (http://www.minecraftforum.net/viewtopic.php?f=1&t=41506) which helped in optimizing the DLLs and compiling for multiple platforms theskorm : Thanks for helping with compiling libraries for linux 64 bit and providing libs for MACOSX (and testing) and helping with recompiling/reobfuscating davr : Thanks for jumping in and helping with recompiling/reobfuscating