## Mumble Positional Audio for Valheim

**Not official or endorsed in any way by IronGate**

This is a BepInEx plugin that feeds Mumble character and camera data from the
game to use in its positional audio system.

### Installation

[Video walkthrough courtesy of Freedom.4x4](https://www.youtube.com/watch?v=6LcEDtsmIlM&feature=youtu.be)

#### All In One

Do this if you have a completely unmodded Valheim install and you don't want
to mess with installing BepInEx (the loader/modding framework) separately.

Get the "AllInOne" package from [Releases][releases]. Extract it into your
Valheim install directory. You're done!

#### Separate BepInEx Package

If you've already got another BepInEx mod installed, or you just want the
experience of installing the loader and mod separately, take this approach.

First, you're going to need BepInEx for Valheim. If you've already installed
another mod that uses it, you can skip this step. You can get it from the
[Releases][releases] page, or from
[here](https://valheim.thunderstore.io/package/denikson/BepInExPack_Valheim/).
Follow the instructions. Note: if you're using Linux, you'll need the version
from Releases. It includes the necessary script to start Valheim with
BepInEx. You'll also need to follow the extra Steam setup described
[here](https://bepinex.github.io/bepinex_docs/master/articles/user_guide/installation/index.html#installing-bepinex-1).

Once BepInEx is installed, head over to [Releases][releases] and grab the
latest zip. Extract it into your Valheim install directory.

[releases]: https://gitlab.com/jrobsonchase/valheimpositionalaudio/-/releases

### Usage

First start Mumble. If you haven't already, enable positional audio in
Configure -> Settings -> Audio Output -> Interface. You also need to check
"Link to Game and Transmit position" in Configure -> Settings -> Plugins ->
Options.

When Valheim starts with BepInEx, you should see a terminal with
Unity/BepInEx logs. You should see a line that says `Mumble Link Loaded` when
the plugin gets initialized. It won't do anything else until you join a game.
Once your character loads, you should see `Mumble Shared Memory Initialized`
in the logs. In the Mumble messages panel on the left side, you should now
see "Valheim Linked."

Now, two people on the same server should hear each others' voices coming
from their characters' location. You can also tweak the Positional Audio
settings in Audio Output to make it more realistic with regard to volume
dropoff over distance. Setting Minimum Distance to 1m, Maximum Distance to
50m, and Minimum Volume to 0% works well in my experience.

#### Global Voice Key

By default, T is bound to "Global Voice." This changes your mumble context
such that your voice (and everyone else's from your perspective) are no
longer directional. Use it if you want a "viking walkie-talkie" of sorts. It
can be configured via the the file generated in `BepInEx/config/` file, or
with [BepInEx.ConfigurationManager][configmanager].

[configmanager]: https://github.com/BepInEx/BepInEx.ConfigurationManager

### Troubleshooting

First, make sure BepInEx works. On Windows, you should get a terminal with
logs when you start Valheim. On Linux, you should see logs in
`BepInEx/LogOutput.log`. Next, make sure you see the startup message for
PositionalAudio.

Unfortunately, I haven't found a great way to debug the data being read by
Mumble. There might be a way to get it to log everything it reads, but I
haven't found it yet.

If things still aren't working, toss me an issue and I'll see if I can help
fix it.