rnhmjoj
/
nheko
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Desktop client for the Matrix protocol.
170 Commits 7 Branches 19 Tags 48 MiB
C++ 87.6%
QML 9%
Python 1.5%
CMake 1.1%
Shell 0.5%
Go to file
Konstantinos Sideris 4fccc6270e Fix full screen image viewer on macOS sierra 2017-08-06 10:35:32 +03:00
.ci Update readme and travis for lmdb 2017-07-30 14:30:55 +03:00
dist Linting 2017-07-09 22:27:20 +03:00
include Fix full screen image viewer on macOS sierra 2017-08-06 10:35:32 +03:00
libs Initial support for state cache 2017-07-30 14:30:55 +03:00
resources Remove custom badge counter from mac and windows (#42) 2017-07-09 12:49:17 +03:00
scripts Remove custom badge counter from mac and windows (#42) 2017-07-09 12:49:17 +03:00
src Fix full screen image viewer on macOS sierra 2017-08-06 10:35:32 +03:00
tests Add serialization on matrix events 2017-07-30 14:30:55 +03:00
.clang-format Initial commit 2017-04-06 02:06:42 +03:00
.gitignore Add basic nix expressions (#47) 2017-08-05 18:40:00 +03:00
.gitmodules Initial support for state cache 2017-07-30 14:30:55 +03:00
.travis.yml Drop support for XCode 7 2017-08-05 18:15:43 +03:00
CMakeLists.txt Include lmdb header 2017-08-05 16:28:07 +03:00
LICENSE Initial commit 2017-04-06 02:06:42 +03:00
Makefile Remove hardcoded font sizes, margins etc 2017-07-01 12:46:58 +03:00
README.md Add basic nix expressions (#47) 2017-08-05 18:40:00 +03:00
appveyor.yml Add nsis setup generator 2017-04-25 18:11:32 +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 Translation Status

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.

Join the discussion on Matrix #nheko:matrix.org.

Features

Most of the features you'd expect from a chat application are missing right now but you can of course receive and send messages in the rooms that you are a member of.

Installation

Arch Linux

pacaur -S nheko-git

Gentoo Linux

sudo layman -a matrix
sudo emerge -a nheko

Windows

You can find a NSIS 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.

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

License

GPLv3