OpenToonz - An open-source full-featured 2D animation creation software
Setting up the development environment for GNU/Linux
Required software
Building OpenToonz from source requires the following dependencies:
- Git
- GCC or Clang
- CMake (3.10 or newer)
- Qt 5.x (5.15 or newer)
- Boost (1.55 or newer)
- LibPNG
- SuperLU
- Lzo2
- FreeType
- LibMyPaint (1.3 or newer)
- Jpeg-Turbo (1.4 or newer)
- OpenCV 3.2 or newer
Installing Dependencies on Debian / Ubuntu
$sudo apt-get install build-essential git cmake pkg-config libboost-all-dev qtbase5-dev libqt5svg5-dev qtscript5-dev qttools5-dev qttools5-dev-tools libqt5opengl5-dev qtmultimedia5-dev libqt5multimedia5-plugins libqt5serialport5-dev libsuperlu-dev liblz4-dev libusb-1.0-0-dev liblzo2-dev libpng-dev libjpeg-dev libglew-dev freeglut3-dev libfreetype6-dev libjson-c-dev qtwayland5 libmypaint-dev libopencv-dev libturbojpeg-dev
For newest versions of OS you may install libmypaint from repository and don't need to build it from source:
$ sudo apt-get install libmypaint-dev
Notes:
- It's possible we also need
libgsl2(or maybelibopenblas-dev) - We may also need
libegl1-mesa-dev libgles2-mesa-dev libglib2.0-dev liblzma-dev - For Qt, MyPaint and OpenCV, you can alternatively build and install from source.
Installing Dependencies on Fedora
This is the same dependency set used by the Fedora job in
.github/workflows/workflow_linux.yml, so it is verified on every push.
$ sudo dnf install gcc gcc-c++ automake libtool make git cmake ninja-build boost boost-devel SuperLU SuperLU-devel lz4-devel xz-devel libusb1-devel lzo-devel libjpeg-turbo-devel turbojpeg-devel glew glew-devel freeglut freeglut-devel freetype-devel libpng-devel blas blas-devel json-c-devel opencv-devel libmypaint-devel qt5-qtbase-devel qt5-qtsvg qt5-qtsvg-devel qt5-qtscript qt5-qtscript-devel qt5-qttools qt5-qttools-devel qt5-qttools-static qt5-qtmultimedia qt5-qtmultimedia-devel qt5-qtserialport-devel qt5-qtwayland pkgconf-pkg-config
libmypaint-devel is included above, so there is no need to build libmypaint
from source on Fedora.
Installing Dependencies on ArchLinux
$ sudo pacman -S base-devel git cmake boost boost-libs qt5-base qt5-svg qt5-script qt5-tools qt5-multimedia lz4 libusb lzo libjpeg-turbo glew freeglut freetype2
$ sudo pacman -S blas cblas
From AUR, using eg. yaourt:
$ yaourt -S superlu libmypaint
Notes:
- ArchLinux has
blassplit intoblasandcblas.
Installing Dependencies on openSUSE
$ zypper in boost-devel cmake freeglut-devel freetype2-devel gcc-c++ glew-devel libQt5OpenGL-devel libjpeg-devel liblz4-devel libpng16-compat-devel libqt5-linguist-devel libqt5-qtbase-devel libqt5-qtmultimedia-devel libqt5-qtscript-devel libqt5-qtsvg-devel libtiff-devel libusb-devel lzo-devel openblas-devel pkgconfig sed superlu-devel zlib-devel json-c-devel libqt5-qtmultimedia
For newest versions of OS you may install libmypaint from repository and don't need to build it from source:
$ zypper install libmypaint-devel
Build libmypaint dependency
If your linux distributions does not have libmypaint package, then build it from the source:
$ git clone https://github.com/mypaint/libmypaint.git -b v1.3.0
$ cd libmypaint
$ ./autogen.sh
$ ./configure
$ make
$ sudo make install
$ sudo ldconfig
$ cd ..
Build instructions
Cloning the GIT Tree
$ git clone https://github.com/opentoonz/opentoonz
Copying the 'stuff' Directory
TODO: some parts should really be installed in $prefix/ instead... and some other in various cache or user-local places. cf. https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html Until then we just follow the Win32/OSX layout.
The ~/.config/OpenToonz/ directory contains your settings, work and other files.
Initialize this path with the following commands:
$ mkdir -p $HOME/.config/OpenToonz
$ cp -r opentoonz/stuff $HOME/.config/OpenToonz/
Currently this is required to run OpenToonz.
Building LibTIFF
TODO: make sure we can use the system libtiff instead and remove this section. Features from the modified libtiff are needed currently, so this isn't a simple switch.
$ cd opentoonz/thirdparty/tiff-4.0.3
$ ./configure --with-pic --disable-jbig
$ make -j$(nproc)
$ cd ../../
Building OpenToonz
$ cd toonz
$ mkdir build
$ cd build
$ cmake ../sources
$ make -j$(nproc)
The build takes a lot of time, be patient.
CMake may not pick up all the required dependencies. If SuperLU is not found, point CMake at it explicitly:
$ cmake ../sources/ -DSUPERLU_INCLUDE_DIR=/usr/include/SuperLU
On current Fedora this is not needed; SuperLU is detected automatically.
Troubleshooting Build Errors
If something doesn't compile or link, please run make this way to help spot the problem:
$ LANG=C make VERBOSE=1
Debug Build
If you need to debug the application, you should be able to use cmake -DCMAKE_BUILD_TYPE=Debug.
Running OpenToonz
You can now run the application:
$ LD_LIBRARY_PATH=./lib/opentoonz:$LD_LIBRARY_PATH
$ ./bin/OpenToonz
Performing a System Installation
The steps above show how to run OpenToonz from the build directory, however you may wish to install OpenToonz onto your system.
OpenToonz will install to /opt/opentoonz by default, to do this run:
$ sudo make install
Then you can launch OpenToonz by running /opt/opentoonz/bin/opentoonz.
You can change the installation path by modifying the CMAKE_INSTALL_PREFIX CMake variable.
Linux Package Definitions
It may be helpful to use existing packages as a reference when creating a package for your own distribution.
ArchLinux (AUR): https://aur.archlinux.org/packages/opentoonz-git/
App-Image (Portable): https://github.com/morevnaproject/morevna-builds
Translation workflow
See Contributing and maintaining translations
for editing/submitting .ts files, explicit extraction targets, manual lrelease,
and package/runtime paths. Translation-only edits may not refresh catalogs through
an otherwise no-op application build; confirm the affected .qm was regenerated.