Users can create new plugins from this template repository either by manual cloning or via the templating mechanism of GitHub.
- Set your plugin ID in
project.ext => artifact
. It will be used to generate the plugin Jar file. - Create your plugin package below
src/main/java/
(convention here is to use reverse domain notation here too) - Create your plugin class in
src/main/java/<your-package>
- Happy programming! :) (Remember to visit the documentation and feel free to ask for help in case you need it)
- Remember to change/check the license file for your plugin ;)
In case you cloned the template, remember to change the origin
remote that is automically registered when cloning a project:
# Remove the old remote reference
git remote remove origin
# Add the new remote reference
git remote add origin <your-repository-uri>
Your can also just rename the remote reference so that you can always pull updates to the template:
# Rename remote reference
git remote rename origin template
# Add the new remote reference as default
git remote add origin <your-repository-uri>
# Pull any updates to the template (from the templates 'master' branch to the currently checked out branch)
# We recommend using an interactive merge tool. And: remember not accept changes to files like this readMe ^^ - this is yours now.
git pull template master