Voice and text communications platform powered by WebRTC
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 lines
1.5 KiB

2 years ago
# harmony
[![Donate](https://img.shields.io/liberapay/receives/rocketnine.space.svg?logo=liberapay)](https://liberapay.com/rocketnine.space)
Voice and text communications platform
## Features
2 months ago
- Low-latency voice chat powered by [Opus](https://en.wikipedia.org/wiki/Opus_%28audio_format%29) over [WebRTC](https://en.wikipedia.org/wiki/WebRTC)
- Rich text chat in [Markdown](https://en.wikipedia.org/wiki/Markdown) format
2 years ago
## Screenshot
[![](https://harmony.rocketnine.space/static/screenshot_v010_2.png)](https://harmony.rocketnine.space/static/screenshot_v010_2.png)
## Web client
The only client currently implemented is a web interface (located in pkg/web)
hosted by the server.
## Server
[**Download harmony-server**](https://harmony.rocketnine.space/download/?sort=name&order=desc)
The server (located in cmd/harmony-server) passes voice and text communications
between clients.
2 months ago
See [HOSTING.md](https://code.rocketnine.space/tslocum/harmony/blob/master/HOSTING.md) for information
on hosting a server.
2 months ago
See [PROTOCOL.md](https://code.rocketnine.space/tslocum/harmony/blob/master/PROTOCOL.md) for information
2 years ago
on the harmony protocol.
2 years ago
## Support
2 months ago
Please share issues and suggestions [here](https://code.rocketnine.space/tslocum/harmony/issues).
## Libraries
The following libraries are used to build harmony:
2 years ago
* [pion/webrtc](https://github.com/pion/webrtc) - WebRTC connections and audio
* [gorilla/websocket](https://github.com/gorilla/websocket) - WebSocket connections