APercy/minetest-mumble-wrapper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make README more readable

Browse Source
This commit is contained in:
Bhish 2020-04-14 14:41:10 +01:00 committed by GitHub
parent c9d286d2ba
commit 63e2b6e696
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -8,29 +8,30 @@ For Windows Users: There is a prepackaged zip of minetest that has been configur
Installation Directions: Installation Directions:
Installation has 3 main components: 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. 1. Minetest Client Side Mod to expose the Coordinates to the Wrapper program.
3: Mumble to receive the infomarion and attenuate accordingly. 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. All instances of Minetest should be closed to prevent it from rewriting the config and undoing your installation progress.
1: Minetest Client Side Mod 1. Minetest Client Side Mod
1A: Download the Client Side Mod (henceforth referred to as CSM) from Releases: 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 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" 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" 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". 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" 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" 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" 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" 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. 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. 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. 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. With Minetest open, lauch or join any Minetest world or server.
Once you launch/join a world, the following message should appear in chat: 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." "!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. Note: The helpers are batch files and Windows only.
This zip file contains two batch files called "autoinstaller.bat"and "autolauncher.bat" This zip file contains two batch files called "autoinstaller.bat"and "autolauncher.bat"
To use the autoinstaller: 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.) 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\" 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. 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") 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 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. If it was unsucessful, install manually.
To use the autolauncher: 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. 1. If it's not there already, place the autolauncher.bat into the bin folder, along with the wrapper program.
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. 2. Rightclick to edit the file.
Running the autolauncher should start mumble and have it autojoin the correct channel, start minetest, and also close mumble once minetest is closed. 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.
I would recommend making a shortcut to the autolauncher and setting the icon/name if you use it often.
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.