update readme to not be so damn stupid @codex
This commit is contained in:
parent
4b59f4555d
commit
5fcfbb8a6c
1 changed files with 59 additions and 46 deletions
105
README.md
105
README.md
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
PipeWire/PulseAudio helper for exposing Arma Reforger's 5.1 output on Linux.
|
||||
|
||||
This project has two parts:
|
||||
This project has two parts to running:
|
||||
|
||||
- Create a temporary 5.1 sink so Reforger negotiates surround channels.
|
||||
- Manually open the Carla EQ project and wire it to your real stereo output.
|
||||
|
|
@ -12,8 +12,9 @@ Watching the graph in `qpwgraph` is recommended while testing.
|
|||
## Requirements
|
||||
|
||||
- PipeWire with PulseAudio compatibility
|
||||
- `pactl`
|
||||
- Arma Reforger through Steam/Proton
|
||||
- Carla
|
||||
- LSP VST Plugins
|
||||
|
||||
For the Carla EQ stage on Arch:
|
||||
|
||||
|
|
@ -21,74 +22,80 @@ For the Carla EQ stage on Arch:
|
|||
sudo pacman -S carla lsp-plugins-vst
|
||||
```
|
||||
|
||||
## Install
|
||||
## Normal Use (after first time install)
|
||||
|
||||
|
||||
---
|
||||
|
||||
>### Optional - Install script as a callable service
|
||||
>
|
||||
> ```bash
|
||||
>install -Dm755 reforger-surround ~/.local/bin/reforger-surround
|
||||
>```
|
||||
>If you choose not to install it, you can refer to it by running like a standard bash script ie. `cd` to the project directory and use `./reforger-surround` to run.
|
||||
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
Due to program restrictions on both Arma and Carla, there is a three part process to installing first time.
|
||||
|
||||
## Part 1. Expose Reforger 5.1 Channel
|
||||
|
||||
### First time install
|
||||
|
||||
```bash
|
||||
install -Dm755 reforger-surround ~/.local/bin/reforger-surround
|
||||
reforger-surround up
|
||||
# launch Arma Reforger manually
|
||||
reforger-surround expose
|
||||
reforger-surround restore
|
||||
reforger-surround check
|
||||
```
|
||||
|
||||
## 1. Expose Reforger 5.1
|
||||
|
||||
Preferred flow:
|
||||
This creates the 5.1 sink, makes it default, launches Reforger, waits for the game audio stream, restores your previous default device, then exposes Reforger back to the 5.1 sink.
|
||||
|
||||
### After installing
|
||||
|
||||
```bash
|
||||
reforger-surround launch
|
||||
```
|
||||
|
||||
This creates the 5.1 sink, makes it default, launches Reforger, waits for the game audio stream, restores your previous default device, then exposes Reforger back to the 5.1 sink.
|
||||
If `launch` errors or times out, use the manual flow from first time install.
|
||||
|
||||
Check the result:
|
||||
|
||||
```bash
|
||||
reforger-surround check
|
||||
```
|
||||
|
||||
Good:
|
||||
|
||||
```text
|
||||
Sample Specification: ... 6ch 48000Hz
|
||||
Channel Map: front-left,front-right,front-center,lfe,rear-left,rear-right
|
||||
```
|
||||
|
||||
If `launch` errors or times out, use the manual flow:
|
||||
|
||||
```bash
|
||||
reforger-surround up
|
||||
# launch Arma Reforger manually
|
||||
reforger-surround restore
|
||||
reforger-surround check
|
||||
```
|
||||
|
||||
If Reforger negotiates only `2ch`, restart the game and investigate manually with `qpwgraph`, `reforger-surround status`, and `pactl list sink-inputs`.
|
||||
>If Reforger negotiates only `2ch`, restart the game and investigate manually with `qpwgraph`, `reforger-surround status`, and `pactl list sink-inputs`.
|
||||
|
||||
Expected final QPWGraph wiring:
|
||||
|
||||
|
||||
|
||||
## 2. Open ReforgerEQ Carla
|
||||
---
|
||||
|
||||
## Part 2. Open ReforgerEQ Carla
|
||||
|
||||
Open `reforger-audio.carxp` through Carla:
|
||||
|
||||
```bash
|
||||
pw-jack /usr/bin/python3 /usr/share/carla/carla --with-appname=carla --with-libprefix=/usr /path/to/reforger-audio.carxp
|
||||
```
|
||||
- Launch Carla
|
||||
- Click on Open
|
||||
- Open `reforger-audio.carxp`
|
||||
|
||||
Optional KDE launcher:
|
||||
>Recommended (optional) KDE one-click launcher for start menu:
|
||||
>
|
||||
>- Right click the start menu or open `Menu Editor`
|
||||
>- Choose `Edit Applications`.
|
||||
>- Create a new item.
|
||||
>- Name: `Reforger EQ Carla`
|
||||
>- Program: `pw-jack`
|
||||
>- Command line arguments: `/usr/bin/python3 /usr/share/carla/carla --with-appname=carla --with-libprefix=/usr /path/to/reforger-audio.carxp`
|
||||
|
||||
- Open the start menu.
|
||||
- Choose `Edit Applications`.
|
||||
- Create a new item.
|
||||
- Name: `Reforger EQ Carla`
|
||||
- Program: `pw-jack`
|
||||
- Command line arguments: `/usr/bin/python3 /usr/share/carla/carla --with-appname=carla --with-libprefix=/usr /path/to/reforger-audio.carxp`
|
||||
---
|
||||
|
||||
## 3. Carla Output Wiring
|
||||
## Part 3. Carla Output Wiring
|
||||
|
||||
Carla patchbay example:
|
||||
>If you want to use `qpwgraph` to do this step, feel free. Be aware that it (sometimes) won't auto-wire when ReforgerEQ Carla gets reset. Using Carla's patchbay means it will *always* link itself to what is saved in the .carxp file.
|
||||
|
||||
|
||||
|
||||
Wire Carla outputs to your real output device's playback ports:
|
||||
Enter `carla`, click on the small tab `patchbay` and wire Carla outputs to your real output device's playback ports:
|
||||
|
||||
```text
|
||||
Output 1 -> playback_FL
|
||||
|
|
@ -98,6 +105,12 @@ Output 4 -> playback_FL
|
|||
Output 5 -> playback_FR
|
||||
```
|
||||
|
||||
Carla patchbay example:
|
||||
>'Speakers' is a generic device, your device name may vary.
|
||||
|
||||
|
||||
|
||||
|
||||
## Useful Commands
|
||||
|
||||
```bash
|
||||
|
|
@ -119,4 +132,4 @@ REFORGER_SURROUND_STEAM_URI=steam://rungameid/1874880
|
|||
REFORGER_SURROUND_WAIT_SECONDS=90
|
||||
```
|
||||
|
||||
LFE may be silent even when Reforger is outputting 6ch.
|
||||
LFE is silent even when Reforger is outputting 6ch.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue