abaddon/README.md

80 lines
2.9 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-09-09 21:37:09 +00:00
1. `git clone https://github.com/lorpus/abaddon && cd abaddon`
2. `vcpkg install gtkmm:x64-windows nlohmann-json:x64-windows ixwebsocket:x64-windows cpr:x64-windows zlib:x64-windows simpleini:x64-windows`
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-09-09 21:37:09 +00:00
#### Mac:
1. Install gtkmm3 zlib openssl and nlohmann-json from homebrew
2. `git clone --recurse-submodules -j8 https://github.com/lorpus/abaddon`
3. `cd abaddon`
4. `mkdir build`
5. `cd build`
6. `cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DCMAKE_BUILD_TYPE=RelWithDebInfo -DUSE_PKGCONFIG=ON -DDISABLE_MBEDTLS=ON ../`
7. `make`
2020-09-05 05:09:46 +00:00
2020-09-09 21:37:09 +00:00
### Downloads (from CI):
- Windows: [here](https://ci.appveyor.com/project/lorpus/abaddon/build/artifacts)
- OSX: [here](https://i.owo.okinawa/travis-master/abaddon) (downloading css/ and res/ from here is still necessary)
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-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
2020-09-09 22:32:45 +00:00
.message-text - The TextView of a user message
.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
.members-row-role - Rows containing a role