Loki GUI

Copyright (c) 2018 The Loki Project

Portions Copyright (c) 2014-2018, The Monero Project

Development resources

• Web: loki.network
• Telegram: t.me/LokiCommunity
• Mail: team@loki.network
• GitHub: https://github.com/loki-project/loki
• Discord: https://discord.gg/67GXfD6

Introduction

Loki is a private cryptocurrency based on Monero. Over the course of the coming months, the Loki project aims to offer an incenvised full node layer with a secondary p2p network that offers a private communications layer based on the Signal protocol.

More information on the project can be found on the website and in the whitepaper.

Loki is an open source project, and we encourage contributions from anyone with something to offer. For more information on contributing, please contact team@loki.network

About this project

This is the GUI for the Loki implementation. It is open source and completely free to use without restrictions, except for those specified in the license agreement below. There are no restrictions on anyone creating an alternative implementation of Loki that uses the protocol and network in a compatible manner.

As with many development projects, the repository on Github is considered to be the "staging" area for the latest changes. Before changes are merged into that branch on the main repository, they are tested by individual developers in their own branches, submitted as a pull request, and then subsequently tested by contributors who focus on testing and code reviews. That having been said, the repository should be carefully considered before using it in a production environment, unless there is a patch in the repository for a particular show-stopping issue you are experiencing. It is generally a better idea to use a tagged release for stability.

Compiling the Loki GUI from source

On Linux:

(Tested on Ubuntu 16.04 x86, 16.10 x64, Gentoo x64 and Linux Mint 18 "Sarah" - Cinnamon x64)

1. Install Loki dependencies

• For Ubuntu and Mint

  sudo apt install build-essential cmake libboost-all-dev miniupnpc libunbound-dev graphviz doxygen libunwind8-dev pkg-config libssl-dev libzmq3-dev

• For Gentoo

  sudo emerge app-arch/xz-utils app-doc/doxygen dev-cpp/gtest dev-libs/boost dev-libs/expat dev-libs/openssl dev-util/cmake media-gfx/graphviz net-dns/unbound net-libs/ldns net-libs/miniupnpc net-libs/zeromq sys-libs/libunwind

2. Grab an up-to-date copy of the loki-gui repository

   git clone https://github.com/loki-project/loki-gui.git

3. Go into the repository

   cd loki-gui

4. Install the GUI dependencies from package manager, Qt 5.7.1 (or from qt.io). Please note, package managers may supply versions < 5.7.1 which will not compile. To get the build to look at your desired Qt version set your path to point to the qmake binary or any other solution otherwise, i.e.

   export PATH=<your path to Qt bin folder with qmake>:$PATH
   

   And can be verified using

   qmake -v
   

• For Ubuntu 16.04 x86

  sudo apt install qtbase5-dev qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtquick-controls2 qml-module-qt-labs-folderlistmodel qml-module-qtquick-xmllistmodel qttools5-dev-tools qml-module-qtquick-dialogs

• For Ubuntu 16.04+ x64

  sudo apt install qtbase5-dev qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtquick-xmllistmodel qttools5-dev-tools qml-module-qtquick-dialogs qml-module-qt-labs-settings libqt5qml-graphicaleffects

• For Linux Mint 18 "Sarah" - Cinnamon x64

  sudo apt install qml-module-qt-labs-settings qml-module-qtgraphicaleffects

• For Gentoo

  sudo emerge dev-qt/qtcore:5 dev-qt/qtdeclarative:5 dev-qt/qtquickcontrols:5 dev-qt/qtquickcontrols2:5 dev-qt/qtgraphicaleffects:5

• Optional : To build the flag WITH_SCANNER

  • For Ubuntu and Mint

    sudo apt install qtmultimedia5-dev qml-module-qtmultimedia libzbar-dev

  • For Gentoo

    The qml USE flag must be enabled.

    emerge dev-qt/qtmultimedia:5 media-gfx/zbar

5. Build the GUI

• For Ubuntu and Mint

  ./build.sh

• For Gentoo

  QT_SELECT=5 ./build.sh

The executable can be found in the build/release/bin folder.

On OS X:

1. Install Xcode from AppStore

2. Install Homebrew

3. Install Loki dependencies:

brew install boost --c++11

brew install openssl - to install openssl headers

brew install pkgconfig

brew install cmake

brew install zeromq

Note: If cmake can not find zmq.hpp file on OS X, installing zmq.hpp from https://github.com/zeromq/cppzmq to /usr/local/include should fix that error.

4. Install Qt:

brew install qt5 (or download QT 5.7.1+ from qt.io)

If you have an older version of Qt installed via homebrew, you can force it to use 5.x like so:

brew link --force --overwrite qt5

5. Add the Qt bin directory to your path

   Example: export PATH=$PATH:$HOME/Qt/5.8/clang_64/bin

   This is the directory where Qt 5.x is installed on your system

6. Grab an up-to-date copy of the loki-gui repository

git clone https://github.com/loki-project/loki-gui.git

7. Go into the repository

cd loki-gui

8. Start the build

./build.sh

The executable can be found in the build/release/bin folder.

Note: Workaround for "ERROR: Xcode not set up properly"

Edit $HOME/Qt/5.7/clang_64/mkspecs/features/mac/default_pre.prf

replace isEmpty($$list($$system("/usr/bin/xcrun -find xcrun 2>/dev/null")))

with isEmpty($$list($$system("/usr/bin/xcrun -find xcodebuild 2>/dev/null")))

More info: http://stackoverflow.com/a/35098040/1683164

On Windows:

The Loki GUI on Windows is 64 bits only; 32-bit Windows GUI builds are not officially supported anymore.

1. Install MSYS2, follow the instructions on that page on how to update system and packages to the latest versions

2. Open an 64-bit MSYS2 shell: Use the MSYS2 MinGW 64-bit shortcut, or use the msys2_shell.cmd batch file with a -mingw64 parameter

3. Install MSYS2 packages for Loki dependencies; the needed 64-bit packages have x86_64 in their names

   pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost mingw-w64-x86_64-openssl mingw-w64-x86_64-zeromq mingw-w64-x86_64-libsodium
   

   You find more details about those dependencies in the Loki documentation. Note that that there is no more need to compile Boost from source; like everything else, you can install it now with a MSYS2 package.

4. Install Qt5

   pacman -S mingw-w64-x86_64-qt5
   

   There is no more need to download some special installer from the Qt website, the standard MSYS2 package for Qt will do in almost all circumstances.

5. Install git

   pacman -S git
   

6. Clone repository

   cd
   git clone https://github.com/loki-project/loki-gui.git
   

7. Build

   cd loki-gui
   ./build.sh
   cd build
   make deploy
   

The executable can be found in the .\release\bin directory.