You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Relay is an Android app for cross-device notification and message relay, supporting a custom protocol for real-time communication with desktop clients.
- Bidirectional protocol with length-prefixed JSON messages
10
+
11
+
## Getting Started
12
+
13
+
**Install the APK**: Download the latest APK from the [Releases page](https://github.com/SunPodder/Relay/releases) and install it on your Android device.
14
+
15
+
Or **Build from source**: Clone this repository and build the app using Android Studio or Gradle:
16
+
```bash
17
+
./gradlew assembleDebugOptimized
18
+
```
19
+
Then install the generated APK on your device.
20
+
21
+
**First-time setup:**
22
+
23
+
- Open the Relay app after installation.
24
+
- Grant the required notification permissions when prompted.
25
+
- Go to your device's App Settings for Relay → Battery optimizations → Allow unrestricted usage (to ensure background operation).
26
+
- Make sure the app server is running.
27
+
- You can now close the app; the Relay service will keep running in the background and forward notifications to connected clients as long as permissions are granted.
28
+
29
+
## Cross-Platform Desktop Client
30
+
31
+
A cross-platform desktop client implementation is available at:
32
+
-https://github.com/SunPodder/relay-pc
33
+
34
+
This client supports Windows, Linux, and macOS, and is designed to work seamlessly with this Android app.
35
+
36
+
## Protocol
37
+
38
+
- All communication uses a 4-byte big-endian length-prefixed JSON envelope.
0 commit comments