2019-11-24 10:38:48 +00:00
|
|
|
# harmony
|
2020-01-23 01:40:22 +00:00
|
|
|
[](https://gitlab.com/tslocum/harmony/commits/master)
|
2019-11-24 10:38:48 +00:00
|
|
|
[](https://liberapay.com/rocketnine.space)
|
|
|
|
|
|
|
|
|
|
Voice and text communications platform
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
2019-12-02 16:45:32 +00:00
|
|
|
- Low-latency voice chat using [Opus](https://en.wikipedia.org/wiki/Opus_%28audio_format%29)
|
|
|
|
|
- Rich text chat using [Markdown](https://en.wikipedia.org/wiki/Markdown)
|
2019-11-24 10:38:48 +00:00
|
|
|
|
2019-12-13 03:49:21 +00:00
|
|
|
## Screenshot
|
|
|
|
|
|
|
|
|
|
[](https://harmony.rocketnine.space/static/screenshot_v010_2.png)
|
|
|
|
|
|
2019-12-10 00:16:24 +00:00
|
|
|
## Web client
|
|
|
|
|
|
2019-12-10 16:25:13 +00:00
|
|
|
The only client currently implemented is a web interface (located in pkg/web)
|
|
|
|
|
hosted by the server.
|
2019-12-10 00:16:24 +00:00
|
|
|
|
2019-12-12 03:10:06 +00:00
|
|
|
## Server
|
|
|
|
|
|
|
|
|
|
[**Download harmony-server**](https://harmony.rocketnine.space/download/?sort=name&order=desc)
|
2019-12-10 00:16:24 +00:00
|
|
|
|
2019-12-10 16:25:13 +00:00
|
|
|
The server (located in cmd/harmony-server) passes voice and text communications
|
|
|
|
|
between clients.
|
2019-12-10 00:16:24 +00:00
|
|
|
|
2020-01-23 01:40:22 +00:00
|
|
|
See [HOSTING.md](https://gitlab.com/tslocum/harmony/blob/master/HOSTING.md) for information
|
2019-12-10 16:25:13 +00:00
|
|
|
on hosting a server.
|
2019-12-10 00:16:24 +00:00
|
|
|
|
2020-02-21 17:59:25 +00:00
|
|
|
See [PROTOCOL.md](https://gitlab.com/tslocum/harmony/blob/master/PROTOCOL.md) for information
|
|
|
|
|
on the harmony protocol.
|
|
|
|
|
|
2019-11-24 10:38:48 +00:00
|
|
|
## Support
|
|
|
|
|
|
2020-02-21 17:59:25 +00:00
|
|
|
Please share issues and suggestions [here](https://gitlab.com/tslocum/harmony/issues).
|
2019-12-10 00:16:24 +00:00
|
|
|
|
|
|
|
|
## Libraries
|
|
|
|
|
|
2019-12-11 15:50:26 +00:00
|
|
|
The following libraries are used to build harmony:
|
2019-12-10 00:16:24 +00:00
|
|
|
|
2020-02-21 17:59:25 +00:00
|
|
|
* [pion/webrtc](https://github.com/pion/webrtc) - WebRTC connections and audio
|
|
|
|
|
* [gorilla/websocket](https://github.com/gorilla/websocket) - WebSocket connections
|
