mirror of
https://github.com/EnderIce2/rpc-bridge.git
synced 2025-05-25 14:04:37 +00:00
EnderIce2
ad076dfac7
Included video tutorial link for installing the LaunchAgent and bridge inside CrossOver.
80 lines
3.5 KiB
Markdown
80 lines
3.5 KiB
Markdown
# Discord RPC Bridge for Wine
|
|
|
|
|
|
|
|
|
|
|
|
Simple bridge that allows you to use Discord Rich Presence with Wine games/software.
|
|
|
|
Works by running a small program in the background that creates a [named pipe](https://learn.microsoft.com/en-us/windows/win32/ipc/named-pipes) `\\.\pipe\discord-ipc-0` inside the prefix and forwards all data to the pipe `/run/user/1000/discord-ipc-0`.
|
|
|
|
This bridge takes advantage of the Windows service implementation in Wine, eliminating the need to manually run any programs.
|
|
|
|
---
|
|
|
|
## Installation & Usage
|
|
|
|
Installation will copy itself to `C:\windows\bridge.exe` and create a Windows service.
|
|
Logs are stored in `C:\windows\logs\bridge.log`.
|
|
|
|
#### Installing inside a prefix
|
|
|
|
##### Wine (~/.wine)
|
|
|
|
- Double click `bridge.exe` and click `Install`.
|
|
- 
|
|
- To remove, the same process can be followed, but click `Remove` instead.
|
|
|
|
*Note, an [extra step](https://github.com/EnderIce2/rpc-bridge?tab=readme-ov-file#macos) is needed on MacOS*
|
|
|
|
##### Lutris
|
|
|
|
- Click on a game and select `Run EXE inside Wine prefix`.
|
|
- 
|
|
- The same process can be followed as in Wine.
|
|
|
|
##### Steam
|
|
|
|
- Right click on the game and select `Properties`.
|
|
- Under `Set Launch Options`, add the following:
|
|
- 
|
|
- The `bridge.sh` script must be in the same directory as `bridge.exe`.
|
|
|
|
#### If you use Flatpak
|
|
|
|
- If you are running Steam, Lutris, etc in a Flatpak, you will need to allow the bridge to access the `/run/user/1000/discord-ipc-0` file.
|
|
- ##### By using [Flatseal](https://flathub.org/apps/details/com.github.tchx84.Flatseal)
|
|
- Add `xdg-run/discord-ipc-0` under `Filesystems` category
|
|
- 
|
|
- ##### By using the terminal
|
|
- Per application
|
|
- `flatpak override --filesystem=xdg-run/discord-ipc-0 <flatpak app name>`
|
|
- Globally
|
|
- `flatpak override --user --filesystem=xdg-run/discord-ipc-0`
|
|
|
|
##### MacOS
|
|
|
|
The steps for MacOS are almost the same, but due to the way `$TMPDIR` works, you will have to install a **LaunchAgent**.
|
|
|
|
- Download the latest build from the [releases](https://github.com/EnderIce2/rpc-bridge/releases)
|
|
- Open the archive and make the `launchd.sh` script executable by doing: `chmod +x launchd.sh`
|
|
- To **install** the LaunchAgent, run `./launchd.sh install` and to **remove** it simply run `./launchd.sh remove`.
|
|
|
|
The script will add a LaunchAgent to your user, that will symlink the `$TMPDIR` directory to `/tmp/rpc-bridge/tmpdir`.
|
|
|
|
*Note: You will need to launch the `bridge.exe` file manually in Wine at least once for it to register and launch automatically the next time.*
|
|
|
|
More details on how to install the LaunchAgent can be found in the [documentation](https://enderice2.github.io/rpc-bridge/).
|
|
|
|
## Compiling from source
|
|
|
|
- Install the `wine`, `gcc-mingw-w64` and `make` packages.
|
|
- Open a terminal in the directory that contains this file and run `make`.
|
|
- The compiled executable will be located in `build/bridge.exe`.
|
|
|
|
## Credits
|
|
|
|
This project is inspired by [wine-discord-ipc-bridge](https://github.com/0e4ef622/wine-discord-ipc-bridge).
|
|
|
|
---
|