scootz/reforger-eq
scootz/reforger-eq
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme to not be so damn stupid @codex

Browse source
This commit is contained in:
scootz 2026-05-02 20:00:15 +01:00
parent 4b59f4555d
commit 5fcfbb8a6c
1 changed files with 59 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

105
README.md
View file

@ -2,7 +2,7 @@
PipeWire/PulseAudio helper for exposing Arma Reforger's 5.1 output on Linux. 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. - 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. - 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 ## Requirements
- PipeWire with PulseAudio compatibility - PipeWire with PulseAudio compatibility
- `pactl`
- Arma Reforger through Steam/Proton - Arma Reforger through Steam/Proton
- Carla
- LSP VST Plugins
For the Carla EQ stage on Arch: 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 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 ```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 ```bash
reforger-surround launch 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 >If Reforger negotiates only `2ch`, restart the game and investigate manually with `qpwgraph`, `reforger-surround status`, and `pactl list sink-inputs`.
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`.
Expected final QPWGraph wiring: Expected final QPWGraph wiring:
![Expected QPWGraph wiring](assets/qpwgraph%20wiring.png) ![Expected QPWGraph wiring](assets/qpwgraph%20wiring.png)
## 2. Open ReforgerEQ Carla ---
## Part 2. Open ReforgerEQ Carla
Open `reforger-audio.carxp` through Carla: Open `reforger-audio.carxp` through Carla:
```bash - Launch Carla
pw-jack /usr/bin/python3 /usr/share/carla/carla --with-appname=carla --with-libprefix=/usr /path/to/reforger-audio.carxp - 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.
![Carla wiring](assets/Carla%20Wiring.png) Enter `carla`, click on the small tab `patchbay` and wire Carla outputs to your real output device's playback ports:
Wire Carla outputs to your real output device's playback ports:
```text ```text
Output 1 -> playback_FL Output 1 -> playback_FL
@ -98,6 +105,12 @@ Output 4 -> playback_FL
Output 5 -> playback_FR Output 5 -> playback_FR
``` ```
Carla patchbay example:
>'Speakers' is a generic device, your device name may vary.
![Carla wiring](assets/Carla%20Wiring.png)
## Useful Commands ## Useful Commands
```bash ```bash
@ -119,4 +132,4 @@ REFORGER_SURROUND_STEAM_URI=steam://rungameid/1874880
REFORGER_SURROUND_WAIT_SECONDS=90 REFORGER_SURROUND_WAIT_SECONDS=90
``` ```
LFE may be silent even when Reforger is outputting 6ch. LFE is silent even when Reforger is outputting 6ch.