From f5228d91d28e39d56c7245ecf0128895273c9ec0 Mon Sep 17 00:00:00 2001 From: ouwou <26526779+ouwou@users.noreply.github.com> Date: Mon, 10 Apr 2023 23:58:21 -0400 Subject: update readme --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index ee2e89c..372354f 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Current features: * Identifies to Discord as the web client unlike other clients so less likely to be falsely flagged as spam1 * Set status * Unread and mention indicators +* Notifications (non-Windows) * Start new DMs and group DMs * View user profiles (notes, mutual servers, mutual friends) * Kick, ban, and unban members @@ -134,15 +135,17 @@ spam filter's wrath: * [gtkmm](https://www.gtkmm.org/en/) * [JSON for Modern C++](https://github.com/nlohmann/json) -* [IXWebSocket](https://github.com/machinezone/IXWebSocket) +* [IXWebSocket](https://github.com/machinezone/IXWebSocket) (provided as submodule) * [libcurl](https://curl.se/) * [zlib](https://zlib.net/) * [SQLite3](https://www.sqlite.org/index.html) * [libhandy](https://gnome.pages.gitlab.gnome.org/libhandy/) (optional) +* [keychain](https://github.com/hrantzsch/keychain) (optional, provided as submodule) +* [miniaudio](https://miniaud.io/) (optional, provided as submodule) ### TODO: -* Voice support +* Voice support (in progress) * User activities * More server management stuff * A bunch of other stuff @@ -301,6 +304,13 @@ For example, memory_db would be set by adding `memory_db = true` under the line | `mentionbadgetextcolor` | string | color to use for number displayed on mention badges | | `unreadcolor` | string | color to use for the unread indicator | +#### notifications + +| Setting | Type | Default | Description | +|-------------|---------|--------------------------|-------------------------------------------------------------------------------| +| `enabled` | boolean | true (if not on Windows) | Enable desktop notifications | +| `playsound` | boolean | true | Enable notification sounds. Requires ENABLE_NOTIFICATION_SOUNDS=TRUE in CMake | + ### Environment variables | variable | Description | -- cgit v1.2.3