Warning, /network/neochat/README.md is written in an unsupported language. File is not indexed.
0001 <!-- 0002 SPDX-FileCopyrightText: 2020-2021 Carl Schwan <carlschwan@kde.org> 0003 SPDX-FileCopyrightText: 2020-2021 Tobias Fella <tobias.fella@kde.org> 0004 SPDX-FileCopyrightText: 2023 James Graham <james.h.graham@protonmail.com> 0005 SPDX-License-Identifier: CC0-1.0 0006 --> 0007 0008 # NeoChat 0009 0010 A Qt/QML based Matrix client. 0011 0012 <a href='https://matrix.org'><img src='https://matrix.org/docs/legacy/made-for-matrix.png' alt='Made for Matrix' height=64 target=_blank /></a> 0013 <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> 0014 <a href='https://snapcraft.io/neochat'><img width='190px' alt='Download on the Snap Store' src='https://snapcraft.io/static/images/badges/en/snap-store-black.svg'/></a> 0015 0016 ## Introduction 0017 0018 NeoChat is a client for [Matrix](https://matrix.org), the decentralized communication protocol for instant 0019 messaging. It is a fork of Spectral, using KDE frameworks, most notably [Kirigami](https://invent.kde.org/frameworks/kirigami) 0020 to provide a convergent experience across multiple platforms. 0021 0022 NeoChat also make use of other KDE Frameworks as well as [libQuotient](https://github.com/quotient-im/libQuotient), a 0023 Qt-based SDK for the [Matrix Protocol](https://spec.matrix.org/). 0024 0025 ![Timeline](https://cdn.kde.org/screenshots/neochat/application.png) 0026 0027 ## Features 0028 0029 NeoChat aims to be a fully featured application for the Matrix specification. As such everything in the current stable specification with the notable exceptions 0030 of VoIP, threads and some aspects of End-to-End Encryption are supported. There are a few other smaller omissions due to the fact that the Matrix spec is constantly 0031 evolving but the aim remains to provide eventual support for the entire spec. 0032 0033 Due to the nature of the Matrix specification development NeoChat also supports numerous unstable features. Currently these are: 0034 - Polls - MSC3381 0035 - Sticker Packs - MSC2545 0036 - Location Events - MSC3488 0037 0038 ## Get it 0039 0040 Details where to find stable releases for NeoChat can be found on its [homepage](https://apps.kde.org/neochat). 0041 0042 In addition to the stable builds, unstable nightly builds are available for all platforms. These can be downloaded 0043 from the [binary factory](https://binary-factory.kde.org/). There are unstable versions for the following platforms 0044 in addition to stable ones: 0045 - Android 0046 - MacOS 0047 - Windows 0048 0049 Additionally the nightly Flatpak version can be obtained from the nightly Flatpak repo using the following commands in your terminal: 0050 0051 ``` 0052 flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo 0053 flatpak remote-add --if-not-exists kdeapps --from https://distribute.kde.org/kdeapps.flatpakrepo 0054 flatpak install kdeapps org.kde.neochat 0055 ``` 0056 0057 The unstable Android version can also be obtained from the [KDE nightly F-Droid repo](https://community.kde.org/Android/FDroid). 0058 0059 ## Running 0060 0061 Just start the executable in your preferred way - either from the build directory or from the installed location. 0062 0063 ## Building NeoChat 0064 0065 The best way to build KDE apps during development is to use `kdesrc-build`. The full instructions for this can be found on 0066 the KDE community website's get involved section under [development](https://community.kde.org/Get_Involved/development). This 0067 is primarily aimed at Linux development. 0068 0069 For Windows and Android [Craft](https://invent.kde.org/packaging/craft) is the primary choice. There are guides for setting up 0070 development environments for [Windows](https://community.kde.org/Get_Involved/development/Windows) and [Android](https://develop.kde.org/docs/packaging/android/building_applications/). 0071 0072 ## Tests 0073 0074 Tests are in the repository under [autotests](autotests) and should all pass for any contribution. 0075 0076 The project has CI setup to test new commits to the repository. All tests are expected to pass for a merge request to 0077 be complete. 0078 0079 Current build status 0080 0081 ![coverage](https://invent.kde.org/network/neochat/badges/master/pipeline.svg) 0082 0083 Currently the number of tests is limited, but growing. If anyone wants to help improve this, those 0084 contributions would be especially welcome. 0085 0086 ## Contributing 0087 0088 As is the case throughout the KDE ecosystem contributions are welcome from all. The code base is managed in the 0089 [NeoChat repository](https://invent.kde.org/network/neochat) of the KDE Gitlab instance. 0090 0091 - [Code of Conduct](https://kde.org/code-of-conduct) 0092 - [Report a Bug](https://bugs.kde.org/enter_bug.cgi?format=guided&product=neochat) 0093 - [Feature Request](https://community.kde.org/Infrastructure/GitLab#Submitting_a_merge_request) 0094 - [Create a Merge Request](https://community.kde.org/Infrastructure/GitLab#Submitting_a_merge_request) 0095 - [Translation](https://community.kde.org/Get_Involved/translation) 0096 0097 ## Contact 0098 0099 The best place to reach the maintainers is on the KDE Matrix instance in the NeoChat channel, [#neochat:kde.org](https://go.kde.org/matrix/#/#neochat:kde.org). See [Matrix](https://community.kde.org/Matrix) for more details. 0100 0101 ## Acknowledgement 0102 0103 This program utilizes [libQuotient](https://github.com/quotient-im/libQuotient/) as its Matrix SDK. 0104 0105 This program is a fork of [Spectral](https://gitlab.com/spectral-im/spectral/). 0106 0107 ## License 0108 0109 ![GPLv3](https://www.gnu.org/graphics/gplv3-127x51.png) 0110 0111 This program is licensed under GNU General Public License, Version 3. 0112