jami-client-qt/INSTALL.md

Build instructions

There is basically two ways to build client-qt:

• Use build.py script which will build all Jami (daemon/client lib/client-qt)
• Build only this client.

Disclaimer

Because the client-qt is multi-platforms and supporting macOS, we need a recent version of Qt to do rendering with Metal. So, Qt 6.2 is necessary. This version is generally not packaged on a lot of platforms, and to control available plugins and such, we have our own Qt packaged (generated by https://review.jami.net/jami-project and available on https://jami.net on the distributions we support). So, you will need to get Qt 6.2 first. For this, there is 3 methods:

Qt from https://jami.net (recommended)

If your distribution is supported, we provide a Qt package (libqt-jami) on our repo. Follow instructions https://jami.net/download-jami-linux/ (but instead installing jami install libqt-jami). The files will be installed in /usr/lib/libqt-jami.

Qt from your distribution

If Qt 6.2 is available, you can use the packages from your distribution:

It should be (For now qt5 only is packaged by distributions, so names can change).

Dependencies, Debian based

sudo apt-get install cmake make doxygen g++ gettext libnotify-dev pandoc nasm libqrencode-dev \
                     libnotify-dev libnm-dev \
                     qtbase6-dev \
                     qtmultimedia5-dev libqt6svg6-dev qtwebengine6-dev qtdeclarative6-dev \
                     qtquickcontrols2-6-dev qml-module-qtquick2 qml-module-qtquick-controls \
                     qml-module-qtquick-controls2 qml-module-qtquick-dialogs \
                     qml-module-qtquick-layouts qml-module-qtquick-privatewidgets \
                     qml-module-qtquick-shapes qml-module-qtquick-window2 \
                     qml-module-qtquick-templates2 qml-module-qt-labs-platform \
                     qml-module-qtwebengine qml-module-qtwebchannel \
                     qml-module-qt-labs-qmlmodels

Dependencies, Fedora based

sudo dnf install qt6-qtsvg-devel qt6-qtwebengine-devel qt6-qtmultimedia-devel qt6-qtdeclarative-devel qt6-qtquickcontrols2-devel qt6-qtquickcontrols qrencode-devel NetworkManager-libnm-devel

Qt from sources

https://www.qt.io/product/qt6

GNU/Linux

Then, you can build the project

With build.py

git clone https://review.jami.net/jami-project

Jami installer uses python3. If it's not installed, please install it:

cd jami-project/
./build.py --init

Then you will need to install dependencies:

• For GNU/Linux

./build.py --dependencies --qt # needs sudo

Then, you can build daemon and the client with:

./build.py --install --qt

And you will have the daemon in daemon/bin/jamid and the client in client-qt/build-local/jami-qt. You also can run it with

If you use a Qt version that is not wide-system installed you need to specify its path after the --qt flag, i. e., `./build.py --install --qt /home//Qt/6.2.1/gcc_64

./build.py --run --qt

Notes:

• --global-install to install client-qt globally under /usr/local
• --prefix to change the destination of the install.

Build only the client

In order to use the Qt Client it is necessary to have the Qt version 6.2 or higher. If your system does not have it you can install it from sources or download the binary installer.

Build only this repository

Clone with common required submodule (platform specific submodules will be cloned during the configure step)

git clone https://review.jami.net/jami-client-qt
cd jami-client-qt
git submodule update --recursive --init

Use CMake to build

# In this repository
mkdir build
cd build
cmake ..
make -j

cmake can take some options:

e.g. (with Qt version from https://jami.net)

cmake .. -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=jami-project/install/client-qt -DCMAKE_PREFIX_PATH=/usr/lib/libqt-jami

After the build has finished, you are finally ready to launch jami-qt in your build directory.

If you want to install it to the path provided by CMAKE_INSTALL_PREFIX you can run:

make install

Building on native Windows

Only 64-bit MSVC build can be compiled.

Setup Before Building:

• Download Qt (Open Source)

• Using the online installer, install the following Qt 6.2.3 components:

  • MSVC 2019 64-bit
  • Qt 5 Compatibility Module
  • Additional Libraries
    • Qt Multimedia
    • Qt Network Authorization
    • Qt WebChannel
    • Qt WebEngine
    • Qt WebSockets
    • Qt WebView

• Download Visual Studio (version >= 2019). Note: version 2022 does not work.

• Install Qt Vs Tools under extensions, and configure msvc2017_64 path under Qt Options

  	Qt Version	SDK	Toolset
  Minimum requirement:	6.2.3	10.0.16299.0	V142

• Install Python3 for Windows

• Using Elevated Command Prompt

    python build.py --dependencies

Note:

1. This command will install chocolatey which may require you to restart the Command Prompt to be able to use it.
2. This command will install msys2 (64 bit) by using chocolatey command which may cause issues below:
   a. Choco may require you to restart the Command Prompt after finishing installing msys2.
   b. Only if you have already installed msys2 (64 bit) under the default installation folder, we will use the existing one.
3. This command will install strawberry perl by using chocolatey command which may fail if you have already installed it.
4. This command will install cmake by using chocolatey command which will not add cmake into PATH (environment variable).
   

The issue 1, 2(a), 3 can be solved by restarting the Command Prompt under Administrator right and re-run the command.
The issue 3 can be solved by uninstalling your current strawberry perl and re-run the command.
The issue 4 can be solved by adding the location of the cmake.exe into PATH.

• Using a new Non-Elevated Command Prompt

    python build.py --install

Note: If you have another version than qt 6.2.3 installed this step will build daemon correctly but will fail for the client. When that happens you need to compile the client separately:

    python build.py --install
    cd client-qt
    python build.py init
    python build.py --qtver <your qt version>

• Then you should be able to use the Visual Studio Solution file in client-qt folder (Configuration = Release, Platform = x64)

Build Module Individually

• Jami-qt also support building each module (daemon, jami-qt) seperately

Daemon

• Make sure that dependencies is built by make-ring.py
• On MSVC folder (jami-project\daemon\MSVC):

    cmake -DCMAKE_CONFIGURATION_TYPES="ReleaseLib_win32" -DCMAKE_VS_PLATFORM_NAME="x64" -G "Visual Studio 16 2019" -A x64 -T '$(DefaultPlatformToolset)' ..
    python winmake.py -b daemon

• This will generate a .lib file in the path of ring-project\daemon\MSVC\x64\ReleaseLib_win32\bin

Note: each dependencies contrib for daemon can also be updated individually
For example:

    python winmake.py -b opendht

Jami-qt

• Make sure that daemon, is built first

    cd client-qt
    python build.py init
    python build.py

Note: if your qt version is different than 6.2.3, you need to use python build.py --qtver <your qt version>.

Building On MacOS

Set up

• macOS minimum version 10.15
• install python3
• download xcode
• install Qt 6.2

Qt 6.2 can be installed via brew

brew install qt

or downloaded from Qt (Open Source)

Then, you can build the project

Build with build.py

git clone https://review.jami.net/jami-project
 cd jami-project
./build.py --init
./build.py --dependencies --qt
./build.py --install --qt

If you use a Qt version that is installed in a different than standard location you need to specify its path

./build.py --install --qt QT_ROOT_DIRECTORY=your_qt_directory

Built client could be find in client-qt/build-local/Jami

Packaging On Native Windows

• To be able to generate a msi package, first download and install Wixtoolset.
• In Visual Studio, download WiX Toolset Visual Studio Extension.
• Build client-qt project first, then the JamiInstaller project, msi package should be stored in jami-project\client-qt\JamiInstaller\bin\Release

Testing for Client-qt on Windows

• We currently use GoogleTest and Qt Quick Test in our product. To build and run tests, you could use the following command.

    python build.py [runtests, pack]

• Note that, for tests, the path of local storage files for jami will be changed based on following environment variables.

    %JAMI_DATA_HOME% = %TEMP% + '\\jami_test\\jami'
    %JAMI_CONFIG_HOME% = %TEMP% + '\\jami_test\\.config'
    %JAMI_CACHE_HOME% = %TEMP% + '\\jami_test\\.cache'

• These environment variables will be temporarily set when using make-client.py to run tests.

Debugging

Compile the client with BUILD=Debug and compile LibRingClient with -DCMAKE_BUILD_TYPE=Debug

Then, if you want to enable logging when running jami-qt launch it with -d or --debug