Desktop client for the Matrix protocol.
Go to file
Konstantinos Sideris 6aa635e4b9 Remove -march=native
[ci skip]
2017-12-12 09:48:04 +02:00
.ci Migrate to matrix-structs for event and response parsing 2017-12-04 18:41:19 +02:00
.github Update issue template 2017-11-02 22:02:31 +02:00
cmake Windows icon fix and change the installer to QT Installer Framework on Windows (#85) 2017-11-06 17:17:21 +02:00
deploy/installer Windows icon fix and change the installer to QT Installer Framework on Windows (#85) 2017-11-06 17:17:21 +02:00
dist Update ci 2017-11-06 17:20:48 +02:00
include Valgrind run 2017-12-12 09:31:00 +02:00
libs Add dialog to create rooms 2017-12-11 23:00:37 +02:00
resources Add dialog to create rooms 2017-12-11 23:00:37 +02:00
scripts Remove custom badge counter from mac and windows (#42) 2017-07-09 12:49:17 +03:00
src Valgrind run 2017-12-12 09:31:00 +02:00
.clang-format Use C++11 braced list style (#121) 2017-11-05 23:04:55 +02:00
.gitignore Add desktop icons on the AppImage 2017-11-26 21:32:18 +02:00
.gitmodules Initial integration with matrix-structs 2017-12-03 02:47:37 +02:00
.travis.yml Add debug info on travis builds 2017-12-10 13:14:47 +02:00
CMakeLists.txt Remove -march=native 2017-12-12 09:48:04 +02:00
LICENSE Initial commit 2017-04-06 02:06:42 +03:00
Makefile Add release target on the Makefile 2017-12-07 23:07:30 +02:00
README.md docs: Update required Clang version and Ubuntu 14.04 instructions (#150) 2017-12-06 18:29:09 +02:00
appveyor.yml Remove obsolete artifact from appveyor 2017-11-07 09:16:39 +02:00
default.nix Add basic nix expressions (#47) 2017-08-05 18:40:00 +03:00
package.nix Nix: ignore earlier build results 2017-08-05 18:56:41 +03:00

README.md

nheko

Build Status Build status Chat on Matrix License: GPL v3 AUR: nheko-git

The motivation behind the project is to provide a native desktop app for Matrix that feels more like a mainstream chat app (Riot, Telegram etc) and less like an IRC client.

Features

Most of the features you would expect from a chat application are missing right now but we are getting close to a more feature complete client. Specifically there is support for:

  • Joining & leaving rooms
  • Sending & receiving images and emoji.
  • Typing notifications.

Installation

There are pre-built nigtly releases here for Linux (AppImage), Mac and Windows.

Arch Linux

pacaur -S nheko-git

Fedora

sudo dnf copr enable xvitaly/matrix
sudo dnf install nheko

Gentoo Linux

sudo layman -a matrix
sudo emerge -a nheko

Build Requirements

  • Qt5 (5.7 or greater). Qt 5.7 adds support for color font rendering with Freetype, which is essential to properly support emoji.
  • CMake 3.1 or greater.
  • LMDB.
  • A compiler that supports C++11.
    • Clang 3.6 (or greater).
    • GCC 4.9.4 (or greater).
Arch Linux
sudo pacman -S qt5-base qt5-tools qt5-multimedia cmake gcc fontconfig lmdb
Gentoo Linux
sudo emerge -a ">=dev-qt/qtgui-5.7.1" media-libs/fontconfig
Ubuntu (e.g 14.04)
sudo add-apt-repository ppa:beineri/opt-qt592-trusty
sudo add-apt-repository ppa:george-edison55/cmake-3.x
sudo apt-get update
sudo apt-get install -y qt59base qt59tools qt59multimedia cmake liblmdb-dev

To build on Ubuntu 14.04 Trusty out-of-the-box requires using Clang 3.6 instead of GCC:

sudo apt-get install clang-3.6
export CC=clang-3.6 CXX=clang++-3.6

On Ubuntu 14.04 Trusty, it's possible to use GCC 4.9.4+, but it is not recommended, because it requires installing GCC packages from third-party PPAs. Later versions of Ubuntu that come with GCC 4.9.4+ should work with GCC out-of-the-box.

OSX (Xcode 8 or later)
brew update
brew install qt5 lmdb

N.B. you will need to pass -DCMAKE_PREFIX_PATH=/usr/local/opt/qt5 to cmake to point it at your qt5 install (tweaking the path as needed)

Building

Clone the repo with its submodules

git clone --recursive https://github.com/mujx/nheko

or

git clone https://github.com/mujx/nheko
cd nheko
git submodule update --init --recursive

and then use the following

cmake -H. -Bbuild -DCMAKE_BUILD_TYPE=Release # Default is Debug.
make -C build

The nheko binary will be located in the build directory.

Nix

Download the repo as mentioned above and run

nix-build

in the project folder. This will output a binary to result/bin/nheko.

You can also install nheko by running nix-env -f . -i

Contributing

Any kind of contribution to the project is greatly appreciated. You are also encouraged to open feature request issues.

Screens

Here is a screen shot to get a feel for the UI, but things will probably change.

nheko

Third party