User Tools

Site Tools


01_user_documentation:11_plugin

Plugins

GroIMP is designed around plugins, which can be added, modified or removed without modifying the GroIMP installation. Plugins enable to add all kind of features to GroIMP, from adding support to new file format, to new renderers usable in a project.

A complete list of available plugins can be found at https://grogra.gitlab.io/groimp-utils/plugin_web_explorer/

Managing plugins

GroIMP plugins are located in directories by default:

  1. /path/where/groimpisinstalled/plugins/
  2. ~/.grogra.de-platform/plugins/

Additionally, it is possible to add a directory with the argument -p /path/to/directory/. (e.g. java -jar core.jar -p /dir/).

When GroIMP starts it will automatically load every plugin in the given paths.

Note: It is possible to ignore a plugin path by adding it to the blacklisted file in ~/.grogra.de-platform/blacklisted.

→ Read more...

Structure

Any repository with a plugin.xml and plugin.properties files is considered as a plugin by GroIMP. To be properly loadable though, the plugin.xml needs to include:

<?xml version="1.0" encoding="UTF-8"?> 
<plugin id="your.plugin.id" 
version="x.x" 
xmlns="http://grogra.de/registry" >

where plugin id and version need to be filled with the plugin information.

→ Read more...

01_user_documentation/11_plugin.txt · Last modified: 2025/11/01 03:59 by gaetan