PluginManager is a library that can be easily integrated with your software to allow your users to create plugins.
<project>
<dependencies>
<dependency>
<groupId>dev.truewinter</groupId>
<artifactId>PluginManager</artifactId>
<!-- Check the releases page for the latest version -->
<version>0.0.0</version>
</dependency>
</dependencies>
</project>The default plugin manager requires a plugin.yml to be included in the plugin containing the following:
# A unique name for this plugin, must be alphanumeric
name: PluginName
# The plugin's main class
main_class: org.example.plugin.PluginAn example for using the plugin manager for software called CoolSoftware, loading a plugin called CoolPlugin, is included below:
// In CoolSoftware
public interface CoolSoftwareAPI {
// CoolSoftware's API methods
void exampleApiMethod();
}
public class PluginLoader {
public PluginLoader() {
PluginManager<CoolSoftwareAPI> pluginManager = new PluginManager<>(c -> {
// Handle PluginManagerLog messages
});
// This variable should contain a list of plugins, including CoolPlugin
List<File> pluginJars = new ArrayList<>();
pluginManager.loadPlugins(pluginJars);
SomeEvent event = pluginManager.fireEvent(new SomeEvent());
if (!event.isCancelled()) {
// Do something if the event has not been cancelled
}
}
}
public abstract class CoolSoftwarePlugin extends Plugin<CoolSoftwareAPI> {
// Implement methods
}
// Events can extend Event if you don't want to allow cancellation
public class SomeEvent extends CancellableEvent {
public String exampleEventMethod() {
return "SomeEvent example";
}
}// In CoolPlugin
public class EventListener implements Listener {
@EventHandler
public onEvent(SomeEvent e) {
e.exampleEventMethod();
e.setCancelled(true);
}
}
// If a plugin wants to use the getPluginByName(String) method,
// it must implement UsesAnotherPlugin and only call the method
// after the onAllPluginsLoaded() method.
public class CoolPlugin extends CoolSoftwarePlugin {
// It is only safe to interact with the API once the onLoad()
// method has been called.
@Override
protected void onLoad() {
getLogger().info("Plugin loaded");
getApi().exampleApiMethod();
registerListeners(this, new EventListener());
}
@Override
protected void onUnload() {
getLogger().info("Plugin unloaded");
}
}CoolPlugin's pom.xml should look similar to the following:
<dependencies>
<dependency>
<groupId>com.example</groupId>
<artifactId>CoolSoftware</artifactId>
<version>{version}</version>
<scope>provided</scope>
</dependency>
</dependencies>