Wiki

Clone wiki

jmonkeybuilder / Plugin Development

Examples

SimArboreal Tree Generator

jME Font Generator

Getting Started

You need to make a fork of one of the repositories with an example plugin: Bitbucket or Github and then you need to import the Gradle project to your IDE.

So the example includes some main things:

  • Prepared the Gradle build file: build.gradle, which includes the dependency to jMonkeyBuilder, some additional Gradle tasks, artifact and group ID of your plugin.

  • Prepared Gradle settings file: settings.gradle

  • The main class of a plugin: ExamplePlugin, your plugin will be loaded from this class.

How to debug my plugin?

You need to create a launch configuration in your IDE:

  • The main class should be com.ss.editor.DevelopPluginStarter

  • You need to add executing Gradle task named preparePlugin before launch

For example a configuration in IntelliJ IDEA:

Снимок экрана от 2017-07-22 14-03-16.png

If you created a configuration correctly, you will see your plugin is in Plugins dialog in the Editor:

Снимок экрана от 2017-07-22 14-07-57.png

How to deploy my plugin like a single file?

You just need to execute the Gradle task named deployPlugin and then you will see that your plugin was created in the folder deploy-plugin in your project root.

Снимок экрана от 2017-07-22 14-13-17.png

So this zip file is your built plugin which a user can install to his Editor using Plugins dialog.

Plugin API

Editor Plugin

Updated