qTox/INSTALL.md

Install Instructions

• Dependencies
• Linux
  • Simple install
    • Arch
    • Gentoo
    • Slackware
    • FreeBSD
  • Install git
    • Arch
    • Debian
    • Fedora
    • openSUSE
    • Ubuntu
  • Clone qTox
  • GCC, Qt, FFmpeg, OpanAL Soft and qrencode
    • Arch
    • Debian
    • Fedora
    • openSUSE
    • Slackware
    • Ubuntu >=15.04
    • Ubuntu >=16.04
  • toxcore dependencies
    • Arch
    • Debian
    • Fedora
    • openSUSE
    • Slackware
    • Ubuntu >=15.04
  • FFmpeg (Debian 8)
  • sqlcipher
  • Compile toxcore
  • Compile qTox
• OS X
• Windows
• Compile-time switches

Dependencies

Name	Version	Modules
Qt	>= 5.3.0	core, gui, network, opengl, sql, svg, widget, xml
GCC/MinGW	>= 4.8	C++11 enabled
toxcore	= 0.1.*	core, av
FFmpeg	>= 2.6.0	avformat, avdevice, avcodec, avutil, swscale
CMake	>= 2.8.11
OpenAL Soft	>= 1.16.0
qrencode	>= 3.0.3
sqlcipher	>= 3.2.0
pkg-config	>= 0.28

Optional dependencies

They can be disabled/enabled by passing arguments to cmake command when building qTox.

If they are missing, qTox is built without support for the functionality.

Linux

Auto-away support

Name	Version
libXScrnSaver	>= 1.2
libX11	>= 1.6.0

Disabled if dependencies are missing during compilation.

KDE Status Notifier / GTK tray backend

Name	Version
Atk	>= 2.14
Cairo
GdkPixbuf	>= 2.31
GLib	>= 2.0
GTK+	>= 2.0
Pango	>= 1.18

To disable: -DENABLE_STATUSNOTIFIER=False -DENABLE_GTK_SYSTRAY=False

Unity tray backend

Disabled by default.

Name	Version
Atk	>= 2.14
Cairo
DBus Menu	>= 0.6
GdkPixbuf	>= 2.31
GLib	>= 2.0
GTK+	>= 2.0
libappindicator	>= 0.4.92
Pango	>= 1.18

To enable: -DENABLE_APPINDICATOR=True

Linux

Simple install

Easy qTox install is provided for variety of distributions:

• Arch
• Gentoo
• Slackware

Community builds

There are community builds for wide range of distrubutions:

Link	Distros	Architecture
OBS	Arch, CentOS, Debian, Fedora, openSUSE, Ubuntu	x86, x86_64
Ubuntu PPA	Ubuntu	arm64, armhf, ppc64el

For release version, install qtox. To get latest changes, install qtox-alpha.

---

Arch

PKGBUILD is available in the community repo, to install:

pacman -S qtox

Gentoo

qTox is available in Gentoo.

To install:

emerge qtox

Slackware

qTox SlackBuild and all of its dependencies can be found here: http://slackbuilds.org/repository/14.1/network/qTox/

FreeBSD

A qTox port is available at net-im/qTox. To build and install qTox:

cd /usr/ports/net-im/qTox/
make install

---

If your distribution is not listed, or you want / need to compile qTox, there are provided instructions.

---

Most of the dependencies should be available through your package manger. You may either follow the directions below, or simply run ./simple_make.sh after cloning this repository, which will attempt to automatically download dependencies followed by compilation.

Install git

In order to clone the qTox repository you need Git.

Arch Linux

sudo pacman -S --needed git

Debian

sudo apt-get install git

Fedora

sudo dnf install git

openSUSE

sudo zypper install git

Ubuntu

sudo apt-get install git

Clone qTox

Afterwards open a new terminal, change to a directory of your choice and clone the repository:

cd /home/$USER/qTox
git clone https://github.com/qTox/qTox.git qTox

The following steps assumes that you cloned the repository at /home/$USER/qTox. If you decided to choose another location, replace corresponding parts.

GCC, Qt, FFmpeg, OpanAL Soft and qrencode

Arch Linux

sudo pacman -S --needed base-devel qt5 openal libxss qrencode ffmpeg

Debian

Note that only Debian >=8 stable (jessie) is supported.

If you use Debian 8, you have to compile FFmpeg manually and add backports to your sources.list. Adding backports: http://backports.debian.org/Instructions/

sudo apt-get install \
    build-essential \
    cmake \
    ffmpeg \
    libgdk-pixbuf2.0-dev \
    libglib2.0-dev \
    libgtk2.0-dev \
    libopenal-dev \
    libqrencode-dev \
    libqt5opengl5-dev \
    libqt5svg5-dev \
    libsqlcipher-dev \
    libxss-dev \
    pkg-config \
    qrencode \
    qt5-default \
    qt5-qmake \
    qttools5-dev \
    qttools5-dev-tools \
    yasm

Go to FFmpeg section to compile it.

Fedora

Note that sqlcipher is not included in all versions of Fedora yet. As of writing this section (November 2016), Fedora 25 ships sqlcipher, but Fedora 24 and older don't ship it yet. This means that if you can't install sqlcipher from repositories, you'll have to compile it yourself, otherwise compiling qTox will fail.

sudo dnf groupinstall "Development Tools" "C Development Tools and Libraries"
# (can also use sudo dnf install @"Development Tools")
sudo dnf install \
    ffmpeg-devel \
    gtk2-devel \
    libXScrnSaver-devel \
    libtool \
    openal-soft-devel \
    openssl-devel \
    qrencode-devel \
    qt-creator \
    qt-devel \
    qt-doc \
    qt5-linguist \
    qt5-qtsvg \
    qt5-qtsvg-devel \
    qtsingleapplication \
    sqlcipher \
    sqlcipher-devel

Go to sqlcipher section to compile it if necessary.

openSUSE

sudo zypper install \
    libQt5Concurrent-devel \
    libQt5Network-devel \
    libQt5OpenGL-devel \
    libQt5Sql-devel \
    libQt5Sql5-sqlite \
    libQt5Xml-devel \
    libXScrnSaver-devel \
    libffmpeg-devel \
    libqt5-linguist \
    libqt5-qtbase-common-devel \
    libqt5-qtsvg-devel \
    openal-soft-devel \
    patterns-openSUSE-devel_basis \
    qrencode-devel \
    sqlcipher-devel

Slackware

List of all the qTox dependencies and their SlackBuilds can be found here: http://slackbuilds.org/repository/14.1/network/qTox/

Ubuntu >=15.04

sudo apt-get install \
    build-essential cmake \
    libavcodec-ffmpeg-dev \
    libavdevice-ffmpeg-dev \
    libavfilter-ffmpeg-dev \
    libavutil-ffmpeg-dev \
    libgdk-pixbuf2.0-dev \
    libglib2.0-dev \
    libgtk2.0-dev \
    libopenal-dev \
    libqrencode-dev \
    libqt5opengl5-dev \
    libqt5svg5-dev \
    libsqlcipher-dev \
    libswresample-ffmpeg-dev \
    libswscale-ffmpeg-dev \
    libxss-dev \
    qrencode \
    qt5-default \
    qt5-qmake \
    qttools5-dev-tools

Ubuntu >=16.04:

sudo apt-get install \
    build-essential \
    cmake \
    libavcodec-dev \
    libavdevice-dev \
    libavfilter-dev \
    libavutil-dev \
    libgdk-pixbuf2.0-dev \
    libglib2.0-dev \
    libgtk2.0-dev \
    libopenal-dev \
    libqrencode-dev \
    libqt5opengl5-dev \
    libqt5svg5-dev \
    libsqlcipher-dev \
    libswresample-dev \
    libswscale-dev \
    libxss-dev \
    qrencode \
    qt5-default \
    qt5-qmake \
    qttools5-dev-tools

FFmpeg

If you have installed FFmpeg earlier (i.e. you don't run Debian 8), skip this section, and go directly to installing toxcore.

To get ffmpeg compiled and put in directory libs, run this script in qTox directory:

[ ! -e "libs" ] && mkdir libs   # create directory libs if doesn't exist
[ ! -e "ffmpeg" ] && mkdir ffmpeg

cd libs/
export PREFIX_DIR="$PWD"

cd ../ffmpeg
wget http://ffmpeg.org/releases/ffmpeg-3.2.2.tar.bz2
tar xf ffmpeg*
cd ffmpeg*


./configure --prefix="$PREFIX_DIR" \
            --enable-shared \
            --disable-static \
            --disable-programs \
            --disable-protocols \
            --disable-doc \
            --disable-sdl \
            --disable-avfilter \
            --disable-avresample \
            --disable-filters \
            --disable-iconv \
            --disable-network \
            --disable-muxers \
            --disable-postproc \
            --disable-swresample \
            --disable-swscale-alpha \
            --disable-dct \
            --disable-dwt \
            --disable-lsp \
            --disable-lzo \
            --disable-mdct \
            --disable-rdft \
            --disable-fft \
            --disable-faan \
            --disable-vaapi \
            --disable-vdpau \
            --disable-zlib \
            --disable-xlib \
            --disable-bzlib \
            --disable-lzma \
            --disable-encoders


make -j$(nproc)
make install

cd ../../

export PKG_CONFIG_PATH="$PWD/libs/lib/pkgconfig"

toxcore dependencies

Install all of the toxcore dependencies.

Arch Linux

sudo pacman -S --needed opus libvpx libsodium

Debian

sudo apt-get install libtool autotools-dev automake checkinstall check \
libopus-dev libvpx-dev libsodium-dev libavdevice-dev

Fedora

sudo dnf install libtool autoconf automake check check-devel libsodium-devel \
opus-devel libvpx-devel

openSUSE

sudo zypper install libsodium-devel libvpx-devel libopus-devel \
patterns-openSUSE-devel_basis

Slackware

List of all the toxcore dependencies and their SlackBuilds can be found here: http://slackbuilds.org/repository/14.1/network/toxcore/

Ubuntu >=15.04

sudo apt-get install libtool autotools-dev automake checkinstall check \
libopus-dev libvpx-dev libsodium-dev

sqlcipher

If you are not using an old version of Fedora, skip this section, and go directly to compiling toxcore.

git clone https://github.com/sqlcipher/sqlcipher
cd sqlcipher
./configure --enable-tempstore=yes CFLAGS="-DSQLITE_HAS_CODEC" \
    LDFLAGS="-lcrypto"
make
sudo make install
cd ..

Compile toxcore

Provided that you have all required dependencies installed, you can simply run:

git clone https://github.com/toktok/c-toxcore.git toxcore
cd toxcore
git checkout v0.1.2
autoreconf -if
./configure
make -j$(nproc)
sudo make install
echo '/usr/local/lib/' | sudo tee -a /etc/ld.so.conf.d/locallib.conf
sudo ldconfig

Compile qTox

Make sure that all the dependencies are installed. If you experience problems with compiling, it's most likely due to missing dependencies, so please make sure that you did install all of them.

Run in qTox directory to compile:

cmake .
make

If you had to compile FFmpeg manually, run this script from qTox directory before starting qTox:

cd libs/lib
export LD_LIBRARY_PATH="$PWD"
cd ../../

Now you can start compiled qTox with ./qtox

Congratulations, you've compiled qTox :)

Debian / Ubuntu / Mint

If the compiling process stops with a missing dependency like: ... libswscale/swscale.h missing try:

apt-file search libswscale/swscale.h

And install the package that provides the missing file. Start make again. Repeat if necessary until all dependencies are installed. If you can, please note down all additional dependencies you had to install that aren't listed here, and let us know what is missing ;)

---

Building packages

Alternately, qTox now has the experimental and probably-dodgy ability to package itself (in .deb form natively, and .rpm form with alien).

After installing the required dependencies, run bootstrap.sh and then run the buildPackages.sh script, found in the tools folder. It will automatically get the packages necessary for building .debs, so be prepared to type your password for sudo.

OS X

Supported OS X versions: >=10.8.

Compiling qTox on OS X for development requires 3 tools: Xcode, Qt 5.4+ and homebrew.

Automated Script

You can now set up your OS X system to compile qTox automatically thanks to the script in: ./osx/qTox-Mac-Deployer-ULTIMATE.sh

This script can be run independently of the qTox repo and is all that's needed to build from scratch on OS X.

To use this script you must launch terminal which can be found: Applications > Utilities > Terminal.app

If you wish to lean more you can run ./qTox-Mac-Deployer-ULTIMATE.sh -h

Note that the script will revert any non-committed changes to qTox repository during the update phase.

First Run / Install

If you are running the script for the first time you will want to make sure your system is ready. To do this simply run ./qTox-Mac-Deployer-ULTIMATE.sh -i to run you through the automated install set up.

After running the installation setup you are now ready to build qTox from source, to do this simply run: ./qTox-Mac-Deployer-ULTIMATE.sh -b

If there aren't any errors then you'll find a locally working qTox application in your home folder under ~/qTox-Mac_Build

Updating

If you want to update your application for testing purposes or you want to run a nightly build setup then run: ./qTox-Mac-Deployer-ULTIMATE.sh -u and follow the prompts. (NOTE: If you know you updated the repos before running this hit Y) followed by ./qTox-Mac-Deployer-ULTIMATE.sh -b to build the application once more. (NOTE: This will delete your previous build.)

Deploying

OS X requires an extra step to make the qTox.app file shareable on a system that doesn't have the required libraries installed already.

If you want to share the build you've made with your other friends who use OS X then simply run: ./qTox-Mac-Deployer-ULTIMATE.sh -d

Manual Compiling

Required Libraries

Install homebrew if you don't have it:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

First, let's install the dependencies available via brew.

brew install git ffmpeg qrencode libtool automake autoconf check qt5 libvpx \
opus sqlcipher libsodium

Next, install toxcore

Then, clone qTox:

git clone https://github.com/qTox/qTox

Finally, copy all required files. Whenever you update your brew packages, you may skip all of the above steps and simply run the following commands:

cd ./git/qTox
sudo bash bootstrap-osx.sh

Compiling

You can build qTox with Qt Creator seperate download or manually with cmake

With that; in your terminal you can compile qTox in the git dir:

cmake .
make

Or a cleaner method would be to:

cd ./git/dir/qTox
mkdir ./build
cd build
cmake ..

Deploying

If you compiled qTox properly you can now deploy the qTox.app that's created where you built qTox so you can distribute the package.

Using your qt5 homebrew installation from the build directory:

/usr/local/Cellar/qt5/5.5.1_2/bin/macdeployqt ./qTox.app

Running qTox

You've got 2 choices, either click on the qTox app that suddenly exists, or do the following:

qtox.app/Contents/MacOS/qtox

Enjoy the snazzy CLI output as your friends and family congratulate you on becoming a hacker

Windows

Qt

Download the Qt online installer for Windows from qt.io. While installation you have to assemble your Qt toolchain. Take the most recent version of Qt compiled with MinGW. Although the installer provides its own bundled MinGW compiler toolchain its recommend installing it separately because Qt is missing MSYS which is needed to compile and install OpenAL. Thus you can - if needed - deselect the tab Tools. The following steps assume that Qt is installed at C:\Qt. If you decided to choose another location, replace corresponding parts.

MinGW

Download the MinGW installer for Windows from sourceforge.net. Make sure to install MSYS (a set of Unix tools for Windows). The following steps assume that MinGW is installed at C:\MinGW. If you decided to choose another location, replace corresponding parts. Select mingw-developer-toolkit, mingw32-base, mingw32-gcc-g++, msys-base and mingw32-pthreads-w32 packages using MinGW Installation Manager (mingw-get.exe). Check that the version of MinGW, corresponds to the version of the QT component!

Wget

Download the Wget installer for Windows from http://gnuwin32.sourceforge.net/packages/wget.htm. Install them. The following steps assume that Wget is installed at C:\Program Files\GnuWin32\. If you decided to choose another location, replace corresponding parts.

UnZip

Download the UnZip installer for Windows from http://gnuwin32.sourceforge.net/packages/unzip.htm. Install it. The following steps assume that UnZip is installed at C:\Program Files\GnuWin32\. If you decided to choose another location, replace corresponding parts.

Setting up Path

Add MinGW/MSYS/CMake binaries to the system path to make them globally accessible. Open Control Panel -> System and Security -> System -> Advanced system settings -> Environment Variables... (or run sysdm.cpl select tab Advanced system settings -> button Environment Variables). In the second box search for the PATH variable and press Edit.... The input box Variable value: should already contain some directories. Each directory is separated with a semicolon. Extend the input box by adding ;C:\MinGW\bin;C:\MinGW\msys\1.0\bin;C:\Program Files (x86)\CMake 2.8\bin;C:\Program Files\GnuWin32\bin;C:\Program Files (x86)\GnuWin32\bin. The very first semicolon must only be added if it is missing. CMake may be added by installer automatically. Make sure that paths containing alternative sh, bash implementations such as C:\Program Files\OpenSSH\bin are at the end of PATH or build may fail.

Cloning the Repository

Clone the repository (https://github.com/qTox/qTox.git) with your preferred Git client. SmartGit is very nice for this task (you may need to add the path to the git.exe system variable Path). The following steps assume that you cloned the repository at C:\qTox. If you decided to choose another location, replace corresponding parts.

Getting dependencies

Run bootstrap.bat in cloned C:\qTox directory. Script will download rest of dependencies compile them and put to appropriate directories.

Compile-time switches

They are passed as an argument to cmake command. E.g. with a switch SWITCH that has value YES it would be passed to cmake in a following manner:

cmake -DSWITCH=yes

Switches:

• SMILEYS, values:
  • if not defined or an unsupported value is passed, all emoticon packs are included
  • DISABLED – don't include any emoticon packs, custom ones are still loaded
  • MIN – minimal support for emoticons, only a single emoticon pack is included