intermediate lesson 5

Submitting plugins

Rules and guidelines when submitting your plugins to be included as part of Krita

Overview

Krita includes python scripts that extend its functionality. This page has information for developers who want to have their plugin bundled with Krita. You must be aware that your plugin will be included in the official Krita distribution. Therefore, you must ensure there is continuous support for keeping your plugin up to date.

Contact

If you have any questions about your plugin or need more information, you can post them on the plugins category on Krita Artists.

Repository

Krita uses GIT for source control. The plugins for Krita are stored on KDE's gitlab instance. They are stored in the python folder under plugins.

Licensing

If you distribute a Krita plugin it also has to be shared under the GNU GPL. You can charge for the download, but you cannot prevent others from distributing your plugin: your customers will have all the rights guaranteed by the GNU GPL. For more information on licensing, visit krita.org where it goes over it in more detail.

Submitting Plugins

Follow the guidelines for plugins when implementing one. Submit the plugin via invent.kde.org through a merge request. You will need to make a fork of the Krita repository and include your changes. See the documentation on creating your fork if you need help.

The reviewers will decide if the plugin can be added to the official release. It is also a good idea to get feedback about your plugin by sharing it on Krita Artists. This feedback can help in the decision on whether to include it or not.

Bug Reports

Bugs for all plugins are reported to the plugin project. If a bug is filed for your add-on, the bug will be assigned to you as the plugin maintainer.

< Previous Lesson
Learning from other plugins

Have questions, need help, or find a typo?

Head to the Krita artists where we have a dedicated area for plugin development and give any feedback you might have.

;