uowuo/abaddon
1
0
Fork 0
mirror of https://github.com/uowuo/abaddon.git synced 2025-03-04 03:03:16 -05:00
Code Issues Projects Releases Activity

update readme

Browse Source
This commit is contained in:
ouwou 2023-04-10 23:58:21 -04:00
parent e9dd1a8ceb
commit f5228d91d2
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -14,6 +14,7 @@ Current features:
* Identifies to Discord as the web client unlike other clients so less likely to be falsely flagged as spam<sup>1</sup>
* 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 |