network/neochat/README.md

0001 <!--
0002     SPDX-FileCopyrightText: 2020-2021 Carl Schwan <carlschwan@kde.org>
0003     SPDX-FileCopyrightText: 2020-2021 Tobias Fella <tobias.fella@kde.org>
0004     SPDX-License-Identifier: CC0-1.0
0005 -->
0006 # NeoChat
0007
0008 NeoChat is a client for Matrix, the decentralized communication protocol for instant
0009 messaging. It is a fork of Spectral, using KDE frameworks, most notably Kirigami,
0010 KConfig and KI18n.
0011
0012 <a href='https://flathub.org/apps/details/org.kde.neochat'><img width='190px' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a>
0013
0014
0015 ## Get it
0016
0017 A stable release [is available](https://apps.kde.org/neochat) for download for Linux distributions.
0018
0019
0020 Along with the stable release, a Flatpak version is available for the nightly
0021 version:
0022
0023 ```
0024 flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
0025 flatpak remote-add --if-not-exists kdeapps --from https://distribute.kde.org/kdeapps.flatpakrepo
0026 flatpak install kdeapps org.kde.neochat
0027 ```
0028
0029 A nightly build is also available for Android in the [KDE nightly F-Droid repo](https://community.kde.org/Android/FDroid)
0030 and can also directly be downloaded from the [binary factory](https://binary-factory.kde.org/view/Android/job/NeoChat_Nightly_android-arm64/).
0031
0032 Nightly builds for [Windows](https://binary-factory.kde.org/job/NeoChat_Nightly_win64/), [MacOS](https://binary-factory.kde.org/job/NeoChat_Nightly_macos/) and [AppImages](https://binary-factory.kde.org/job/NeoChat_Nightly_appimage/) can also be downloaded from the [binary factory](https://binary-factory.kde.org/search/?q=neochat).
0033
0034 ![Timeline](https://cdn.kde.org/screenshots/neochat/application.png)
0035
0036 ## Features
0037
0038 * Sending messages
0039 * Sending files from clipboard and filesystem
0040 * Reply to message (right-click on a message to access menu)
0041 * Start a private chat (but not encrypted)
0042 * Show notifications, for the moment there is only a global switch
0043 to disable it. We plan to implement the configuration part of the
0044 specification soon.
0045 * Autocompletion of usernames in chat
0046 * Emoji picker
0047 * Basic room setting page
0048 * Send and accept invitations
0049 * /rainbow <message> (very important)
0050 * /me <message>
0051
0052 NeoChat is still missing a few features to become a full-featured
0053 Matrix client (most notably encryption support and video chat support).
0054 We welcome contributions in this direction.
0055
0056 ## Contact
0057
0058 You can reach the maintainers at [#neochat:kde.org](https://matrix.to/#/#neochat:kde.org), if you are already on Matrix.
0059 Development happens in http://invent.kde.org/network/neochat (not in GitHub).
0060
0061 ## Acknowledgement
0062
0063 This program utilizes [libQuotient](https://github.com/quotient-im/libQuotient/)
0064 library and some C++ models from [Quaternion](https://github.com/quotient-im/Quaternion/).
0065
0066 This program is a fork of [Spectral](https://gitlab.com/spectral-im/spectral/).
0067
0068 ## License
0069
0070 ![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png)
0071
0072 This program is licensed under GNU General Public License, Version 3.
0073