https://github.com/sunpodder/relay-protocols

Protocol specifications for the Relay ecosystem
https://github.com/sunpodder/relay-protocols

Last synced: 4 months ago
JSON representation

Protocol specifications for the Relay ecosystem

• Host: GitHub
• URL: https://github.com/sunpodder/relay-protocols
• Owner: SunPodder
• License: mit
• Created: 2025-08-02T09:13:14.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-08-10T14:34:50.000Z (10 months ago)
• Last Synced: 2025-08-10T16:27:11.021Z (10 months ago)
• Homepage:
• Size: 9.77 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Relay Protocols

This repository documents the protocol specifications for communication between Android and Desktop systems, as used in the Relay ecosystem.

---

## Protocol Specifications

All protocol documents are in this repo:

- [Base Envelope Format](./base.md)

- [Connection Handshake (`conn`)](./conn.md)

- [Acknowledgment (`ack`)](./ack.md)

- [Notification Protocol](./notification.md)

- [SMS Protocol](./sms.md)

- [Heartbeat Protocol (`ping`/`pong`)](./pingpong.md)

---

## Related Projects

- **Relay Protocols (this repo):** [https://github.com/SunPodder/relay-protocols](https://github.com/SunPodder/relay-protocols)

- **Server Implementation:** [https://github.com/SunPodder/Relay](https://github.com/SunPodder/Relay)

- **Client Implementation:** [https://github.com/SunPodder/relay-pc](https://github.com/SunPodder/relay-pc)

---

## Project Status & Philosophy

> **Early Stage Warning:**

>

> This and all related projects are in very early development. Things can (and probably will) break at any time.

This is a personal project built specifically for my own needs. I have the final say on what features are included and how the software works. However, I'm open to new ideas and discussions—if you have suggestions, feel free to open an issue or start a discussion. I might like your idea!

---

## License

MIT License. Feel free to fork and use as you wish.