Compare commits
11 Commits
5d0e6c4026
...
81aa5d8d18
Author | SHA1 | Date | |
---|---|---|---|
|
81aa5d8d18 | ||
|
3679108829 | ||
|
77c3dabf79 | ||
|
a6a12720ad | ||
|
231658ff2b | ||
|
6e99e11250 | ||
|
8cd44da368 | ||
|
ac590912bc | ||
|
1ba2faeb25 | ||
|
bedd99a593 | ||
|
e9f6b969b6 |
46
.github/workflows/build-deploy.yml
vendored
Normal file
@ -0,0 +1,46 @@
|
||||
name: Build and Deploy docs
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "master" ]
|
||||
pull_request:
|
||||
branches: [ "master" ]
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: dependencies
|
||||
run: sudo apt-get update && sudo apt-get install gcc-mingw-w64 make
|
||||
- name: make
|
||||
run: make
|
||||
- name: artifact
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: bridge
|
||||
path: build
|
||||
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Configure Git Credentials
|
||||
run: |
|
||||
git config user.name github-actions[bot]
|
||||
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: 3.x
|
||||
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
|
||||
- uses: actions/cache@v4
|
||||
with:
|
||||
key: mkdocs-material-${{ env.cache_id }}
|
||||
path: .cache
|
||||
restore-keys: |
|
||||
mkdocs-material-
|
||||
- run: pip install mkdocs-material
|
||||
- run: mkdocs gh-deploy --force
|
24
.github/workflows/c-cpp.yml
vendored
@ -1,24 +0,0 @@
|
||||
name: C/C++ CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ "master" ]
|
||||
pull_request:
|
||||
branches: [ "master" ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- name: dependencies
|
||||
run: sudo apt-get update && sudo apt-get install gcc-mingw-w64 make
|
||||
- name: make
|
||||
run: make
|
||||
- name: artifact
|
||||
uses: actions/upload-artifact@v3
|
||||
with:
|
||||
name: bridge
|
||||
path: build
|
3
.gitignore
vendored
@ -1,2 +1,3 @@
|
||||
*.o
|
||||
*.exe
|
||||
*.exe
|
||||
*.res
|
||||
|
2
.vscode/c_cpp_properties.json
vendored
@ -8,7 +8,7 @@
|
||||
"defines": [],
|
||||
"cStandard": "c17",
|
||||
"cppStandard": "gnu++17",
|
||||
"intelliSenseMode": "windows-gcc-x86"
|
||||
"intelliSenseMode": "windows-gcc-x64"
|
||||
}
|
||||
],
|
||||
"version": 4
|
||||
|
11
.vscode/settings.json
vendored
@ -1,12 +1,3 @@
|
||||
{
|
||||
"C_Cpp.default.compilerPath": "/usr/bin/i686-w64-mingw32-gcc",
|
||||
"files.associations": {
|
||||
"*.su": "tsv",
|
||||
"thread": "cpp",
|
||||
"bitset": "cpp",
|
||||
"initializer_list": "cpp",
|
||||
"windows.h": "c",
|
||||
"namedpipeapi.h": "c",
|
||||
"*.rh": "c"
|
||||
}
|
||||
"C_Cpp.default.compilerPath": "/usr/bin/x86_64-w64-mingw32-gcc",
|
||||
}
|
11
Makefile
@ -2,23 +2,20 @@ C_SOURCES = $(shell find ./ -type f -name '*.c')
|
||||
C_OBJECTS = $(C_SOURCES:.c=.o)
|
||||
|
||||
CFLAGS = -std=c17 -Wno-int-conversion
|
||||
LFLAGS =
|
||||
LFLAGS = -lgdi32
|
||||
|
||||
# DBGFLAGS = -Wl,--export-all-symbols -g -O0 -ggdb3 -Wall
|
||||
|
||||
all: build
|
||||
|
||||
# This is valid only if this directory is a subdirectory of drive_c
|
||||
install: build
|
||||
cp build/bridge.exe ../bridge.exe
|
||||
|
||||
build: $(C_OBJECTS)
|
||||
$(info Linking)
|
||||
x86_64-w64-mingw32-gcc $(C_OBJECTS) $(LFLAGS) $(DBGFLAGS) -o build/bridge.exe
|
||||
x86_64-w64-mingw32-windres bridge.rc -O coff -o bridge.res
|
||||
x86_64-w64-mingw32-gcc $(C_OBJECTS) bridge.res $(LFLAGS) $(DBGFLAGS) -o build/bridge.exe
|
||||
|
||||
%.o: %.c
|
||||
$(info Compiling $<)
|
||||
x86_64-w64-mingw32-gcc $(CFLAGS) $(DBGFLAGS) -c $< -o $@
|
||||
|
||||
clean:
|
||||
rm -f $(C_OBJECTS) build/bridge.exe
|
||||
rm -f $(C_OBJECTS) build/bridge.exe bridge.res
|
||||
|
107
README.md
@ -1,8 +1,8 @@
|
||||
# Discord RPC Bridge for Wine
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
Simple bridge that allows you to use Discord Rich Presence with Wine games/software.
|
||||
|
||||
@ -12,121 +12,54 @@ This bridge takes advantage of the Windows service implementation in Wine, elimi
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Discord RPC Bridge for Wine](#discord-rpc-bridge-for-wine)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Installation \& Usage](#installation--usage)
|
||||
- [Installing inside a prefix](#installing-inside-a-prefix)
|
||||
- [Wine (~/.wine)](#wine-wine)
|
||||
- [Lutris](#lutris)
|
||||
- [Steam](#steam)
|
||||
- [If you use Flatpak](#if-you-use-flatpak)
|
||||
- [Run without installing the service](#run-without-installing-the-service)
|
||||
- [About macOS](#about-macos)
|
||||
- [Compiling from source](#compiling-from-source)
|
||||
- [Command line arguments](#command-line-arguments)
|
||||
- [Debugging](#debugging)
|
||||
- [Demo](#demo)
|
||||
- [Credits](#credits)
|
||||
|
||||
## Installation & Usage
|
||||
|
||||
Installation will place `bridge.exe` to `C:\bridge.exe` (if it's not already there) and create a Windows service. This service will automatically start when the prefix is used.
|
||||
|
||||
If you prefer not to use the service for any reason, please refer to the [Run without installing the service](#run-without-installing-the-service) section.
|
||||
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)
|
||||
|
||||
- Open terminal in `build`
|
||||
- Run `$ wine cmd` and `C:\> install.bat`
|
||||
- 
|
||||
- To remove, run `C:\> remove.bat`
|
||||
- 
|
||||
- Note: Copying files are not required here.
|
||||
- Double click `bridge.exe` and click `Install`.
|
||||
- 
|
||||
- To remove, the same process can be followed, but click `Remove` instead.
|
||||
|
||||
##### Lutris
|
||||
|
||||
- Right click on the game and select `Browse files`
|
||||
- 
|
||||
- Copy contents of `build` to the game's prefix `drive_c`
|
||||
- 
|
||||
- To install open the console
|
||||
- 
|
||||
- And run `C:\> install.bat` (make sure you are in `C:\`!)
|
||||
- 
|
||||
- Click on a game and select `Run EXE inside Wine prefix`.
|
||||
- 
|
||||
- The same process can be followed as in Wine.
|
||||
|
||||
##### Steam
|
||||
|
||||
- Open [Protontricks](https://github.com/Matoking/protontricks) and select the game you want to install the bridge to
|
||||
- Select `Select the default wineprefix`
|
||||
- Select `Browse files` and copy contents of `build` to the game's prefix `drive_c`
|
||||
- Select `Run a Wine cmd shell` and run `C:\> install.bat`
|
||||
- If you are not in `C:\`, type `c:` and press enter
|
||||
- 
|
||||
- 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.
|
||||
- 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`
|
||||
|
||||
## Run without installing the service
|
||||
## macOS
|
||||
|
||||
If you prefer not to use the service, you can manually run `bridge.exe` within the Wine prefix.
|
||||
This method is compatible with both Wine and Lutris.
|
||||
|
||||
In Lutris, you can achieve this by adding the path to `bridge.exe` in the `Executable` field under `Game options`. In `Arguments` field, be sure to include the _Windows_ path to the game's executable.
|
||||
Example:
|
||||
- Without bridge:
|
||||
- Executable `/mnt/games/lutris/league-of-legends/drive_c/Riot Games/League of Legends/LeagueClient.exe`
|
||||
- Arguments `--locale=en_US --launch-product=league_of_legends --launch-patchline=live`
|
||||
- With bridge:
|
||||
- Executable `/mnt/games/lutris/league-of-legends/drive_c/bridge.exe`
|
||||
- Arguments `"C:\Riot Games\League of Legends\LeagueClient.exe" --locale=en_US --launch-product=league_of_legends --launch-patchline=live`
|
||||
|
||||
In Wine, all you need to do is run `bridge.exe`.
|
||||
|
||||
- When running the program manually without providing any arguments, it will simply initiate the bridge and wait indefinitely until it's closed.
|
||||
|
||||
## About macOS
|
||||
|
||||
The bridge works similarly on macOS as it does on Linux, but it can't be registered as a service due to TMPDIR limitations. macOS users must manually run `bridge.exe` when needed.
|
||||
|
||||
To run `bridge.exe` on macOS, navigate to its directory in the terminal and execute `wine bridge.exe`. (or double click it in the Finder)
|
||||
On macOS, follow [these instructions](https://enderice2.github.io/rpc-bridge/installation.html#macos).
|
||||
|
||||
## Compiling from source
|
||||
|
||||
- Install the `wine`, `x86_64-w64-mingw32-gcc` and `make` packages.
|
||||
- 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`.
|
||||
|
||||
## Command line arguments
|
||||
|
||||
- `--install` - Installs the service
|
||||
- `--remove` - Removes the service
|
||||
- `--service` - Reserved for the service
|
||||
- `[Target Executable]` - Starts the bridge and the game
|
||||
- Example: `bridge.exe "C:\Riot Games\League of Legends\LeagueClient.exe" --locale=en_US --launch-product=league_of_legends --launch-patchline=live`
|
||||
- Note: The game executable must be enclosed in quotes. The rest of the arguments are passed to the target executable.
|
||||
|
||||
## Debugging
|
||||
|
||||
The bridge will write the logs in `C:\bridge.log`.
|
||||
|
||||
## Demo
|
||||
|
||||

|
||||

|
||||
|
||||
## Credits
|
||||
|
||||
This project is inspired by [wine-discord-ipc-bridge](https://github.com/0e4ef622/wine-discord-ipc-bridge).
|
||||
|
44
bridge.c
@ -63,6 +63,8 @@ LPTSTR GetErrorMessage();
|
||||
extern BOOL RunningAsService;
|
||||
BOOL RetryNewConnection;
|
||||
BOOL IsLinux;
|
||||
HANDLE hOut = NULL;
|
||||
HANDLE hIn = NULL;
|
||||
|
||||
static force_inline int linux_syscall(int num,
|
||||
int arg1, int arg2, int arg3,
|
||||
@ -162,37 +164,50 @@ static inline int sys_connect(int s, caddr_t name, socklen_t namelen)
|
||||
return darwin_syscall(__darwin_connect, s, name, namelen, 0, 0, 0);
|
||||
}
|
||||
|
||||
void *environStr = NULL;
|
||||
char *native_getenv(const char *name)
|
||||
{
|
||||
static char lpBuffer[512];
|
||||
DWORD ret = GetEnvironmentVariable("BRIDGE_RPC_PATH", lpBuffer, sizeof(lpBuffer));
|
||||
if (ret != 0)
|
||||
return lpBuffer;
|
||||
|
||||
if (!IsLinux)
|
||||
{
|
||||
char *value = getenv(name);
|
||||
if (value == NULL)
|
||||
{
|
||||
print("Failed to get environment variable: %s\n", name);
|
||||
return NULL;
|
||||
|
||||
/* Use GetEnvironmentVariable as a last resort */
|
||||
DWORD ret = GetEnvironmentVariable(name, lpBuffer, sizeof(lpBuffer));
|
||||
if (ret == 0)
|
||||
{
|
||||
print("GetEnvironmentVariable(\"%s\", ...) failed: %d\n", name, ret);
|
||||
return NULL;
|
||||
}
|
||||
return lpBuffer;
|
||||
}
|
||||
return value;
|
||||
}
|
||||
|
||||
/* I hope the 0x10000 is okay */
|
||||
void *environStr = sys_mmap(0x10000, 4096, PROT_READ | PROT_WRITE,
|
||||
MAP_PRIVATE | MAP_ANON | MAP_FIXED, -1, 0);
|
||||
if (environStr == MAP_FAILED)
|
||||
/* I hope the 0x20000 is okay */
|
||||
if (environStr == NULL)
|
||||
{
|
||||
print("Failed to allocate environ string: %d\n", (intptr_t)environStr);
|
||||
return NULL;
|
||||
environStr = sys_mmap(0x20000, 4096, PROT_READ | PROT_WRITE,
|
||||
MAP_PRIVATE | MAP_ANON | MAP_FIXED, -1, 0);
|
||||
print("Allocated 4096 bytes at %#lx\n", environStr);
|
||||
}
|
||||
|
||||
if ((uintptr_t)environStr > 0x7effffff)
|
||||
print("Warning: environStr %p is above 2GB\n", environStr);
|
||||
print("Warning: environStr %#lx is above 2GB\n", environStr);
|
||||
|
||||
const char *linux_environ = "/proc/self/environ";
|
||||
memcpy(environStr, linux_environ, strlen(linux_environ) + 1);
|
||||
|
||||
int fd = sys_open(environStr, O_RDONLY, 0);
|
||||
|
||||
sys_munmap(environStr, 4096);
|
||||
// sys_munmap(environStr, 4096);
|
||||
if (fd < 0)
|
||||
{
|
||||
print("Failed to open /proc/self/environ: %d\n", fd);
|
||||
@ -299,7 +314,6 @@ void ConnectToSocket(int fd)
|
||||
}
|
||||
}
|
||||
|
||||
HANDLE hOut = NULL;
|
||||
void PipeBufferInThread(LPVOID lpParam)
|
||||
{
|
||||
bridge_thread *bt = (bridge_thread *)lpParam;
|
||||
@ -530,15 +544,17 @@ NewConnection:
|
||||
|
||||
bridge_thread bt = {fd, hPipe};
|
||||
|
||||
HANDLE hIn = CreateThread(NULL, 0,
|
||||
(LPTHREAD_START_ROUTINE)PipeBufferInThread,
|
||||
(LPVOID)&bt,
|
||||
0, NULL);
|
||||
hIn = CreateThread(NULL, 0,
|
||||
(LPTHREAD_START_ROUTINE)PipeBufferInThread,
|
||||
(LPVOID)&bt,
|
||||
0, NULL);
|
||||
print("Created in thread %#lx\n", hIn);
|
||||
|
||||
hOut = CreateThread(NULL, 0,
|
||||
(LPTHREAD_START_ROUTINE)PipeBufferOutThread,
|
||||
(LPVOID)&bt,
|
||||
0, NULL);
|
||||
print("Created out thread %#lx\n", hOut);
|
||||
|
||||
if (hIn == NULL || hOut == NULL)
|
||||
{
|
||||
|
BIN
bridge.ico
Normal file
After Width: | Height: | Size: 16 KiB |
32
bridge.manifest
Normal file
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
||||
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">
|
||||
<assemblyIdentity
|
||||
version="1.0.0.0"
|
||||
processorArchitecture="amd64"
|
||||
name="EnderIce2.rpc-bridge"
|
||||
type="win32"
|
||||
/>
|
||||
<description>Simple bridge that allows you to use Discord Rich Presence with Wine games/software.</description>
|
||||
<dependency>
|
||||
<dependentAssembly>
|
||||
<assemblyIdentity
|
||||
type="win32"
|
||||
name="Microsoft.Windows.Common-Controls"
|
||||
version="6.0.0.0"
|
||||
processorArchitecture="*"
|
||||
publicKeyToken="6595b64144ccf1df"
|
||||
language="*"
|
||||
/>
|
||||
</dependentAssembly>
|
||||
</dependency>
|
||||
<trustInfo xmlns="urn:schemas-microsoft-com:asm.v3">
|
||||
<security>
|
||||
<requestedPrivileges>
|
||||
<requestedExecutionLevel
|
||||
level="asInvoker"
|
||||
uiAccess="false"
|
||||
/>
|
||||
</requestedPrivileges>
|
||||
</security>
|
||||
</trustInfo>
|
||||
</assembly>
|
38
bridge.rc
Normal file
@ -0,0 +1,38 @@
|
||||
#include <windef.h>
|
||||
#include <winuser.h>
|
||||
#include <winresrc.h>
|
||||
|
||||
#define VER_VERSION 1,1,0,0
|
||||
#define VER_VERSION_STR "1.1\0"
|
||||
|
||||
VS_VERSION_INFO VERSIONINFO
|
||||
FILEVERSION VER_VERSION
|
||||
PRODUCTVERSION VER_VERSION
|
||||
FILEFLAGSMASK VS_FFI_FILEFLAGSMASK
|
||||
FILEOS VOS_NT_WINDOWS32
|
||||
FILETYPE VFT_APP
|
||||
FILESUBTYPE VFT2_UNKNOWN
|
||||
BEGIN
|
||||
BLOCK "StringFileInfo"
|
||||
BEGIN
|
||||
BLOCK "040904E4"
|
||||
BEGIN
|
||||
VALUE "FileDescription", "Simple bridge that allows you to use Discord Rich Presence with Wine games/software."
|
||||
VALUE "FileVersion", VER_VERSION_STR
|
||||
VALUE "InternalName", "bridge"
|
||||
VALUE "LegalCopyright", "Copyright (c) 2024 EnderIce2"
|
||||
VALUE "OriginalFilename", "bridge.exe"
|
||||
VALUE "ProductName", "rpc-bridge"
|
||||
VALUE "ProductVersion", VER_VERSION_STR
|
||||
END
|
||||
END
|
||||
|
||||
BLOCK "VarFileInfo"
|
||||
BEGIN
|
||||
VALUE "Translation", 0x409, 1252
|
||||
END
|
||||
END
|
||||
|
||||
IDI_ICON_128 ICON "bridge.ico"
|
||||
|
||||
CREATEPROCESS_MANIFEST_RESOURCE_ID RT_MANIFEST bridge.manifest
|
BIN
docs/assets/favicon.png
Normal file
After Width: | Height: | Size: 3.6 KiB |
Before Width: | Height: | Size: 6.6 KiB After Width: | Height: | Size: 6.6 KiB |
BIN
docs/assets/gui.png
Normal file
After Width: | Height: | Size: 10 KiB |
BIN
docs/assets/lutris.png
Normal file
After Width: | Height: | Size: 9.9 KiB |
Before Width: | Height: | Size: 160 KiB After Width: | Height: | Size: 160 KiB |
Before Width: | Height: | Size: 203 KiB After Width: | Height: | Size: 203 KiB |
Before Width: | Height: | Size: 4.9 KiB After Width: | Height: | Size: 4.9 KiB |
BIN
docs/assets/steam_script.png
Normal file
After Width: | Height: | Size: 28 KiB |
33
docs/index.md
Normal file
@ -0,0 +1,33 @@
|
||||
# Discord RPC Bridge for Wine
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
Simple bridge that allows you to use Discord Rich Presence with Wine games/software on Linux/macOS.
|
||||
|
||||
[Download latest release](https://github.com/EnderIce2/rpc-bridge/releases/latest/download/bridge.zip "Recommended"){ .md-button .md-button--primary }
|
||||
[Download latest pre-release](https://github.com/EnderIce2/rpc-bridge/releases "Unstable builds with experimental features"){ .md-button }
|
||||
<!-- [Download latest build](https://github.com/EnderIce2/rpc-bridge/actions "Builds from the latest commits, here be dragons!"){ .md-button } -->
|
||||
|
||||
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 run it manually.
|
||||
|
||||
These docs are for the latest stable release.
|
||||
For v1.0, see [the original README](https://github.com/EnderIce2/rpc-bridge/blob/v1.0/README.md).
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
{ width="600" }
|
||||
|
||||
{ width="600" }
|
||||
|
||||
## Credits
|
||||
|
||||
This project is inspired by [wine-discord-ipc-bridge](https://github.com/0e4ef622/wine-discord-ipc-bridge).
|
||||
|
||||
---
|
109
docs/installation.md
Normal file
@ -0,0 +1,109 @@
|
||||
# Installation
|
||||
|
||||
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.
|
||||
|
||||
### Lutris
|
||||
|
||||
- Click on a game and select `Run EXE inside Wine prefix`.
|
||||
- 
|
||||
- The same process can be followed as in Wine.
|
||||
|
||||
### Steam
|
||||
|
||||
There are two ways to install the bridge on Steam.
|
||||
|
||||
#### Using bridge.sh[^1]
|
||||
|
||||
This method is recommended because it's easier to manage.
|
||||
|
||||
- Right click on the game and select `Properties`.
|
||||
- Under `Set Launch Options`, add the following:
|
||||
- 
|
||||
<sup><sub>Of course, you need to replace `/path/to/bridge.sh` with the actual path to the script.</sub></sup>
|
||||
|
||||
!!! info "Note"
|
||||
|
||||
`bridge.sh` must be in the same directory as `bridge.exe`.
|
||||
|
||||
#### Using Protontricks
|
||||
|
||||
- Open [Protontricks](https://github.com/Matoking/protontricks) and select the game you want to install the bridge to.
|
||||
- Select `Select the default wineprefix`
|
||||
- Select `Browse files` and copy contents of `build` to the game's prefix `drive_c`
|
||||
- Select `Run a Wine cmd shell` and run `C:\> install.bat`
|
||||
- If you are not in `C:\`, type `c:` and press enter
|
||||
|
||||
, use it instead!")
|
||||
|
||||
!!! warning "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.
|
||||
|
||||
You can do this by using [Flatseal](https://flathub.org/apps/details/com.github.tchx84.Flatseal) or the terminal.
|
||||
|
||||
=== "Flatseal"
|
||||
|
||||
Add `xdg-run/discord-ipc-0` under `Filesystems` category
|
||||

|
||||
|
||||
=== "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
|
||||
|
||||
If using the default Wine prefix (`~/.wine`), you can follow the same steps as in Wine.
|
||||
|
||||
Registering as a service [is not supported](https://github.com/EnderIce2/rpc-bridge/issues/1#issuecomment-2103423242 "Bridge can't get $TMPDIR unless is set with --rpc. See note below").
|
||||
|
||||
!!! info "Note"
|
||||
|
||||
Since macOS doesn't have `/proc/self/environ` and `$TMPDIR` is neither always set nor the same after reboots, so you will need to [add `--rpc "$TMPDIR"` to the `bridge.exe` arguments](https://github.com/EnderIce2/rpc-bridge/issues/1#issuecomment-2104797235).
|
||||
If you don't encounter any issues, you can ignore this step.
|
||||
|
||||
## Run without installing the service
|
||||
|
||||
If you prefer not to use the service, you can manually run `bridge.exe` within the Wine prefix.
|
||||
This method is compatible with both Wine and Lutris.
|
||||
|
||||
In Lutris, you can achieve this by adding the path to `bridge.exe` in the `Executable` field under `Game options`. In `Arguments` field, be sure to include the _Windows_ path to the game's executable.
|
||||
|
||||
=== "Without bridge"
|
||||
|
||||
```
|
||||
Executable
|
||||
/mnt/games/lutris/league-of-legends/drive_c/Riot Games/League of Legends/LeagueClient.exe
|
||||
Arguments
|
||||
--locale=en_US --launch-product=league_of_legends --launch-patchline=live
|
||||
```
|
||||
|
||||
=== "With bridge"
|
||||
|
||||
```
|
||||
Executable
|
||||
/mnt/games/lutris/league-of-legends/drive_c/bridge.exe
|
||||
Arguments
|
||||
"C:\Riot Games\League of Legends\LeagueClient.exe" --locale=en_US --launch-product=league_of_legends --launch-patchline=live
|
||||
```
|
||||
|
||||
In Wine, all you need to do is run `bridge.exe` and select `Start`.
|
||||
|
||||
## 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`.
|
||||
|
||||
[^1]: As requested [here](https://github.com/EnderIce2/rpc-bridge/issues/2).
|
32
docs/usage.md
Normal file
@ -0,0 +1,32 @@
|
||||
# Usage
|
||||
|
||||
## GUI
|
||||
|
||||
- When running the program manually without providing any arguments it will show a GUI.
|
||||

|
||||
- `Start` will start the service without installing itself.
|
||||
- `Install` will install the service.
|
||||
- `Remove` will uninstall the service.
|
||||
|
||||
## Commands
|
||||
|
||||
- `--help` Show help message
|
||||
- This will show the help message
|
||||
|
||||
- `--install` Install the service
|
||||
- This will copy the binary to `C:\windows\bridge.exe` and register it as a service
|
||||
|
||||
- `--uninstall` Uninstall the service
|
||||
- This will remove the service and delete `C:\windows\bridge.exe`
|
||||
|
||||
- `--steam` Reserved for Steam
|
||||
- This will start the service and exit (used with `bridge.sh`)
|
||||
|
||||
- `--no-service` Do not run as service
|
||||
- (only for `--steam`)
|
||||
|
||||
- `--service` Reserved for service
|
||||
- Reserved
|
||||
|
||||
- `--rpc <dir>` Set RPC_PATH environment variable
|
||||
- This is used to specify the directory where `discord-ipc-0` is located
|
117
gui.c
@ -1,3 +1,4 @@
|
||||
#include <windowsx.h>
|
||||
#include <windows.h>
|
||||
#include <winuser.h>
|
||||
#include <assert.h>
|
||||
@ -17,19 +18,46 @@ void CreateBridge();
|
||||
extern BOOL IsLinux;
|
||||
|
||||
HWND hwnd = NULL;
|
||||
HANDLE hBridge = NULL;
|
||||
extern HANDLE hOut;
|
||||
extern HANDLE hIn;
|
||||
|
||||
BOOL IsAlreadyRunning = FALSE;
|
||||
VOID HandleStartButton(BOOL Silent)
|
||||
{
|
||||
if (IsAlreadyRunning)
|
||||
{
|
||||
HWND item = GetDlgItem(hwnd, 4);
|
||||
SetWindowText(item, "Do you want to start, install or remove the bridge?");
|
||||
RedrawWindow(item, NULL, NULL, RDW_ERASE | RDW_INVALIDATE | RDW_FRAME | RDW_ALLCHILDREN);
|
||||
item = GetDlgItem(hwnd, /* Start Button */ 1);
|
||||
Button_SetText(item, "Start");
|
||||
EnableWindow(item, FALSE);
|
||||
RedrawWindow(item, NULL, NULL, RDW_ERASE | RDW_INVALIDATE | RDW_FRAME | RDW_ALLCHILDREN);
|
||||
|
||||
print("Killing %#x, %#lx and waiting for %#lx\n", hIn, hOut, hBridge);
|
||||
if (hIn != NULL)
|
||||
TerminateThread(hIn, 0);
|
||||
if (hOut != NULL)
|
||||
TerminateThread(hOut, 0);
|
||||
WaitForSingleObject(hBridge, INFINITE);
|
||||
|
||||
EnableWindow(item, TRUE);
|
||||
IsAlreadyRunning = FALSE;
|
||||
return;
|
||||
}
|
||||
|
||||
if (!IsLinux)
|
||||
{
|
||||
ShowWindow(hwnd, SW_MINIMIZE);
|
||||
CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)CreateBridge,
|
||||
NULL, 0, NULL);
|
||||
hBridge = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)CreateBridge,
|
||||
NULL, 0, NULL);
|
||||
|
||||
HWND item = GetDlgItem(hwnd, /* Start Button */ 1);
|
||||
EnableWindow(item, FALSE);
|
||||
Button_SetText(item, "Stop");
|
||||
item = GetDlgItem(hwnd, 4);
|
||||
SetWindowText(item, "Bridge is running...");
|
||||
IsAlreadyRunning = TRUE;
|
||||
ShowWindow(hwnd, SW_MINIMIZE);
|
||||
return;
|
||||
}
|
||||
|
||||
@ -44,7 +72,19 @@ VOID HandleStartButton(BOOL Silent)
|
||||
SERVICE_QUERY_CONFIG | SERVICE_CHANGE_CONFIG | SERVICE_START);
|
||||
if (schService == NULL)
|
||||
{
|
||||
print("OpenService failed: %s\n", GetErrorMessage());
|
||||
// print("OpenService failed: %s\n", GetErrorMessage());
|
||||
|
||||
/* Service doesn't exist; running without any service */
|
||||
|
||||
hBridge = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)CreateBridge,
|
||||
NULL, 0, NULL);
|
||||
|
||||
HWND item = GetDlgItem(hwnd, /* Start Button */ 1);
|
||||
Button_SetText(item, "Stop");
|
||||
item = GetDlgItem(hwnd, 4);
|
||||
SetWindowText(item, "Bridge is running...");
|
||||
IsAlreadyRunning = TRUE;
|
||||
ShowWindow(hwnd, SW_MINIMIZE);
|
||||
return;
|
||||
}
|
||||
|
||||
@ -124,6 +164,12 @@ LRESULT CALLBACK WndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
|
||||
PostQuitMessage(0);
|
||||
ExitProcess(0);
|
||||
break;
|
||||
case WM_CTLCOLORSTATIC:
|
||||
{
|
||||
HDC hdcStatic = (HDC)wParam;
|
||||
SetBkMode(hdcStatic, TRANSPARENT);
|
||||
return (INT_PTR)(HBRUSH)GetStockObject(NULL_BRUSH);
|
||||
}
|
||||
default:
|
||||
return DefWindowProc(hwnd, msg, wParam, lParam);
|
||||
}
|
||||
@ -160,17 +206,14 @@ VOID SetButtonStyles(INT *btnStartStyle, INT *btnRemoveStyle, INT *btnInstallSty
|
||||
*btnStartStyle |= WS_DISABLED;
|
||||
}
|
||||
else
|
||||
{
|
||||
*btnStartStyle |= WS_DISABLED;
|
||||
*btnRemoveStyle |= WS_DISABLED;
|
||||
}
|
||||
|
||||
CloseServiceHandle(schService);
|
||||
CloseServiceHandle(hSCManager);
|
||||
}
|
||||
|
||||
int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance,
|
||||
LPSTR lpCmdLine, int nCmdShow)
|
||||
int WINAPI __WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance,
|
||||
LPSTR lpCmdLine, int nCmdShow)
|
||||
{
|
||||
INT btnStartStyle, btnRemoveStyle, btnInstallStyle;
|
||||
SetButtonStyles(&btnStartStyle, &btnRemoveStyle, &btnInstallStyle);
|
||||
@ -193,7 +236,7 @@ int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance,
|
||||
|
||||
assert(RegisterClassEx(&wc));
|
||||
|
||||
hwnd = CreateWindowEx(WS_EX_CLIENTEDGE,
|
||||
hwnd = CreateWindowEx(WS_EX_WINDOWEDGE,
|
||||
szClassName,
|
||||
"Discord RPC Bridge",
|
||||
WS_OVERLAPPEDWINDOW & ~WS_THICKFRAME,
|
||||
@ -202,25 +245,43 @@ int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance,
|
||||
400, 150,
|
||||
NULL, NULL, hInstance, NULL);
|
||||
|
||||
CreateWindow("STATIC", "Do you want to start, install or remove the bridge?",
|
||||
WS_CHILD | WS_VISIBLE | SS_CENTER,
|
||||
0, 0, 400, 50,
|
||||
hwnd, (HMENU)4, hInstance, NULL);
|
||||
HICON hIcon = LoadIcon(hInstance, "IDI_ICON_128");
|
||||
SendMessage(hwnd, WM_SETICON, ICON_BIG, (LPARAM)hIcon);
|
||||
|
||||
CreateWindow("BUTTON", "Start",
|
||||
btnStartStyle,
|
||||
50, 50, 100, 30,
|
||||
hwnd, (HMENU)1, hInstance, NULL);
|
||||
HWND hLbl4 = CreateWindowEx(WS_EX_TRANSPARENT,
|
||||
"STATIC", "Do you want to start, install or remove the bridge?",
|
||||
WS_CHILD | WS_VISIBLE | SS_CENTER,
|
||||
0, 15, 400, 25,
|
||||
hwnd, (HMENU)4, hInstance, NULL);
|
||||
|
||||
CreateWindow("BUTTON", "Install",
|
||||
btnInstallStyle,
|
||||
150, 50, 100, 30,
|
||||
hwnd, (HMENU)2, hInstance, NULL);
|
||||
HWND hbtn1 = CreateWindow("BUTTON", "Start",
|
||||
btnStartStyle,
|
||||
40, 60, 100, 30,
|
||||
hwnd, (HMENU)1, hInstance, NULL);
|
||||
|
||||
CreateWindow("BUTTON", "Remove",
|
||||
btnRemoveStyle,
|
||||
250, 50, 100, 30,
|
||||
hwnd, (HMENU)3, hInstance, NULL);
|
||||
HWND hbtn2 = CreateWindow("BUTTON", "Install",
|
||||
btnInstallStyle,
|
||||
150, 60, 100, 30,
|
||||
hwnd, (HMENU)2, hInstance, NULL);
|
||||
|
||||
HWND hbtn3 = CreateWindow("BUTTON", "Remove",
|
||||
btnRemoveStyle,
|
||||
260, 60, 100, 30,
|
||||
hwnd, (HMENU)3, hInstance, NULL);
|
||||
|
||||
HDC hDC = GetDC(hwnd);
|
||||
int nHeight = -MulDiv(11, GetDeviceCaps(hDC, LOGPIXELSY), 72);
|
||||
|
||||
HFONT hFont = CreateFont(nHeight, 0, 0, 0, FW_DONTCARE, FALSE, FALSE, FALSE, ANSI_CHARSET,
|
||||
OUT_TT_PRECIS, CLIP_DEFAULT_PRECIS, DEFAULT_QUALITY,
|
||||
DEFAULT_PITCH | FF_DONTCARE, TEXT("Segoe UI"));
|
||||
ReleaseDC(hwnd, hDC);
|
||||
|
||||
SendMessage(hwnd, WM_SETFONT, hFont, TRUE);
|
||||
SendMessage(hLbl4, WM_SETFONT, hFont, TRUE);
|
||||
SendMessage(hbtn1, WM_SETFONT, hFont, TRUE);
|
||||
SendMessage(hbtn2, WM_SETFONT, hFont, TRUE);
|
||||
SendMessage(hbtn3, WM_SETFONT, hFont, TRUE);
|
||||
|
||||
ShowWindow(hwnd, nCmdShow);
|
||||
UpdateWindow(hwnd);
|
||||
@ -237,5 +298,5 @@ int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance,
|
||||
void CreateGUI()
|
||||
{
|
||||
ShowWindow(GetConsoleWindow(), SW_MINIMIZE);
|
||||
ExitProcess(WinMain(GetModuleHandle(NULL), NULL, GetCommandLine(), SW_SHOWNORMAL));
|
||||
ExitProcess(__WinMain(GetModuleHandle(NULL), NULL, GetCommandLine(), SW_SHOWNORMAL));
|
||||
}
|
||||
|
Before Width: | Height: | Size: 321 KiB |
Before Width: | Height: | Size: 264 KiB |
Before Width: | Height: | Size: 609 KiB |
Before Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 541 KiB |
Before Width: | Height: | Size: 193 KiB |
28
main.c
@ -259,6 +259,19 @@ void HandleArguments(int argc, char *argv[])
|
||||
RemoveService();
|
||||
ExitProcess(0);
|
||||
}
|
||||
else if (strcmp(argv[1], "--rpc") == 0)
|
||||
{
|
||||
if (argc < 3)
|
||||
{
|
||||
print("No directory provided\n");
|
||||
ExitProcess(1);
|
||||
}
|
||||
|
||||
SetEnvironmentVariable("BRIDGE_RPC_PATH", argv[2]);
|
||||
print("BRIDGE_RPC_PATH has been set to \"%s\"\n", argv[2]);
|
||||
CreateBridge();
|
||||
ExitProcess(0);
|
||||
}
|
||||
else if (strcmp(argv[1], "--help") == 0)
|
||||
{
|
||||
printf("Usage:\n");
|
||||
@ -269,17 +282,21 @@ void HandleArguments(int argc, char *argv[])
|
||||
|
||||
printf(" --install Install service\n");
|
||||
printf(" This will copy the binary to C:\\windows\\bridge.exe and register it as a service\n\n");
|
||||
|
||||
printf(" --uninstall Uninstall service\n");
|
||||
|
||||
printf(" This will remove the service and delete C:\\windows\\bridge.exe\n\n");
|
||||
|
||||
printf(" --steam Reserved for Steam\n");
|
||||
|
||||
printf(" This will start the service and exit (used with bridge.sh)\n\n");
|
||||
printf(" --no-service Do not run as service\n");
|
||||
|
||||
printf(" --no-service Do not run as service\n");
|
||||
printf(" (only for --steam)\n\n");
|
||||
|
||||
printf(" --service Reserved for service\n\n");
|
||||
|
||||
printf(" --rpc <dir> Set RPC_PATH environment variable\n");
|
||||
printf(" This is used to specify the directory where 'discord-ipc-0' is located\n\n");
|
||||
|
||||
printf("Note: If no arguments are provided, the GUI will be shown instead\n");
|
||||
ExitProcess(0);
|
||||
}
|
||||
@ -310,3 +327,8 @@ int main(int argc, char *argv[])
|
||||
fclose(g_logFile);
|
||||
ExitProcess(0);
|
||||
}
|
||||
|
||||
int WINAPI WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nCmdShow)
|
||||
{
|
||||
return main(__argc, __argv);
|
||||
}
|
||||
|
76
mkdocs.yml
Normal file
@ -0,0 +1,76 @@
|
||||
site_name: rpc-bridge
|
||||
repo_url: https://github.com/EnderIce2/rpc-bridge
|
||||
repo_name: EnderIce2/rpc-bridge
|
||||
theme:
|
||||
name: material
|
||||
features:
|
||||
- content.code.copy
|
||||
- content.tabs.link
|
||||
- navigation.tabs
|
||||
- navigation.top
|
||||
- navigation.footer
|
||||
- toc.integrate
|
||||
- content.tooltips
|
||||
palette:
|
||||
- media: "(prefers-color-scheme)"
|
||||
toggle:
|
||||
icon: material/weather-sunny
|
||||
name: Switch to light mode
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
primary: black
|
||||
accent: indigo
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: Switch to system preference
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
primary: indigo
|
||||
accent: indigo
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: Switch to dark mode
|
||||
font:
|
||||
text: Roboto
|
||||
code: Roboto Mono
|
||||
favicon: assets/favicon.png
|
||||
logo: assets/favicon.png
|
||||
icon:
|
||||
logo: logo
|
||||
admonition:
|
||||
note: octicons/tag-16
|
||||
abstract: octicons/checklist-16
|
||||
info: octicons/info-16
|
||||
tip: octicons/squirrel-16
|
||||
success: octicons/check-16
|
||||
question: octicons/question-16
|
||||
warning: octicons/alert-16
|
||||
failure: octicons/x-circle-16
|
||||
danger: octicons/zap-16
|
||||
bug: octicons/bug-16
|
||||
example: octicons/beaker-16
|
||||
quote: octicons/quote-16
|
||||
markdown_extensions:
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
line_spans: __span
|
||||
pygments_lang_class: true
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- footnotes
|
||||
- attr_list
|
||||
- pymdownx.critic
|
||||
- pymdownx.caret
|
||||
- pymdownx.keys
|
||||
- pymdownx.mark
|
||||
- pymdownx.tilde
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
plugins:
|
||||
- offline
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Installation: installation.md
|
||||
- Usage: usage.md
|