From b8e4b33e93e9a5201b30720d1194341ed48dd5c3 Mon Sep 17 00:00:00 2001 From: Elkien3 Date: Sat, 28 Mar 2020 11:40:10 -0500 Subject: [PATCH 1/7] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 72e4d55..83c158c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Tutorial: https://www.youtube.com/watch?v=0rk-004yLyk For Windows Users: There is a prepackaged zip of minetest that has been configured for use with mumble in Releases, this the easiest way to get set, if you don't mind a fresh install. Also see minetest-mumble-helpers for installing on an existing install if minetest. Installation Directions: -Install the csm (/minetestmod/mumble/) or minetest-mumble-CSM.zip in releases. +Install the Client Side Mod (CSM) (/minetestmod/mumble/) or minetest-mumble-CSM.zip in releases. For more information of how to install Client Side Mods https://wiki.minetest.net/Installing_Client-Side_Mods Start mumble, the handler may have an error otherwise. Make sure Positional Audio and Link is enabled in Settings -> Audio Output and Settings -> Plugins. (Both need advanced options to be shown.) Run the executable (in the releases) with the minetest program as an argument. (can be done easily with shortcuts in windows, and .sh files in linux) It will also search in it's current directory for minetest, as well as /usr/bin/, usr/games/, C:/Program Files/minetest/bin/, and C:/Program Files (x86)/minetest/bin/ so you may not have to pass the path directly as an argument. @@ -33,4 +33,4 @@ To use the autolauncher: 2: Rightclick to edit the file. 3: Ensure the paths to the Mumble executable and the name of the wrapper program is correct. Note: the /min in front of the mumble path makes mumble start minimized, if you don't like this, you can delete it. Running the autolauncher should start mumble and have it autojoin the correct channel, start minetest, and also close mumble once minetest is closed. - I would recommend making a shortcut to the autolauncher and setting the icon/name if you use it often. \ No newline at end of file + I would recommend making a shortcut to the autolauncher and setting the icon/name if you use it often. From 1676288d3f0fa34c7fd3fdcf459cf3cb7ee3bca1 Mon Sep 17 00:00:00 2001 From: Elkien3 Date: Sat, 28 Mar 2020 11:40:35 -0500 Subject: [PATCH 2/7] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 83c158c..37ca31a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ Tutorial: https://www.youtube.com/watch?v=0rk-004yLyk For Windows Users: There is a prepackaged zip of minetest that has been configured for use with mumble in Releases, this the easiest way to get set, if you don't mind a fresh install. Also see minetest-mumble-helpers for installing on an existing install if minetest. Installation Directions: -Install the Client Side Mod (CSM) (/minetestmod/mumble/) or minetest-mumble-CSM.zip in releases. For more information of how to install Client Side Mods https://wiki.minetest.net/Installing_Client-Side_Mods +Install the Client Side Mod (CSM) (/minetestmod/mumble/) or minetest-mumble-CSM.zip in releases. For more information of how to install Client Side Mods: https://wiki.minetest.net/Installing_Client-Side_Mods + Start mumble, the handler may have an error otherwise. Make sure Positional Audio and Link is enabled in Settings -> Audio Output and Settings -> Plugins. (Both need advanced options to be shown.) Run the executable (in the releases) with the minetest program as an argument. (can be done easily with shortcuts in windows, and .sh files in linux) It will also search in it's current directory for minetest, as well as /usr/bin/, usr/games/, C:/Program Files/minetest/bin/, and C:/Program Files (x86)/minetest/bin/ so you may not have to pass the path directly as an argument. From 5d97a89bffa95423d666aaa4aa1a03e4ab480cb4 Mon Sep 17 00:00:00 2001 From: Elkien3 Date: Sat, 28 Mar 2020 11:41:07 -0500 Subject: [PATCH 3/7] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 37ca31a..633d59b 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,13 @@ Tutorial: https://www.youtube.com/watch?v=0rk-004yLyk For Windows Users: There is a prepackaged zip of minetest that has been configured for use with mumble in Releases, this the easiest way to get set, if you don't mind a fresh install. Also see minetest-mumble-helpers for installing on an existing install if minetest. Installation Directions: -Install the Client Side Mod (CSM) (/minetestmod/mumble/) or minetest-mumble-CSM.zip in releases. For more information of how to install Client Side Mods: https://wiki.minetest.net/Installing_Client-Side_Mods +Install the Client Side Mod (CSM) (/minetestmod/mumble/) or minetest-mumble-CSM.zip in releases. +For more information of how to install Client Side Mods: https://wiki.minetest.net/Installing_Client-Side_Mods Start mumble, the handler may have an error otherwise. Make sure Positional Audio and Link is enabled in Settings -> Audio Output and Settings -> Plugins. (Both need advanced options to be shown.) Run the executable (in the releases) with the minetest program as an argument. (can be done easily with shortcuts in windows, and .sh files in linux) It will also search in it's current directory for minetest, as well as /usr/bin/, usr/games/, C:/Program Files/minetest/bin/, and C:/Program Files (x86)/minetest/bin/ so you may not have to pass the path directly as an argument. -After a few seconds after joining a world the terminal for the handler/minetest should go a bit crazy, outputting your players location and heading. If it dosn't, the csm probably isn't correctly installed. +After a few seconds after joining a world the terminal for the handler/minetest should go a bit crazy, outputting your players location and heading. If it dosn't, the csm probably isn't correctly installed, see https://wiki.minetest.net/Installing_Client-Side_Mods After that Mumble should say in it's chat "Minetest linked" If it dosn't, double check your Mumble settings and make sure Positional Audio is enabled both in Settings -> Audio Output and Settings -> Plugins. You may want to change the Positional Audio settings in Mumble in Audio Output (needs advanced settings to be visible.) From 6ec707fe173751d5aa54437439dce603267fe373 Mon Sep 17 00:00:00 2001 From: Elkien3 Date: Sat, 28 Mar 2020 11:41:23 -0500 Subject: [PATCH 4/7] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 633d59b..6470bd4 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ Start mumble, the handler may have an error otherwise. Make sure Positional Audi Run the executable (in the releases) with the minetest program as an argument. (can be done easily with shortcuts in windows, and .sh files in linux) It will also search in it's current directory for minetest, as well as /usr/bin/, usr/games/, C:/Program Files/minetest/bin/, and C:/Program Files (x86)/minetest/bin/ so you may not have to pass the path directly as an argument. After a few seconds after joining a world the terminal for the handler/minetest should go a bit crazy, outputting your players location and heading. If it dosn't, the csm probably isn't correctly installed, see https://wiki.minetest.net/Installing_Client-Side_Mods + After that Mumble should say in it's chat "Minetest linked" If it dosn't, double check your Mumble settings and make sure Positional Audio is enabled both in Settings -> Audio Output and Settings -> Plugins. You may want to change the Positional Audio settings in Mumble in Audio Output (needs advanced settings to be visible.) From c9d286d2baeba8d77d96f603193aaa2e74174335 Mon Sep 17 00:00:00 2001 From: Elkien3 Date: Sun, 5 Apr 2020 11:26:49 -0500 Subject: [PATCH 5/7] improve CSM installation directions --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6470bd4..bec2b24 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,36 @@ Tutorial: https://www.youtube.com/watch?v=0rk-004yLyk For Windows Users: There is a prepackaged zip of minetest that has been configured for use with mumble in Releases, this the easiest way to get set, if you don't mind a fresh install. Also see minetest-mumble-helpers for installing on an existing install if minetest. Installation Directions: -Install the Client Side Mod (CSM) (/minetestmod/mumble/) or minetest-mumble-CSM.zip in releases. -For more information of how to install Client Side Mods: https://wiki.minetest.net/Installing_Client-Side_Mods + +Installation has 3 main components: + 1: Minetest Client Side Mod to expose the Coordinates to the Wrapper program. + 2: Wrapper program to take the Coordinates from Minetest and send them to Mumble. + 3: Mumble to receive the infomarion and attenuate accordingly. + +All instances of Minetest should be closed to prevent it from rewriting the config and undoing your installation progress. + + 1: Minetest Client Side Mod + 1A: Download the Client Side Mod (henceforth referred to as CSM) from Releases: + https://github.com/Elkien3/minetest-mumble-wrapper/releases/download/0.2/minetest-mumble-CSM.zip + 1B: Extract the zip into your Minetest's "clientmods" folder. + The folder tree on Windows or other run-in-place install should be "minetest-v.v.v/clientmods/mumble/init.lua" + On Linux or other non run-in-place it should be "/home/[user]/.minetest/clientmods/mumble/init.lua" + 1C: Edit the mods.conf in the "clientmods" folder and add "load_mod_mumble = true" to the bottom of the file. + If there is no mods.conf file in "clientmods" you can create one by adding a text file and renaming it to "mods.conf". + Ensure file extensions are enabled in the "View" toolbar, so you will see "New Text Document.txt" instead of just "New Text Document" + If Minetest was run since you extracted the CSM, you may see "load_mod_mumble = false" already in mods.conf, in that case just change "load_mod_mumble = false" to "load_mod_mumble = true" + 1D: Enable Client Side Modding in Minetest Config: + For this step you can open Minetest, then go into the Settings tab. Click on "All Settings" + There will be a search bar on the top of the list, search for "Client Modding" + Locate the "Client Modding" setting, and set it to Enabled. + Optional: The CSM writes to the Minetest log all of your player's coordinates and view direction, this can cause your debug.txt to become very large, so it's recommended you stop Minetest from saving logs to file. + Search "log level" in all settings, double click the setting, and set it to blank to disable logging text to file. + 1E: Double check that the CSM is being loaded: + With Minetest open, lauch or join any Minetest world or server. + Once you launch/join a world, the following message should appear in chat: + "!Mumble loaded! This mod uses print() to send ingame positional data, so your debug.txt may get quite large, and it's recommended to set debug_log_level to nothing if you haven't already." + If this message does not appear, ensure you have the latest version of the CSM and redo steps 1A-1E. + For more information of how to install Client Side Mods: https://wiki.minetest.net/Installing_Client-Side_Mods Start mumble, the handler may have an error otherwise. Make sure Positional Audio and Link is enabled in Settings -> Audio Output and Settings -> Plugins. (Both need advanced options to be shown.) Run the executable (in the releases) with the minetest program as an argument. (can be done easily with shortcuts in windows, and .sh files in linux) From 63e2b6e696463f1c7e5ed0c06da5db0d2abd88d4 Mon Sep 17 00:00:00 2001 From: Bhish Date: Tue, 14 Apr 2020 14:41:10 +0100 Subject: [PATCH 6/7] Make README more readable --- README.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index bec2b24..6ad3cd8 100644 --- a/README.md +++ b/README.md @@ -8,29 +8,30 @@ For Windows Users: There is a prepackaged zip of minetest that has been configur Installation Directions: Installation has 3 main components: - 1: Minetest Client Side Mod to expose the Coordinates to the Wrapper program. - 2: Wrapper program to take the Coordinates from Minetest and send them to Mumble. - 3: Mumble to receive the infomarion and attenuate accordingly. + + 1. Minetest Client Side Mod to expose the Coordinates to the Wrapper program. + 2. Wrapper program to take the Coordinates from Minetest and send them to Mumble. + 3. Mumble to receive the infomarion and attenuate accordingly. All instances of Minetest should be closed to prevent it from rewriting the config and undoing your installation progress. - 1: Minetest Client Side Mod - 1A: Download the Client Side Mod (henceforth referred to as CSM) from Releases: +1. Minetest Client Side Mod + 1. Download the Client Side Mod (henceforth referred to as CSM) from Releases: https://github.com/Elkien3/minetest-mumble-wrapper/releases/download/0.2/minetest-mumble-CSM.zip - 1B: Extract the zip into your Minetest's "clientmods" folder. + 1. Extract the zip into your Minetest's "clientmods" folder. The folder tree on Windows or other run-in-place install should be "minetest-v.v.v/clientmods/mumble/init.lua" On Linux or other non run-in-place it should be "/home/[user]/.minetest/clientmods/mumble/init.lua" - 1C: Edit the mods.conf in the "clientmods" folder and add "load_mod_mumble = true" to the bottom of the file. + 1. Edit the mods.conf in the "clientmods" folder and add "load_mod_mumble = true" to the bottom of the file. If there is no mods.conf file in "clientmods" you can create one by adding a text file and renaming it to "mods.conf". Ensure file extensions are enabled in the "View" toolbar, so you will see "New Text Document.txt" instead of just "New Text Document" If Minetest was run since you extracted the CSM, you may see "load_mod_mumble = false" already in mods.conf, in that case just change "load_mod_mumble = false" to "load_mod_mumble = true" - 1D: Enable Client Side Modding in Minetest Config: + 1. Enable Client Side Modding in Minetest Config: For this step you can open Minetest, then go into the Settings tab. Click on "All Settings" There will be a search bar on the top of the list, search for "Client Modding" Locate the "Client Modding" setting, and set it to Enabled. Optional: The CSM writes to the Minetest log all of your player's coordinates and view direction, this can cause your debug.txt to become very large, so it's recommended you stop Minetest from saving logs to file. Search "log level" in all settings, double click the setting, and set it to blank to disable logging text to file. - 1E: Double check that the CSM is being loaded: + 1. Double check that the CSM is being loaded: With Minetest open, lauch or join any Minetest world or server. Once you launch/join a world, the following message should appear in chat: "!Mumble loaded! This mod uses print() to send ingame positional data, so your debug.txt may get quite large, and it's recommended to set debug_log_level to nothing if you haven't already." @@ -53,15 +54,19 @@ minetest-mumble-helpers: Note: The helpers are batch files and Windows only. This zip file contains two batch files called "autoinstaller.bat"and "autolauncher.bat" To use the autoinstaller: - 1: Download and unzip the minetest-mumble-helpers.zip file into your minetest directory: where the "bin", "clientmods", and "mods" folders are.) - 2: Unzip the file in place, not creating a new directory. (for 7zip use "Extract Here") Should be something like "Extract to C:\Path\To\minetest-5.0.1-win64\" NOT "Extract to C:\Path\To\minetest-5.0.1-win64\minetest-mumble-helpers\" - 3: Ensure the files were extracted correctly: all the contents should be visible from the main minetest folder. Also close any Minetest sessions running, as they may interfere with the autoinstaller's config writing. - 4: Run autoinstaller.bat, Windows may ask you if you want to run it, (perhaps even say that it could be malware) so let it run. (if you wish to see what you are doing by running the autoinstaller, rightclick it and select "edit") + 1. Download and unzip the minetest-mumble-helpers.zip file into your minetest directory: where the "bin", "clientmods", and "mods" folders are.) + 2. Unzip the file in place, not creating a new directory. (for 7zip use "Extract Here") Should be something like "Extract to C:\Path\To\minetest-5.0.1-win64\" NOT "Extract to C:\Path\To\minetest-5.0.1-win64\minetest-mumble-helpers\" + 3. Ensure the files were extracted correctly: all the contents should be visible from the main minetest folder. Also close any Minetest sessions running, as they may interfere with the autoinstaller's config writing. + 4. Run autoinstaller.bat, Windows may ask you if you want to run it, (perhaps even say that it could be malware) so let it run. (if you wish to see what you are doing by running the autoinstaller, rightclick it and select "edit") The autoinstaller should have moved the files to the correct positions and updated your Minetest settings. This should take care of all minetest related setup for mumble PA if sucessful If it was unsucessful, install manually. + To use the autolauncher: - 1: If it's not there already, place the autolauncher.bat into the bin folder, along with the wrapper program. - 2: Rightclick to edit the file. - 3: Ensure the paths to the Mumble executable and the name of the wrapper program is correct. Note: the /min in front of the mumble path makes mumble start minimized, if you don't like this, you can delete it. - Running the autolauncher should start mumble and have it autojoin the correct channel, start minetest, and also close mumble once minetest is closed. - I would recommend making a shortcut to the autolauncher and setting the icon/name if you use it often. + +1. If it's not there already, place the autolauncher.bat into the bin folder, along with the wrapper program. +2. Rightclick to edit the file. +3. Ensure the paths to the Mumble executable and the name of the wrapper program is correct. Note: the /min in front of the mumble path makes mumble start minimized, if you don't like this, you can delete it. + +Running the autolauncher should start mumble and have it autojoin the correct channel, start minetest, and also close mumble once minetest is closed. + +I would recommend making a shortcut to the autolauncher and setting the icon/name if you use it often. From 7a7fea3ee8bfa0748f9a0fbfe5323874dc9a8e55 Mon Sep 17 00:00:00 2001 From: Bhish Date: Wed, 15 Apr 2020 15:33:12 +0100 Subject: [PATCH 7/7] Update README.md Sorry, I missed the list on the auto-installer --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6ad3cd8..68b1a88 100644 --- a/README.md +++ b/README.md @@ -54,11 +54,13 @@ minetest-mumble-helpers: Note: The helpers are batch files and Windows only. This zip file contains two batch files called "autoinstaller.bat"and "autolauncher.bat" To use the autoinstaller: - 1. Download and unzip the minetest-mumble-helpers.zip file into your minetest directory: where the "bin", "clientmods", and "mods" folders are.) - 2. Unzip the file in place, not creating a new directory. (for 7zip use "Extract Here") Should be something like "Extract to C:\Path\To\minetest-5.0.1-win64\" NOT "Extract to C:\Path\To\minetest-5.0.1-win64\minetest-mumble-helpers\" - 3. Ensure the files were extracted correctly: all the contents should be visible from the main minetest folder. Also close any Minetest sessions running, as they may interfere with the autoinstaller's config writing. - 4. Run autoinstaller.bat, Windows may ask you if you want to run it, (perhaps even say that it could be malware) so let it run. (if you wish to see what you are doing by running the autoinstaller, rightclick it and select "edit") - The autoinstaller should have moved the files to the correct positions and updated your Minetest settings. This should take care of all minetest related setup for mumble PA if sucessful + +1. Download and unzip the minetest-mumble-helpers.zip file into your minetest directory: where the "bin", "clientmods", and "mods" folders are.) +2. Unzip the file in place, not creating a new directory. (for 7zip use "Extract Here") Should be something like "Extract to C:\Path\To\minetest-5.0.1-win64\" NOT "Extract to C:\Path\To\minetest-5.0.1-win64\minetest-mumble-helpers\" +3. Ensure the files were extracted correctly: all the contents should be visible from the main minetest folder. Also close any Minetest sessions running, as they may interfere with the autoinstaller's config writing. +4. Run autoinstaller.bat, Windows may ask you if you want to run it, (perhaps even say that it could be malware) so let it run. (if you wish to see what you are doing by running the autoinstaller, rightclick it and select "edit") + +The autoinstaller should have moved the files to the correct positions and updated your Minetest settings. This should take care of all minetest related setup for mumble PA if sucessful If it was unsucessful, install manually. To use the autolauncher: