Getting started » Downloading and building plugins

Guide how to download and build plugins for the Magnum engine.

Plugins provide additional capability for the Magnum engine in terms of importing and exporting various media file formats. They are not needed for essential usage, but you might want them sooner or later when you would want to use an image as a texture or render text on the screen.

Prepared packages

The easiest way to install Magnum Plugins is to use one of the ready-made packages for your platform of choice. See Manual build if you want to have more control. Cross-compiling is very similar to cross-compiling of Magnum itself.

Vcpkg package

Magnum Plugins are available as a Vcpkg package. See the Magnum Vcpkg documentation for a more detailed introduction and a troubleshooting guide. Installing latest stable version of Magnum Plugins with all its dependencies is done like this:

vcpkg install magnum-plugins

Note that just a subset of plugins is installed by default. To opt-in or opt-out of additional features, you can use the following syntax; feature names are simply names of CMake WITH_* options from the Enabling or disabling features section but lowercase, e.g.:

vcpkg install magnum-plugins[assimpimporter,ddsimporter]

To install all features of a package, use *, e.g.:

vcpkg install magnum-plugins[*]

There are also Vcpkg packages for Magnum Integration and Magnum Extras.

ArchLinux packages

Package for the latest stable release is maintained in the community repo. Installing is as simple as this:

sudo pacman -S magnum-plugins

In package/archlinux/magnum-plugins-git there is a package for Git development build. The package is also in AUR as magnum-plugins-git. It depends on Corrade and Magnum ArchLinux packages.

There are also a few development packages for native builds, cross-compilation for Emscripten, Android and MinGW or various sanitizer/coverage builds. See the PKGBUILD files in the package/archlinux directory. They allow you to build and install the package directly from source tree. Example usage:

git clone git://github.com/mosra/magnum-plugins && cd magnum-plugins
cd package/archlinux
makepkg -fp PKGBUILD # or any other PKGBUILD file

In most cases the development PKGBUILDs also contain a check() function which will run all unit tests before packaging. That might sometimes fail or take too long, pass --nocheck to makepkg to skip that.

Once built, install the package using pacman:

sudo pacman -U magnum-plugins-*.pkg.tar.zst

Edit the PKGBUILDs if you want to pass additional flags to CMake or enable / disable additional features.

There are also ArchLinux packages for Magnum Integration, Magnum Extras and Magnum Examples.

MSYS2 packages

MSYS2 package for the latest stable release is mantained in the official repos. Installing is as simple as this:

pacman -S mingw-w64-x86_64-magnum-plugins # or mingw-w64-i686-magnum-plugins

Similarly to ArchLinux, there is one package in the package/msys/magnum-plugins directory, which will download and package latest stable release; and then a development PKGBUILD in package/msys, allowing you to package and install the currently checked out source tree. Both depend on corresponding Corrade and Magnum MSYS2 packages. Example usage:

git clone git://github.com/mosra/magnum-plugins && cd magnum-plugins
cd package/msys
makepkg -fp PKGBUILD

The above works in a 32/64bit MinGW shell, from a MSYS shell the equivalent command is

makepkg-mingw -fp PKGBUILD

which will build both a 32bit and a 64bit version. See the MSYS2 Wiki for more information.

There are also MSYS2 packages for Magnum Integration.

Packages for Debian, Ubuntu and derivatives

The package/debian/ directory contains all files needed for building Debian packages. You need the Corrade and Magnum Debian packages installed and in addition also the dpkg-dev and debhelper packages. Building is easy, just change directory to package root, link or copy the package/debian directory there and run dpkg-buildpackage:

git clone git://github.com/mosra/magnum-plugins && cd magnum-plugins
ln -s package/debian .
dpkg-buildpackage

This will compile binary and development packages, which will then appear in a parent directory. Install them using dpkg:

sudo dpkg -i ../magnum-plugins*.deb

If you want to pass additional flags to CMake or enable / disable additional features, add them to dh_auto_configure at the bottom of package/debian/rules. Watch out, as indentation has to be done using tabs, not spaces.

There are also Debian packages for Magnum Integration, Magnum Extras and Magnum Examples.

Gentoo Linux ebuilds

Gentoo Git ebuild is available in the package/gentoo directory. Get the Corrade and Magnum Gentoo packages first and then build and install Magnum Plugins like this:

git clone git://github.com/mosra/magnum-plugins && cd magnum-plugins
cd package/gentoo
sudo ebuild dev-libs/magnum-plugins/magnum-plugins-9999.ebuild manifest clean merge

If you want to pass additional flags to CMake or enable / disable additional features, add them to mycmakeargs in the *.ebuild file.

There are also Gentoo packages for Magnum Integration, Magnum Extras and Magnum Examples.

Homebrew formulas for macOS

macOS Homebrew formulas building the latest Git revision are in the package/homebrew directory. Either use the *.rb files directly or use the tap at https://github.com/mosra/homebrew-magnum. This will install the latest stable version of Magnum Plugins with all dependencies:

brew install mosra/magnum/magnum-plugins

But often you may want to install the latest Git revision of all Magnum projects instead:

brew install --HEAD mosra/magnum/corrade
brew install --HEAD mosra/magnum/magnum
brew install --HEAD mosra/magnum/magnum-plugins

When installing from the *.rb files you need to install the Corrade and Magnum Homebrew packages first. If you want to pass additional flags to CMake or enable / disable additional features, edit the *.rb file.

There are also Homebrew packages for Magnum Integration, Magnum Extras and Magnum Examples.

Manual build

The source is available on GitHub: https://github.com/mosra/magnum-plugins. Building the plugins is very similar to building Magnum itself. See Downloading and building for additonal information about building and running tests, cross-compiling and platform-specific issues.

Enabling or disabling features

By default no plugins are built and you need to select them manually:

Some plugins expose their internal state through separate libraries and you can control their build separately:

  • WITH_OPENDDL — Build the OpenDdl library. Enabled automatically if WITH_OPENGEXIMPORTER is enabled.

Options controlling the build are a subset of the options used by Magnum:

  • BUILD_STATIC — Build all libraries as static. Default is shared, except on platforms such as Android or Emscripten that don't support dynamic linking.
  • BUILD_STATIC_PIC — Build static libraries with position-independent code. Enabled by default when building static libraries, disable if you don't need this feature. On Emscripten this option is always off.
  • BUILD_PLUGINS_STATIC — Build plugins as static. By default, plugins are built as dynamic. Independent of the BUILD_STATIC option to allow having static libraries with dynamic plugins and vice versa. To some extent it's also possible to have only a subset of plugins built as static — set MAGNUM_<PLUGIN>_BUILD_STATIC for particular plugins to ON or OFF to override this option.
  • Additional options are inherited from the CORRADE_BUILD_MULTITHREADED and MAGNUM_BUILD_STATIC_UNIQUE_GLOBALS options specified when building Magnu,

Note that each plugin class / library namespace documentation contains more detailed information about its dependencies, availability on particular platforms and also a guide how to enable given plugin for building and how to use it with CMake.

Libraries and static plugins built in the Debug configuration (e.g. with CMAKE_BUILD_TYPE set to Debug) have a -d suffix, dynamic plugins in Debug configuration are installed to the magnum-d subdirectory, similarly to what is done when building Magnum itself.

Building documentation

The documentation for plugins is built as part of of the main Magnum documentation. Clone the projects next to each other and continue as described in Building documentation.

Continuous Integration

CircleCI

In package/ci/ there is a circle.yml file with Linux GCC 4.8, macOS, Emscripten, AddressSanitizer and ThreadSanitizer configuration. Online at https://circleci.com/gh/mosra/magnum-plugins.

Travis

In package/ci/ there is a travis.yml file with iOS and Android configuration. Online at https://travis-ci.com/mosra/magnum-plugins.

AppVeyor

In package/ci/ there is an appveyor.yml file with Windows desktop MSVC, MinGW and Windows RT configuration. Online at https://ci.appveyor.com/project/mosra/magnum-plugins.

Codecov.io

Linux, Linux GLES, macOS and Windows MinGW builds contribute to a combined code coverage report, available online at https://codecov.io/gh/mosra/magnum-plugins.