{"id":15016097,"url":"https://github.com/zsawyer/mumblelink","last_synced_at":"2025-04-12T09:30:38.905Z","repository":{"id":15030981,"uuid":"17756796","full_name":"zsawyer/MumbleLink","owner":"zsawyer","description":"Minecraft + Mumble + MumbleLink = You hear where voices come from and how far away they are! This is a Minecraft mod based on \"Minecraft Forge\". It's purpose is to be able to use Minecraft in conjunction with Mumble's positional audio feature (http://mumble.sourceforge.net/).","archived":false,"fork":false,"pushed_at":"2023-01-24T22:27:00.000Z","size":12994,"stargazers_count":109,"open_issues_count":16,"forks_count":25,"subscribers_count":9,"default_branch":"QnD-MC_JNA","last_synced_at":"2024-11-07T12:02:18.050Z","etag":null,"topics":["foss","game","java","minecraft","minecraft-forge","minecraft-forge-mod","minecraft-mod","mumble","plugin","positional-audio","voip","voip-communications"],"latest_commit_sha":null,"homepage":"http://www.minecraftforum.net/topic/217587-","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"backus/guard-flay","license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zsawyer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-03-14T18:59:25.000Z","updated_at":"2024-08-25T14:25:31.000Z","dependencies_parsed_at":"2023-02-14T02:01:45.846Z","dependency_job_id":null,"html_url":"https://github.com/zsawyer/MumbleLink","commit_stats":null,"previous_names":[],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zsawyer%2FMumbleLink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zsawyer%2FMumbleLink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zsawyer%2FMumbleLink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zsawyer%2FMumbleLink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zsawyer","download_url":"https://codeload.github.com/zsawyer/MumbleLink/tar.gz/refs/heads/QnD-MC_JNA","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223510342,"owners_count":17157306,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["foss","game","java","minecraft","minecraft-forge","minecraft-forge-mod","minecraft-mod","mumble","plugin","positional-audio","voip","voip-communications"],"created_at":"2024-09-24T19:48:24.101Z","updated_at":"2024-11-07T12:03:24.924Z","avatar_url":"https://github.com/zsawyer.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![](http://cf.way2muchnoise.eu/short_mumblelink_downloads.svg)](https://www.curseforge.com/minecraft/mc-mods/mumblelink/files)\n[![](http://cf.way2muchnoise.eu/versions/mumblelink_all.svg)](https://www.curseforge.com/minecraft/mc-mods/mumblelink/files)\n[![](http://cf.way2muchnoise.eu/packs/short_mumblelink.svg)](https://www.curseforge.com/minecraft/mc-mods/mumblelink/files)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"MumbleLink Logo\" src=\"doc/images/2011-03-23_07.19.05.png\" width=\"80%\"\u003e\n\u003c/p\u003e\n\n# About:\n\n***Minecraft + Mumble + MumbleLink = You hear where voices come from and how far away they are!***\n\nThis is a **client-side Minecraft mod based on \"Minecraft Forge\"**. It's purpose is to be able to use Minecraft in conjunction **with [Mumble](https://mumble.info)**'s positional audio feature.\n\nThis means: Directional and positionally attenuated VOIP in relation to the game world.\n\nThere is also a corresponding [Minecraft Forum thread](http://www.minecraftforum.net/topic/217587-).\n\n\n# Prerequisites:\n\n* [Minecraft Java Edition](https://www.minecraft.net)\n* [Minecraft Forge](https://files.minecraftforge.net/)\n* [Mumble](https://mumble.info)\n  * advanced option \"Link to Game and Transmit Position\" activated  \n     (Configure -\u003e Settings -\u003e Tick \"Advanced\" -\u003e \"Plugins\"\n        -\u003e Tick \"Link to Game and Transmit Position\")\n\n\n# Installing the Mod:\n\n1. Close both Mumble and Minecraft.\n2. install Minecraft Forge\n3. Put the MumbleLink-x.y.jar into your mods folder (DO NOT EXTRACT THE JAR!)  \n    examples:  \n    * Windows: %Appdata%\\.minecraft\\mods\\MumbleLink-x.y.jar  \n    * Linux: ~/.minecraft/mods/MumbleLink-x.y.jar  \n4. setup Mumble:  \n    ![screenshot of settings with indicators for steps 1 to 3](doc/screenshots/mumble_settings_required_1-3.png)  \n    1. On Mumble's main screen select Configure -\u003e Settings\n    2. In Mumble Configuration dialog enable \"Advanced\" (bottom left)\n    3. In Plugins: \n        1. Options section: enable \"Link to Game and Transmit Position\",\n                            if this was disabled, restart after setting this option\n        2. in Plugins section: find and enable \"Link v1.2.0\"\n    4. In Audio Output:  \n\t    ![screenshot of settings with indicators for step 4](doc/screenshots/mumble_settings_required_4.png)  \n        1. in Positional Audio section: enable Positional Audio´\n    5. optional advanced Mumble settings can be found further [below](#advanced-mumble-configuration)\n\n\n# Upgrading from earlier Versions:\n\n1. Close both Mumble and Minecraft.\n2. install latest Minecraft Forge\n3. replace the old MumbleLink-jar with the new one!\n\n\n# Advanced Mumble Configuration\n\nInstead of hearing people from indefinitely far away you can set up mumble to\nonly hear them when they are close. In return you (and they!) will need to bind\nan extra key to communicate with those far away (imagine it being a\n\"walkie-talkie\" button).  \nTo set this up you will need to do some special settings which differ from the\ndefaults, in return it might enhance your audio experience.  \n\n1. In Audio Output:  \n\t![screenshot of optional settings with indicators for step 1](doc/screenshots/mumble_settings_optional_1.png)    \n\t1. Positional Audio section: Maximum Distance: 70m   \n\t\t(this value will determine when others are too far away to be heard)  \n\t2. Positional Audio section: Minimum Volume: 0%  \n\t\t(this value makes you not hear people beyond Maximum Distance)  \n\t3. Audio Output section: disable \"Attenuate applications by... \" \"while other users talk\" and \"while you talk\"   \n\t\t(mumble would dampen ArmA's audio if enabled)\n2. In Shortcuts   \n\t![screenshot of optional settings with indicators for step 2](doc/screenshots/mumble_settings_optional_2_short.png)  \n\t1. bind a key (\"Shortcut\") to \"Shout/Wisper\" \"Shout to Channel\" select \"Current\" Channel and make sure to check \"Ignore positional audio\"   \n\t\t(this will enable you to speak to everyone no matter how far away they are or what their settings are)  \n\n\n# Notes:\n\n* suggested Mumble settings (differing from defaults):  \n  * advanced option \"Link to Game and Transmit Position\" activated\n    (restart after setting this option)\n  * Maximum Distance: 70m\n  * Minimum Volume: 0%\n  * untick \"Attenuate applications by...\" \"while other users talk\" and \"while you talk\"\n* link delay: 10 seconds - normal link delay appears to be about 10 seconds after\n    joining a minecraft server. This may vary depending on the PC. The confirmation\n    that the plugin linked can however show before the effect kicks in.\n* starting order: does not matter  \n    Minecraft or Mumble - either can be started first\n\n\n# Mod-Packs:\n\nGenerally you are free to distribute it with your private (or public, or commercial) mod-packs as specified by LGPLv3.  \nThat being said, it virtually means no restrictions apply except that you should inform users that your mod-pack contains this mod and that it is licensed under LGPLv3.\n\nFeel free to drop a note [on the forum](http://www.minecraftforum.net/topic/217587-) that your pack contains this mod. It might give you some more users and I simply am curious to see where it is used (totally optional!).\n\n\n\n# Developing Addons for this Mod:\n\n* Please also refer to changelog of v4.0.2 and the source code comments.\n* The interface [`MumbleLinkAPI`](https://github.com/zsawyer/MumbleLink/blob/QnD-MC_JNA/mod/src/main/java/zsawyer/mods/mumblelink/api/MumbleLinkAPI.java) allows your addon to inject their custom Mumble\n    context and/or identity. Use this interface to register your callback\n    function handlers. You will have to implement the callback interfaces. It is\n    suggested that your addon implements the \"Activatable\" interface to allow\n    other (child) addons to disable your handlers and thus overriding/replacing\n    them. This is neccessary since the context and identity fields have a very\n    limited length.  \n* The [`ExtendedPASupport`](https://github.com/zsawyer/MumbleLink/blob/QnD-MC_JNA/mod/src/main/java/zsawyer/mods/mumblelink/addons/pa/es/ExtendedPASupport.java) mod should serve as a sample implementation.  \n* Please note the javadoc of these files.  \n* For more information about context and identity consult [mumble's doc](https://wiki.mumble.info/wiki/Link#Context). \n        \n\n\n# Troubleshooting:\n\n* Please check the logs in your .minecraft-folder for an error message.  \n      for Forge: fml-client-latest.log  \n  * messages from this mod will be indicated by \"[MumbleLink]\" infront of the message  \n* Errors will occur as \"Minecraft has crashed!\"  or a black window\n  * This either indicates incompatibility to your operating system\n  * or you are using an outdated version of the mod\n  * check the error report or log files (s.a.) for details\n\n\n\n# FAQ:\n\n#### How do I know that I am linked/the mod works?\n After connecting to a Minecraft-Server (joining a game) Mumble's log will\n    show a message \"Minecraft linked.\" after a few seconds. Additionally\n    within Minecraft you will see a chat message \"Mumble linked.\" after you have\n    joined any world.\n\t\n#### Mumble does not Link:\ncheck the logs and check for MumbleLink (Forge)  \n  * you might not have Forge installed\n  * note that Risugami's ModLoader is not supported anymore\n\t\t\n#### Minecraft crashes:\n```log\n    \"Minecraft has crashed!\n    ...\n    java.lang.NoSuchFieldError: g\n        at UpdateData.set(UpdateData.java:XXX)\n    ...\"\n```\nOR\n```log\n    \"Minecraft has crashed!\n    ...\n    -- Head --\n    Stacktrace:\n        at UpdateData.set(UpdateData.java:XXX)\n    ...\"\n        - You are using an incompatible mod version.\n        - Get the appropriated one from https://sourceforge.net/projects/modmumblelink/files/\n        - there might not be one yet if you just updated Minecraft\n\n\n    \"Minecraft has crashed!\n    ...\n    Minecraft has stopped running because it encountered a problem; Error in mod\n    MumbleLink: Couldn't load library.\n    ...\n    java.lang.UnsatisfiedLinkError: ...\"\n```\nNone of the found libraries can be loaded on your system. Your operating\n            system is not supported by this mod. Sorry!  \n            Please try to compile the required libraries ([mumble-LinkAPI](https://github.com/zsawyer/mumble-LinkAPI)) yourself or submit a\n            request. (If you successfully compiled them yourself please share :D)\n\n\n#### the log sais:\n```log\n    \"SEVERE: [MumbleLink][SEVERE] Required library could not be loaded,\n            available libraries are incompatible!\"\n```\nNone of the found libraries can be loaded on your system. Your operating\n            system is not supported by this mod. Sorry!  \n            Please try to compile the required libraries ([mumble-LinkAPI](https://github.com/zsawyer/mumble-LinkAPI)) yourself or submit a\n            request. (If you successfully compiled them yourself please share :D)\n\n\n#### Mumble sais \"Minecraft linked.\" but I still don't hear people positionally.\nMultiple possibilities:  \n1. Mumble is not setup correctly:  \n\tMake sure \"Link to Game and Transmit Position\" is checked  \n\t\t(Configure -\u003e Settings -\u003e Tick \"Advanced\" -\u003e \"Plugins\"\n\t\t\t-\u003e Tick \"Link to Game and Transmit Position\")\n2. The others are not using this mod. Get them to install it! ;)\n\n\n#### Minecraft has no sound/it is really low now\nThis is probably due to Mumble itself, it will lower other applications'\nvolumes by default.  \nIn Mumble advanced settings, within \"Audio Output\" untick both:  \n\t\"Attenuate applications by...\" \"while other users talk\"\n\tand \"while you talk\"\n\n\n#### No Linking when using Flatpack on Unix\nMinecraft Flatpack needs additional permissions: \n1. on the command prompt run `flatpak override --user --device=shm com.mojang.Minecraft` \n2. restart the Minecraft Flatpak if it was already running \n\nReason: The Mumble Link works via SHM and `/dev/shm` is by default sandboxed by Flatpak.\n\n\n# Known Issues:\n\n- Does not work with MicDoodleCore. Libraries will not be loading properly.  \n  - A workaround is described in the forum thread. \n  \n\n# For Techies:\n\nIt uses the **Mumble Link Plugin v1.2.0** and adds native mumble support.  \nTested with Mumble 1.2.2 - 1.2.4 and PR_Mumble1.0.\n\nIt also uses [**JNA**](https://github.com/twall/jna).\nThere is an interface that other mods can use to inject their custom Mumble\ncontext and/or identity.\n\nThe native libraries were originally build at [mumble-LinkAPI](https://github.com/zsawyer/mumble-LinkAPI)\n\n\n# Additional:\n\nThis project is present at both SourceForge and GitHub. The main development will be done using GitHub but the distribution is done through SourceForge.  \n\nThere are multiple Forks. \n\nAlso similar projects which deserve an honorable mention: \n- https://github.com/magneticflux-/fabric-mumblelink-mod does the same as this project but has a different implementation\n\n\n# Acknowledgements:\n\nThanks for the community keeping this project alive and providing support and updates!\n\nContributor     | Acknowledgement\n----------------|----------------\nMumble Team     | Thanks for Mumble!  \nMojang          | Thanks for Minecraft!  \nThe MCP Team    | Thanks for Minecraft Coder Pack!  \nForge Team      | Thanks for Forge!  \nAbrarSyed       | Thanks for ForgeGradle!  \nSilentWalker    | Thanks for testing on XP64, Ubuntu32 and other invaluable support.  \ntalkingBEERmug  | Thanks for testing and decompiling the 128-bit encryption  \nSteeve          | Thanks for providing the Mumble-Server we tested on  \nxDownSetx, Zebra| Thanks for helping with testing  \ndalawrence      | Thanks for providing the source code of a [similar project](http://www.minecraftforum.net/viewtopic.php?f=1\u0026t=41506) which helped in optimizing the DLLs and compiling for multiple platforms  \ntheskorm        | Thanks for helping with compiling libraries for linux 64 bit and providing libs for MACOSX (and testing) and helping with recompiling/reobfuscating  \ndavr            | Thanks for jumping in and helping with recompiling/reobfuscating  \ntwall           | Thanks for JNA!  \niSuchtel        | Thanks for helping with compiling the universal dylib for OSX  \nRobijnvogel     | Thanks for keeping this mod alive while I was away.\nmagneticflux-   | Thanks for keeping this mod alive while I was away.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzsawyer%2Fmumblelink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzsawyer%2Fmumblelink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzsawyer%2Fmumblelink/lists"}