README.md
1
2# ruqola
3
4Ruqola is a Rocket.Chat client for the KDE desktop.
5
6## Features
7
8It supports RC feature:
9- Direct Message
10- group channel
11- channel
12- Support autotranslate (when RC has it)
13- Configuring room notification
14- Configuring room
15- Thread message support
16- Discussion room
17- Teams room support
18- Configuring own account
19- Registering new account
20- Support multi account
21- Search message in room.
22- Show mention/attachment/Pinned message/start message
23- Support emoji
24- Video support
25- Configure administrator support (add/remove roles, add/remove users, add/remove permissions, configure rooms etc.)
26- Support OTR (in progress)
27- support gif image
28- Add support for uploading attachment files.
29- Show unread message information
30- Allow to block/unblock users
31- Auto-away
32
33Extra features:
34- Allow to reply directly to message from notification (kde features)
35- Dnd image from ruqola to website or local folder
36- Store message in local database so we can search in offline
37
38
39
40## Source Code
41
42You can get ruqola from:
43
44- <https://github.com/KDE/ruqola>
45- git@invent.kde.org:network/ruqola.git
46- https://invent.kde.org/network/ruqola.git
47
48## Requirements
49
50`cmake`, `cmake-extra-tools`, `qt5-websockets`, `qt5-networkauth`, `qt5-multimedia`, `kwidgetaddons`, `ki18n`, `kcrash`, `kcoreaddons`, `syntaxhighlighting`, `sonnet`, `textwidgets`, `notifyconfig`, `kio`, `iconthemes`, `xmlgui`
51
52## How to build ruqola
53
54````bash
55mkdir build
56cd build
57cmake ..
58make
59make install
60````
61or using CMakePresets support (need cmake > 3.20)
62````
63cmake --preset dev && cmake --build --preset dev
64````
65
66## ASAN
67
68We can use sanitizers.supp file
69example: LSAN_OPTIONS=suppressions=../sanitizers.supp ./bin/ruqolaserverconfigtest
70
71## Maintainer
72
73- Laurent Montel <montel@kde.org>
74
75
README.md.license
1SPDX-FileCopyrightText: 2017 Riccardo Iaconelli <riccardo@kde.org>
2SPDX-License-Identifier: CC0-1.0
3