.. meta:: :description: Guide to building Krita from source. .. metadata-placeholder :authors: - Halla Rempt - Wolthera van Hövell tot Westerflier - images and latter parts by David Revoy :license: GNU free documentation license 1.3 or later. .. _building_krita: ========================== Building Krita from Source ========================== If you want to help developing Krita, you need to know how to build Krita yourself. If you merely want to run the latest version of Krita, to test a bug or play with, you can use the `nightly build for Windows `_ the `nightly build for Linux `_, or the `nightly build for MacOS `_. .. contents:: You can build Krita on Linux, Windows, MacOS and on Linux for Android. The libraries Krita needs (for instance to load and save various image types) are called dependencies. Linux is the easiest operating system to build Krita on because all the libraries that Krita needs are available on most recent Linux distributions. For an easy guide to building Krita see `Building Krita on Linux for Cats `_. On MacOS you can use tools like homebrew to get the dependencies, or build the dependencies manually. Building the dependencies manually is recommended because we have a number of changes to the source for libraries to make them function better with Krita. On Windows you will have to build the dependencies yourself. On all operating systems, you need to be familiar with using a terminal. Building Krita is a technical task and demands accuracy in following instructions and intelligence in understanding what happens. Building on Linux ----------------- Preparing your development environment ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_001-init-dir_001_by-deevad.jpg The most convenient layout is as follows: * $HOME/kritadev/krita -- the source code * $HOME/kritadev/build -- the location where you compile krita * $HOME/kritadev/install -- the location where you install krita to and run krita from we will call the "kritadev" folder your build root. Note: type in what's shown after '>' in the following commands .. code:: console you@yourcomputer:~>cd you@yourcomputer:~>mkdir kritadev you@yourcomputer:~/>cd kritadev you@yourcomputer:~/kritadev> mkdir build you@yourcomputer:~/kritadev> mkdir install Getting the Source Code ~~~~~~~~~~~~~~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_002-git-clone_001_by-deevad.jpg Open a terminal and enter the build root. Clone Krita from kde's git infrastructure (not github): .. code:: console you@yourcomputer:~/kritadev> git clone https://invent.kde.org/graphics/krita.git Configuring the Build ~~~~~~~~~~~~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_004-configure_001_by-deevad.jpg .. code:: console you@yourcomputer:~/kritadev> cd build Krita uses cmake (https://cmake.org) to define how Krita is built on various platforms. You first need to run cmake to generate the build system, in the :file:`kritadevs/build` directory, then run make to make Krita, then run make install to install krita. .. code:: you@yourcomputer:~/kritadev/build>cmake ../krita \ -DCMAKE_INSTALL_PREFIX=$HOME/kritadev/install \ -DCMAKE_BUILD_TYPE=Debug \ -DKRITA_DEVS=ON .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_003-get-libs_001_by-deevad.jpg Unless you have installed all the dependencies Krita needs, on first running cmake, cmake will complain about missing dependencies. For instance: .. code:: -- The following RECOMMENDED packages have not been found: * GSL, Required by Krita's Transform tool. This is not an error, and you can fix this by installing the missing package using your distribution's package manager. Do not download these packages manually from the source website and build them manually. Do use your distribution's package manager to find the right packages. For example, for Ubuntu, you can start with: .. code:: you@yourcomputer:~/kritadev/build>apt-get build-dep krita Which will install all the dependencies of the version of Krita in the repositories. You might need to enable the deb-src repositories by editing /etc/apt/sources.list (see https://help.ubuntu.com/community/Repositories/CommandLine) or, if you're using the KDE Plasma desktop, enabling them in the the Settings of the Discover application. However, the development version might use different dependencies, to find these, you can use ``apt-cache search``: .. code:: console you@yourcomputer:~/kritadev/build>apt-cache search quazip libquazip-dev - C++ wrapper for ZIP/UNZIP (development files, Qt4 build) libquazip-doc - C++ wrapper for ZIP/UNZIP (documentation) libquazip-headers - C++ wrapper for ZIP/UNZIP (development header files) libquazip1 - C++ wrapper for ZIP/UNZIP (Qt4 build) libquazip5-1 - C++ wrapper for ZIP/UNZIP (Qt5 build) libquazip5-dev - C++ wrapper for ZIP/UNZIP (development files, Qt5 build) libquazip5-headers - C++ wrapper for ZIP/UNZIP (development header files, Qt5 build) You will want to get the 'dev' library here, because you're doing dev, and then Krita is using Qt5, so select that one. If this doesn't help, check the `Ubuntu packages search `_. If all dependencies have been installed, cmake will output something like this: .. code:: console -- Configuring done -- Generating done -- Build files have been written to: /home/halla/dev/b-krita .. warning:: There is one run-time package that you need to install. CMake will not warn about it missing. That is the Qt5 SQLite database driver package. On Ubuntu this is named libqt5sql5-sqlite, the name might be different on other distributions. You need this to be able to start Krita after you have built and installed Krita! This is only needed if you build the master (5.0) branch of Krita. **Until that is shown, cmake has not succeeded and you cannot build Krita.** When this is shown, you can build Krita: .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_005-build_001_by-deevad.jpg .. code:: console you@yourcomputer:~/kritadev/build> make You can speed this up by enabling multithreading. To do so, you first figure out how many threads your processor can handle: .. code:: console cat /proc/cpuinfo | grep processor | wc -l Then, add the resulting number with -j (for 'Jobs') at the end, so for example: .. code:: console you@yourcomputer:~/kritadev/build> make -j4 Installing ~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_006-installing_by-deevad.jpg When the build has fully succeeded, you can install: .. code:: console you@yourcomputer:~/kritadev/build> make install And when that is complete, you can run Krita: .. code:: you@yourcomputer:~/kritadev/build>../install/bin/krita Running Krita ~~~~~~~~~~~~~ You do not have to set environment variables in order to run Krita. .. code:: console you@yourcomputer:~> cd ~/kritadev/ you@yourcomputer:~> ./i/bin/krita .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_008-running-success_by-deevad.jpg Updating ~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_009-want-update_by-deevad.jpg Now, Krita is in constant development, so you will want to update your build from time to time. Maybe a cool feature got in, or a bug was fixed, or you just want the latest source. .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_010-git-update_by-deevad.jpg First, we get the new source from the git repository: .. code:: console you@yourcomputer:~> cd ~/kritadev/krita/ you@yourcomputer:~/kritadev/krita> git pull If you want to get the code from a specific branch, you will need to ``checkout`` that branch first: .. code:: console you@yourcomputer:~/kritadev/krita> git checkout you@yourcomputer:~/kritadev/krita> git pull .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_011-git-update-success_by-deevad.jpg Then, we build again: .. code:: console you@yourcomputer:~/kritadev/krita> cd ~/kritadev/build/ you@yourcomputer:~/kritadev/build> make install If you update daily, you might want to automate these command by making your own minimal bash script. Trouble Shooting ~~~~~~~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_012-git-update-fail_by-deevad.jpg The recent development version might break, or sometime be just unusable. Experimental changes are made daily. This will affect your productivity if you don't know how to 'go back in time' (for example, your favorite brush doesn't work anymore). But if you know how to do it, *no issue can really affect you*, because you know how to come back to a previous state. .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_013_by-deevad.jpg To travel the source in time we need to read the timeline history. The terminal tool for it is ``git log``. .. code:: console you@yourcomputer:~> cd ~/kritadev/krita/ you@yourcomputer:~/kritadev/krita> git log With git log, you can consult all the last changes to the code, the 'commit'. What we're interested in is the long identification number, the 'git hash' (such as ``cca5819b19e0da3434192c5b352285b987a48796``). You can scroll the ``git log``, copy the ID number then quit(letter :kbd:`Q` on keyboard). Then time-travel in your source directory: .. code:: console you@yourcomputer:~/kritadev/krita> git checkout cca5819b19e0da3434192c5b352285b987a48796 you@yourcomputer:~/kritadev/krita> git pull And, we build again: .. code:: console you@yourcomputer:~/kritadev/krita> cd ~/kritadev/build/ you@yourcomputer:~/kritadev/build> make install .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_intro_by-deevad.jpg To update again to the actual and 'fresh from a minute ago' source-code named ``master``, simply ask git to come back to it with ``git checkout`` then ``pull`` to update : .. code:: console you@yourcomputer:~/kritadev/krita> git checkout master you@yourcomputer:~/kritadev/krita> git pull Common problems ~~~~~~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_012-git-update-fail_by-deevad.jpg Outside of the source being unstable, there's the following common problems: * The most common problem is a missing dependency. Install it. A missing dependency is not an "error" that you need to report to the other Krita developers. * A dependency can also be too old. CMake will report when the version of a dependency is too old. That is also not an "error". You might need to update your Linux installation to a newer version. * You can also have a successful build, then update your linux installation, and then find that Krita no longer builds. A library got updated, and you need to remove the ``CMakeCache.txt`` file in your build dir and run cmake again. * Sometimes, changes in Krita's source code from git revision to git revision make it necessary to make your installation and/or build dir empty and build from scratch. One example is where a plugin is removed from Krita; the plugin will be in your install dir, and won't get updated when Krita's internals change. Building on Windows ------------------- On Windows, you will have to build all the dependencies yourself. This will take a long time. Note that you will do all your work in a CMD command window. This is also more difficult than building Krita on Linux, so you need to pay attention to details. If you follow the guide closely, install correct dependencies and make sure your PATH doesn't contain anything unwanted, there should be no issues. Prerequisites ~~~~~~~~~~~~~ 1. Git - https://git-scm.com/downloads 2. CMake 3.3.2 or later - https://cmake.org/download/ - CMake 3.9 does not build Krita properly at the moment, please use 3.8 or 3.10 instead. 3. Make sure you have a compiler - Only mingw-w64 7.3 (by mingw-builds) - https://files.kde.org/krita/build/x86_64-7.3.0-release-posix-seh-rt_v5-rev0.7z - For threading, select posix. - For exceptions, select seh (64-bit) or dwarf (32-bit). - Unzip mingw with `7zip `_ into a folder like C:\mingw-w64; the full path must not contain any spaces. - MSVC is *not* supported at the moment. - CLANG is *not* supported at the moment. - MSYS is *not* supported at the moment. 4. You will also need a release of Python 3.8 (not 3.7, not 3.9) - https://www.python.org. - Make sure to have that version of python.exe in your path. This version of Python will be used for two things to configure Qt and to build the Python scripting module. Do not set PYTHONHOME or PYTHONPATH. - Make sure that your Python will have the correct architecture for the version you are trying to build. If building for 32-bit target, you need the 32-bit release of Python. 5. Install the Windows 10 SDK - https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/ 6. It is useful to install Qt Creator - https://download.qt.io/official_releases/qtcreator/ ***MAKE DOUBLE PLUS SURE YOU DO NOT HAVE ANY OTHER COMPILER OR DEVELOPMENT ENVIRONMENT OR PYTHON INSTALLATION IN YOUR PATH*** Preparation ~~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_001-init-dir_001_by-deevad.jpg After installing the Prerequisites, prepare your working directory. Keep this as short as possible. .. code:: console cd c:\ mkdir c:\dev mkdir c:\d mkdir c:\i Then prepare a batch file to set the environment. Every time you want to build or run your home-grown Krita, open the CMD windows, go to the c:\dev folder and run the env.bat file. Read this example and ADJUST THE VERSION NUMBERS where necessary so the PATH is correct. .. code:: console set DLLTOOL_EXE=C:\mingw-w64\x86_64-7.3.0-posix-seh-rt_v5-rev0\mingw64\bin\dlltool.exe set MINGW_GCC_BIN=C:\mingw-w64\x86_64-7.3.0-posix-seh-rt_v5-rev0\mingw64\\bin set MINGW_BIN_DIR=C:\mingw-w64\x86_64-7.3.0-posix-seh-rt_v5-rev0\mingw64\\bin set BUILDROOT=c:\dev set BUILDDIR_INSTALL=%BUILDROOT%\i set PATH=%BUILDROOT%\i\bin;%BUILDROOT%\i\lib;%MINGW_GCC_BIN%;C:\Program Files\CMake\bin;c:\qt\qtcreator-4.12.0\bin;%PATH% set "WindowsSdkDir=%ProgramFiles(x86)%\Windows Kits\10" set "WindowsSdkVerBinPath=%ProgramFiles(x86)%\Windows Kits\10\bin\10.0.17763.0" :: Since Krita 5.1 when using SIP5+ you also need to set up PYTHONPATH manually set PYTHONPATH=%BUILDROOT%\i\lib\site-packages;%PYTHONPATH% .. code:: console cd c:\dev env.bat Then get krita: .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_002-git-clone_001_by-deevad.jpg .. code:: console cd c:\dev git clone https://invent.kde.org/graphics/krita.git Getting the dependencies ~~~~~~~~~~~~~~~~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_003-get-libs_001_by-deevad.jpg Here we have two options. The quick one is to reuse prebuilt dependencies from the binary factory (you need to have the same version of the compiler locally as the one used on the binary factory). And the slow one is to build everything ourselves. Using prebuilt dependencies from the binary factory ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ To fetch prebuilt dependencies just run the embedded cmake script: .. code:: console cd c:\dev mkdir b cd b cmake ..\krita\build-tools\ci-deps -G "MinGW Makefiles" -DCMAKE_INSTALL_PREFIX=..\i cmake --build . Building dependencies yourself ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ We will build everything on Windows with the same script that is used to make the nightly builds and the releases: .. code:: console cd c:\dev krita\build-tools\windows\build.cmd --no-interactive --jobs 8 --skip-krita --src-dir c:\dev\krita --download-dir c:\dev\d --deps-build-dir c:\dev\b --deps-install-dir c:\dev\i This will take several hours, but you only need to do it once. When it's ready, make a zip archive of the c:\dev\i folder. That's a backup because we will install krita into the same folder as the dependencies, and if you need to nuke your krita build (because you're switching between branches or for some other reason, you'll also nuke your built dependencies. You can also build the depedencies into another folder, like c:\dev\i_deps, BUT in that case you're going to have trouble running Krita without first packaging it. Building Krita ~~~~~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_005-build_001_by-deevad.jpg Again, on the command line, with the same script that is used to make the nightly builds and the releases: .. code:: console cd c:\dev krita\build-tools\windows\build.cmd --no-interactive --jobs 8 --skip-deps --src-dir c:\dev\krita --download-dir c:\dev\d --deps-build-dir c:\dev\b --deps-install-dir c:\dev\is --krita-build-dir c:\dev\b_krita --krita-install-dir c:\dev\i If you are hacking on Krita, you can can rebuild Krita without running this script by entering the build directory and running mingw3-make install. .. code:: console cd c:\dev\b_krita mingw32-make install .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_006-installing_by-deevad.jpg Running Krita ~~~~~~~~~~~~~ You must start Krita from the command prompt, after having run env.bat: .. code:: console cd c:\dev\b_krita env.bat c:\dev\i\bin\krita.exe .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_008-running-success_by-deevad.jpg Building on MacOS ----------------- We will build Krita on MacOS with the same scripts that are used to build the nightly builds and the releases. We will *NOT* be building krita from within XCode, but from within the terminal. Prequisites ~~~~~~~~~~~ You will need to install: * CMake: https://cmake.org * XCode: get it from the app store * Qt Creator: https://download.qt.io/official_releases/qtcreator/ Preparation ~~~~~~~~~~~ Open Terminal.app .. code:: console cd mkdir dev cd dev git clone https://invent.kde.org/graphics/krita.git .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_002-git-clone_001_by-deevad.jpg Create an env.sh file that should contain the following lines: .. code:: console export BUILDROOT=$HOME/dev export PATH=/Applications/CMake.app/Contents/bin:$BUILDROOT/i/bin/:$PATH Building the dependencies ~~~~~~~~~~~~~~~~~~~~~~~~~ .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_003-get-libs_001_by-deevad.jpg It is possible to build Krita against dependencies installed through MacPorts or some similar packaging service. If you do that, you're on your own though. Open Terminal.app and source the env.sh file you just created: .. code:: console cd ~/dev . env.sh ./krita/packaging/macos/osxbuild.sh builddeps This will complain several time that it cannot find the Java SDK: just click that away, and don't worry. Building the dependencies will take several hours. Building Krita ~~~~~~~~~~~~~~ In the same terminal window (if you open a new one, you will have to *source* the env.sh script again by running ". env.sh" -- that's a dot. .. code:: console ./krita/packaging/macos/osxbuild.sh buildinstall This will build and install Krita to $HOME/dev/i/krita.app .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_006-installing_by-deevad.jpg Running Krita ~~~~~~~~~~~~~ You can run krita in the same terminal window: .. code:: console ~/dev/i/krita.app/Contents/MacOS/krita If you want to debug krita with lldb: .. code:: console lldb ~/dev/i/krita.app/Contents/MacOS/krita (lldb) target create "./i/bin/krita.app/Contents/MacOS/krita" Current executable set to './i/bin/krita.app/Contents/MacOS/krita' (x86_64). (lldb) r .. image:: /images/untranslatable/cat_guide/Krita-building_for-cats_008-running-success_by-deevad.jpg Building on Android ------------------- Use Linux to build Krita for Android. Building Krita for Android on another system is *NOT* supported. Setting up Android SDK and NDK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ We right now use Android NDK version ``r18b`` to do our builds. So, I would recommend to use that. Download it from `google's website `__ then extract it. Next, Android SDK. You can either download Android Studio or just the ``sdk-tools``. Both could be downloaded from `google's website `__. If you downloaded Android Studio then open SDK manager and download ``Android SDK Build-Tools``. (more info: https://developer.android.com/studio/intro/update#sdk-manager) If you download just ``sdk-tools``, then, extract it and run: .. code:: shell cd /tools/bin ./sdkmanager --licenses ./sdkmanager platform-tools ./sdkmanager "platforms;android-21" ./sdkmanager "platforms;android-28" # for androiddeployqt ./sdkmanager "build-tools;28.0.2" If you get some ``ClasNotFoundException`` it might be because ``java`` version is set to ``11``. For ``sdkmanager`` to work, set it to ``8`` and then run it again. That's the only dependency we have to manage manually! Building Krita ~~~~~~~~~~~~~~ Now, to build krita, run ``/packaging/android/androidbuild.sh --help`` and pass the required arguments. Example: .. code:: shell ./androidbuild.sh -p=all --src=/home/sh_zam/workspace/krita --build-type=Debug --build-root=/home/sh_zam/workspace/build-krita-android --ndk-path=/home/sh_zam/Android/Sdk/ndk-bundle --sdk-path=/home/sh_zam/Android/Sdk --api-level=21 --android-abi=armeabi-v7a Installing Krita APK ~~~~~~~~~~~~~~~~~~~~ To install run ``adb install -d -r /krita_build_apk/build/outputs/apk/debug/krita_build_apk-debug.apk``. ``adb`` should be in ``/platform-tools/`` Crash ~~~~~ If Krita crashes you can look up the logs using ``adb logcat`` Specialized Ways of Building Krita ---------------------------------- These are specialized ways of building Krita on Windows and Linux while re-using the dependencies built on KDE's binary factory. You only need to try this if you don't want to build Krita's dependencies yourself on Windows or use distribution dependencies on Linux. .. toctree:: :maxdepth: 1 :caption: Contents: :glob: building/*