Packaging Distribution

Packaging and distribution

Supported packaging formats

• JAR (required).
• It must include addon.properties at the root of the classpath (src/main/resources/addon.properties).

Versioning requirements

• addon.properties:
  • version (your addon version)
  • api (engine API version)

Recommendation:

• Use semantic versioning in the addon: MAJOR.MINOR.PATCH.
• Bump MAJOR if you break addon compatibility.

Recommended distribution channels

• GitHub release including:
  • built jar
  • changelog
  • declared compatibility (engine version + api version)

Server installation

1. Copy MultiBlockEngine.jar into /plugins/.
2. Start the server once.
3. Copy your addon jar into /plugins/MultiBlockEngine/addons/.
4. Restart.