refactor(resonite): Clarify and format issues and resolutions better.

content/docs/resonite/_index.md

@@ -39,35 +39,40 @@ It is recommended that you use PipeWire as your system's audio service, includin
 
 The game will default to the PipeWire API if it can, falling back to the PulseAudio API.
 
-### Crackling microphone
+### Crackling Microphone Audio
 
-Unfortunately, it seems that **every WiVRn user** experiences crackling mic issues by default before manually switching to the legacy ALSA driver:
+Currently there is an issue in Resonite for WiVRn users which results in their microphone audio becoming crackly / glitchy to others. In order to solve this issue one must adjust their pipewire sample rates as well as set Resonite to use the ALSA SDL audio backend.
 
-1. Force Resonite to use ALSA:
+Steps are as follows:
 
-Add the following to Resonite's Launch Options: 
+**NOTE:** If you have already set launch arguments for Resonite, simply add `SDL_AUDIO_DRIVER=alsa` next to other env var in your launch arguments.
-````SDL_AUDIO_DRIVER=alsa %command%````
 
-**Note:** If you already have `%command%` in your launch arguments, simply add `SDL_AUDIO_DRIVER=alsa` **before** it. Continue with step 2.
+1. Force Resonite to use ALSA SDL backend for audio:
 
-2. Configure PipeWire for legacy mode:
+    Add the following to Resonite's Launch Options in Steam:
 
-For most if not all users, **using ALSA _will_ bork your audio** until you've manually configured PipeWire to support your hardware's sample rates.
+    ```
-If this happens:
+    SDL_AUDIO_DRIVER=alsa %command%
+    ```
 
-   1. Locate the directory or create it if it doesn't exist: `~/.config/pipewire/pipewire.conf.d/`.
+**NOTE:** If you have set `$XDG_CONFIG_HOME` to something other than `~/.config` then please adjust the paths according.
-   
+
-   Remember: The `~/.config` folder is normally hidden in file browsers and could be `$XDG_CONFIG_HOME` on some systems.
+2. Configure PipeWire Sampling Rates:
-   
+
-   2. Create the file `01-sample-rates.conf` in that folder. The full path should be `~/.config/pipewire/pipewire.conf.d/01-sample-rates.conf`.
+    For most if not all users, **using ALSA _WILL_ bork your audio** until you've manually configured PipeWire to use a default sample rate of 48kHz. If this happens:
-   
+
-   3. Paste the following content into the file to define supported sample rates, and save it:
+    2.1. Locate the directory or create it if it doesn't exist: `~/.config/pipewire/pipewire.conf.d/`.
-   ```
+
-   context.properties = {
+    2.2 Create a configuration file (`01-sample-rates.conf` for this example) in that folder. The full path should be `~/.config/pipewire/pipewire.conf.d/01-sample-rates.conf`.
-   default.clock.allowed-rates = [ 44100 48000 88200 96000 ]
+
-   default.clock.rate  = 48000
+    2.3 Paste the following content into the file to define supported sample rates, and save it:
-   }
+
-   ```
+    ```
+    context.properties = {
+    default.clock.allowed-rates = [ 44100 48000 88200 96000 ]
+    default.clock.rate  = 48000
+    }
+    ```
 
 If that doesn't work, you can try forcing the other drivers by specifying `pulseaudio` (or `pipewire`) instead of `alsa` in the above launch argument.
 
@@ -86,9 +91,9 @@ Do note that for the Audio Stream feature of Resonite, you'll need to select a d
 
 The PipeWire driver is not supported by Steam Flatpak OOtB, see [this issue](https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/5261#issuecomment-3228033460) if you need to use the PipeWire driver on Resonite in Steam Flatpak.
 
-### No mic audio after a crash
+### No WiVRn Mic Audio After Resonite Crashes
 
-If you're using WiVRn, close and reopen it (this will crash Resonite).
+If you're using WiVRn, close and reopen it.
 
 ## FlipVR controller support with Monado
 
@@ -145,6 +150,18 @@ It may be enough to just verify file integrity in some cases.
 
 On GE-Proton9-10 (for example), loading into a world with e.g. a YouTube video or live stream can crash the game. Try using the latest GE-Proton-RTSP release.
 
+### Hanging on Launch
+
+Steps to Reproduce:
+
+- Attempt to Launch Resonite via Steam
+
+Symptoms:
+
+- Steam reports Resonite is running but Resonite does not launch
+
+This issue can arise due to not having a default audio device selected. Select one and see if it works. This is likely caused by an SDL / Resonite issue.
+
 ### Crash after loading
 
 Although this is rare, some proton updates can start crashing Resonite repetitively.
@@ -153,15 +170,8 @@ Symptoms:
 - Crashes approximately 1 minute after successfully loading Resonite
 - Everything freezes in both desktop mode and VR, but you can still hear sounds, including the voices of other users
 
-If this happens, just switch Proton to another version in the compatibility options.
+If this happens, just switch Proton to another version such as Proton-GE or Proton-GE-rtsp.
 
-### Crash before loading
-
-Symptoms:
-- Resonite doesn't launch
-- Steam indefinitely shows Resonite is running and lets you press STOP
-
-Choose the correct default audio devices in your volume panel. This is likely caused by SDL.
 
 ## Controls busted after switching to desktop