nheko

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.
• Receiving typing notifications.

Installation

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

Windows

You can find an installer here.

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.3 (or greater).
  • GCC 4.8 (or greater).

Arch Linux

sudo pacman -S qt5-base qt5-tools 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-qt58-trusty
sudo add-apt-repository ppa:george-edison55/cmake-3.x
sudo apt-get update
sudo apt-get install qt58base qt58tools cmake liblmdb-dev

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

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.

MacOS

You can create an app bundle with make app. The output will be located at dist/MacOS/Nheko.app which can be copied to /Applications/Nheko.app.

You can also create a disk image with make dmg. The output will be located at dist/MacOS/Nheko.dmg

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.

Third party

• Emoji One
• Font Awesome
• Open Sans