Plugin Tutorial (First Steps)

First Steps

Steps 2-6 should be carried out when the plugin is enabled. Example code is provided.

1. Extend the AbstractPonderPlugin class.

class LanguageBarriers extends AbstractPonderPlugin

2. Implement the required inherited methods.

3. Initialize the config service.

HashMap<String, Object> configOptions = new HashMap<>();
configOptions.put("debugMode", false);
getPonderAPI().getConfigService().initialize(configOptions);

4. Initialize the config file.

if (!(new File("./plugins/LanguageBarriers/config.yml").exists())) {
    getPonderAPI().getConfigService().saveMissingConfigDefaultsIfNotPresent();
}
else {
    // pre load compatibility checks
    if (isVersionMismatched()) {
        getPonderAPI().getConfigService().saveMissingConfigDefaultsIfNotPresent();
    }
    reloadConfig();
}

5. Register your event handlers.

ArrayList<Listener> listeners = new ArrayList<>();
listeners.add(new JoinHandler());
getToolbox().getEventHandlerRegistry().registerEventHandlers(listeners, this);

6. Initialize the Command Service.

ArrayList<ICommand> commands = new ArrayList<>(Arrays.asList(
        new HelpCommand(), new InfoCommand(),
        new ListCommand(), new CreateCommand(),
        new SpeakCommand(), new ForgetCommand(),
        new TeachCommand(), new LearnCommand()
));
getPonderAPI().getCommandService().initialize(commands, "That command wasn't found.");

7. Add the onCommand() method. (TODO: add more here)

You're now ready to use the Ponder library!