User Tools

Site Tools


dev-guide:plugins

GroIMP is designed around plugins which can be added, modified or removed without modifying the GroIMP installation.

GroIMP Plugin

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.

See more:

Managing plugins

GroIMP plugins are located in to 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.

Manually

It is possible to manually add or remove a plugin by simply copying/deleting them from the loaded paths.

The added plugin needs to be compiled and follow the plugin structure. See this guide on the plugin structure.

Note: if you do not have the permission right to delete a repository from the GroIMP installation folder, you can prevent the plugin from being loaded by adding it to the blacklisted file.

Plugin Manager

The plugins can easily be updated, installed, or removed from the GUI with the Plugin Manager.

The plugin manager uses the plugin repositories to find plugin data. These repositories can be local or remote but needs to follow the given structure.

dev-guide/plugins.txt · Last modified: 2024/07/08 12:23 by timOb