Add docs

docs/index.md

@@ -0,0 +1,33 @@
+# Discord RPC Bridge for Wine
+
+![GitHub License](https://img.shields.io/github/license/EnderIce2/rpc-bridge?style=for-the-badge)
+![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/EnderIce2/rpc-bridge/total?style=for-the-badge)
+![GitHub Release](https://img.shields.io/github/v/release/EnderIce2/rpc-bridge?style=for-the-badge)
+![GitHub Pre-Release](https://img.shields.io/github/v/release/EnderIce2/rpc-bridge?include_prereleases&style=for-the-badge&label=pre-release)
+
+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
+
+![lol](assets/lutris_lol.png "League Of Legends running under Wine using Lutris"){ width="600" }
+
+![among us](assets/steam_amongus.png "Among Us on Steam"){ width="600" }
+
+## Credits
+
+This project is inspired by [wine-discord-ipc-bridge](https://github.com/0e4ef622/wine-discord-ipc-bridge).
+
+---

docs/installation.md

@@ -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`.
+    - ![gui](assets/gui.png "rpc-bridge GUI")
+- To remove, the same process can be followed, but click `Remove` instead.
+
+### Lutris
+
+- Click on a game and select `Run EXE inside Wine prefix`.
+    - ![lutris](assets/lutris.png "Lutris")
+- 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:
+    - ![bridge.sh](assets/steam_script.png "Set Launch Options to the path of the bridge.sh")  
+<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
+
+![protontricks](assets/steam_protontricks.png "If use have the option for 'Run an arbitrary executable (.exe/.msi/.msu), 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  
+        ![flatseal](assets/flatseal_permission.png)
+
+    === "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`, `x86_64-w64-mingw32-gcc` 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).

docs/usage.md

@@ -0,0 +1,32 @@
+# Usage
+
+## GUI
+
+- When running the program manually without providing any arguments it will show a GUI.
+![gui](assets/gui.png "rpc-bridge 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