Essentials Plugin Archetype

The Essentials Plugin Archetype provides a template for creating a new Essentials Plugin. Use this archetype to generate the initial structure for your plugin development.

Generate a New Essentials Plugin

To create a new Essentials Plugin project, run the following Maven command:

mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate \
-DarchetypeRepository=https://maven.bloomreach.com/repository/maven2/ \
-DarchetypeGroupId=org.onehippo.cms7 \
-DarchetypeArtifactId=hippo-essentials-plugin-archetype \
-DarchetypeVersion=13.0.0

Update the archetypeVersion parameter to the latest available version if needed. When prompted, specify a unique plugin ID.

After generating the project, build it with:

maven clean install

To make the plugin available in your local Essentials instance, add the generated plugin as a dependency in your essentials/pom.xml file:

<dependency>
  <groupId>org.example</groupId>
  <artifactId>myessentialsplugin</artifactId>
  <version>0.1.0-SNAPSHOT</version>
</dependency>

Rebuild and restart your project. The new plugin will appear in the Essentials Library list.