abaddon/README.md

107 lines
4.7 KiB
Markdown
Raw Normal View History

2020-11-16 02:00:20 +00:00
#### Screenshots
<table>
<tr>
<td><img src="/.readme/s1.png"></td>
<td><img src="/.readme/s2.png"></td>
</tr>
<tr>
<td><img src="/.readme/s3.png"></td>
<td><img src="/.readme/s4.png"></td>
</tr>
</table>
2020-09-05 05:09:46 +00:00
### Building:
#### Windows:
2020-12-19 04:59:33 +00:00
1. `git clone https://github.com/uowuo/abaddon && cd abaddon`
2021-01-01 06:48:35 +00:00
2. `vcpkg install gtkmm:x64-windows nlohmann-json:x64-windows ixwebsocket:x64-windows cpr:x64-windows zlib:x64-windows simpleini:x64-windows sqlite3:x64-windows`
2020-09-09 21:37:09 +00:00
3. `mkdir build && cd build`
4. `cmake -G"Visual Studio 16 2019" -A x64 -DCMAKE_TOOLCHAIN_FILE=c:\path\to\vcpkg\scripts\buildsystems\vcpkg.cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo -DVCPKG_TARGET_TRIPLET=x64-windows ..`
5. Build with Visual Studio
2020-09-05 05:09:46 +00:00
2020-12-11 02:32:02 +00:00
#### Mac/Linux:
2021-01-01 06:48:35 +00:00
You can build for Mac and Linux but specific commands are yet to be listed for the time being ([#9](https://github.com/uowuo/abaddon/issues/9))
2020-09-05 05:09:46 +00:00
2020-09-09 21:37:09 +00:00
### Downloads (from CI):
2020-12-19 08:22:14 +00:00
- Windows: [here](https://ci.appveyor.com/project/ouwou/abaddon/build/artifacts)
2020-09-09 21:37:09 +00:00
#### Dependencies:
* [gtkmm](https://www.gtkmm.org/en/)
* [JSON for Modern C++](https://github.com/nlohmann/json)
* [IXWebSocket](https://github.com/machinezone/IXWebSocket)
* [C++ Requests: Curl for People](https://github.com/whoshuu/cpr/)
2020-09-05 05:09:46 +00:00
* [zlib](https://zlib.net/)
* [simpleini](https://github.com/brofield/simpleini)
2020-12-10 22:15:15 +00:00
* [SQLite3](https://www.sqlite.org/index.html)
2020-09-09 22:32:45 +00:00
2020-11-16 02:00:20 +00:00
### TODO:
* Voice support
* Unread indicators
* User status
* Nicknames
* Server/user management
* A bunch of other stuff
2020-09-09 22:32:45 +00:00
### Styling
#### CSS selectors
.channel-list - Container of the channel list
.channel-row - All rows within the channel container
.channel-row-channel - Only rows containing a channel
.channel-row-category - Only rows containing a category
.channel-row-guild - Only rows containing a guild
.channel-row-label - All labels within the channel container
.messages - Container of user messages
.message-container - The container which holds a user's messages
.message-container-author - The author label for a message container
.message-container-timestamp - The timestamp label for a message container
.message-container-extra - Label containing BOT/Webhook
2021-01-01 06:48:35 +00:00
.message-text - The text of a user message
.message-attachment-box - Contains attachment info
.message-reply - Container for the replied-to message in a reply (these elements will also have .message-text set)
.reaction-box - Contains a reaction image and the count
.reacted - Additional class for reaction-box when the user has reacted with a particular reaction
.reaction-count - Contains the count for reaction
.completer - Container for the message completer
.completer-entry - Container for a single entry in the completer
.completer-entry-label - Contains the label for an entry in the completer
.completer-entry-image - Contains the image for an entry in the completer
2020-09-09 22:32:45 +00:00
.embed - Container for a message embed
.embed-author - The author of an embed
.embed-title - The title of an embed
.embed-description - The description of an embed
.embed-field-title - The title of an embed field
.embed-field-value - The value of an embed field
.embed-footer - The footer of an embed
.members - Container of the member list
.members-row - All rows within the members container
.members-row-label - All labels in the members container
.members-row-member - Rows containing a member
2021-01-01 06:48:35 +00:00
.members-row-role - Rows containing a role
.members-row-avatar - Contains the avatar for a row in the member list
### Settings
Settings are configured (for now) by editing abaddon.ini
This listing is organized by section.
For example, memory_db would be set by adding `memory_db = true` under the line `[discord]`
#### discord
* memory_db (true or false, default false) - if true, Discord data will be kept in memory as opposed to on disk
* token (string) - Discord token used to login, this can be set from the menu
* prefetch (true or false, default false) - if true, new messages will cause the avatar and image attachments to be automatically downloaded
#### http
* user_agent (string) - sets the user-agent to use in HTTP requests to the Discord API (not including media/images)
* concurrent (int, default 10) - how many images can be concurrently retrieved
#### gui
* member_list_discriminator (true or false, default true) - show user discriminators in the member list
* emojis (true or false, default true) - resolve unicode and custom emojis to images. this needs to be false to allow GTK to render emojis by itself
* css (string) - path to the main CSS file
* animations (true or false, default true) - use animated images where available (e.g. server icons, emojis, avatars). false means static images will be used
2020-09-09 22:32:45 +00:00
2021-01-01 06:48:35 +00:00
#### misc
* linkcolor (string) - color to use for links in messages