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