Qt 5.8 | Deploying Plugins

Qt 5.8.0 Reference Documentation

# Deploying Plugins

This document explains how to deploy plugin libraries that Qt or your application should load at runtime. If you use static plugins, then the plugin code is already part of your application executable, and no separate deployment steps are required.

## The Plugin Directory

When the application is run, Qt will first treat the application's executable directory as the base directory for searching for plugins. For example if the application is in `C:\Program Files\MyApp` and has a style plugin, Qt will look in `C:\Program Files\MyApp\styles`. (See QCoreApplication::applicationDirPath() for how to find out where the application's executable is.) Qt will also look in the directory specified by QLibraryInfo::location(QLibraryInfo::PluginsPath), which typically is located in `QTDIR/plugins` (where `QTDIR` is the directory where Qt is installed). If you want Qt to look in additional places you can add as many paths as you need with calls to QCoreApplication::addLibraryPath(). And if you want to set your own path or paths you can use QCoreApplication::setLibraryPaths(). You can also use a `qt.conf` file to override the hard-coded paths that are compiled into the Qt library. For more information, see the Using qt.conf documentation. Yet another possibility is to set the `QT_PLUGIN_PATH` environment variable before running the application. If set, Qt will look for plugins in the paths (separated by the system path separator) specified in the variable.

Note: `QT_PLUGIN_PATH` should not be exported as a system-wide environment variable since it can interfere with other Qt installations.

## Loading and Verifying Plugins Dynamically

When loading plugins, the Qt library does some sanity checking to determine whether or not the plugin can be loaded and used. This provides the ability to have multiple versions and configurations of the Qt library installed side by side.

- Plugins linked with a Qt library that has a higher version number will not be loaded by a library with a lower version number.

  Example: Qt 5.0.0 will not load a plugin built with Qt 5.0.1.

- Plugins linked with a Qt library that has a lower major version number will not be loaded by a library with a higher major version number.

  Example: Qt 5.0.1 will not load a plugin built with Qt 4.8.2.
  Example: Qt 5.1.1 will load plugins built with Qt 5.1.0 and Qt 5.0.3.

When building plugins to extend an application, it is important to ensure that the plugin is configured in the same way as the application. This means that if the application was built in release mode, plugins should be built in release mode, too. Except for Unix operating systems, plugins build in a different mode will not get loaded by the plugin system.

If you configure Qt to be built in both debug and release modes, but only build applications in release mode, you need to ensure that your plugins are also built in release mode. By default, if a debug build of Qt is available, plugins will only be built in debug mode. To force the plugins to be built in release mode, add the following line to the plugin's project file:

      CONFIG += release

This will ensure that the plugin is compatible with the version of the library used in the application.

## Debugging Plugins

There are a number of issues that may prevent correctly-written plugins from working with the applications that are designed to use them. Many of these are related to differences in the way that plugins and applications have been built, often arising from separate build systems and processes.

The following table contains descriptions of the common causes of problems developers experience when creating plugins:

Problem | Cause | Solution
--- | --- | ---

Plugins sliently fail to load even when opened directly by the application. Qt Designer shows the plugin libraries in its Help|About Plugins dialog, but no plugins are listed under each of them.

The application and its plugins are built in different modes.

Either share the same build information or build the plugins in both debug and release modes by appending the `debug_and_release` to the CONFIG variable in each of their project files.

You can also use the `QT_DEBUG_PLUGINS` environment variable to obtain diagnostic information from Qt about each plugin it tries to load. Set this variable to a non-zero value in the environment from which your application is launched.