https://github.com/imagej/example-legacy-plugin

Simple Maven project for an ImageJ 1.x plugin
https://github.com/imagej/example-legacy-plugin

Last synced: 11 months ago
JSON representation

Simple Maven project for an ImageJ 1.x plugin

• Host: GitHub
• URL: https://github.com/imagej/example-legacy-plugin
• Owner: imagej
• Created: 2012-10-02T22:34:28.000Z (almost 14 years ago)
• Default Branch: main
• Last Pushed: 2022-04-11T19:09:23.000Z (about 4 years ago)
• Last Synced: 2025-06-10T20:14:19.229Z (about 1 year ago)
• Language: Java
• Homepage:
• Size: 65.4 KB
• Stars: 34
• Watchers: 34
• Forks: 41
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
This is an example Maven project implementing an ImageJ 1.x plugin.

For an example Maven project implementing an **ImageJ2 command**, see:

    https://github.com/imagej/example-imagej2-command

It is intended as an ideal starting point to develop new ImageJ 1.x plugins

in an IDE of your choice. You can even collaborate with developers using a

different IDE than you.

* In [Eclipse](http://eclipse.org), for example, it is as simple as

  _File › Import... › Existing Maven Project_.

* In [NetBeans](http://netbeans.org), it is even simpler:

  _File › Open Project_.

* The same works in [IntelliJ](http://jetbrains.net).

* If [jEdit](http://jedit.org) is your preferred IDE, you will need the

  [Maven Plugin](http://plugins.jedit.org/plugins/?MavenPlugin).

Die-hard command-line developers can use Maven directly by calling `mvn`

in the project root.

However you build the project, in the end you will have the `.jar` file

(called *artifact* in Maven speak) in the `target/` subdirectory.

To copy the artifact into the correct place, you can call

`mvn -Dscijava.app.directory=/path/to/ImageJ.app/`.

This will not only copy your artifact, but also all the dependencies. Restart

your ImageJ or call *Help › Refresh Menus* to see your plugin in the menus.

Developing plugins in an IDE is convenient, especially for debugging. To

that end, the plugin contains a `main` method which sets the `plugins.dir`

system property (so that the plugin is added to the Plugins menu), starts

ImageJ, loads an image and runs the plugin. See also

[this page](https://imagej.net/Debugging#Debugging_plugins_in_an_IDE_.28Netbeans.2C_IntelliJ.2C_Eclipse.2C_etc.29)

for information how ImageJ makes it easier to debug in IDEs.

Since this project is intended as a starting point for your own

developments, it is in the public domain.

How to use this project as a starting point

===========================================

1. Visit [this link](https://github.com/imagej/example-legacy-plugin/generate)

   to create a new repository in your space using this one as a template.

2. [Clone your new repository](https://help.github.com/en/articles/cloning-a-repository).

3. Edit the `pom.xml` file. Every entry should be pretty self-explanatory.

   In particular, change

    1. the *artifactId* (**NOTE**: should contain a '_' character)

    2. the *groupId*, ideally to a reverse domain name your organization owns

    3. the *version* (note that you typically want to use a version number

       ending in *-SNAPSHOT* to mark it as a work in progress rather than a

       final version)

    4. the *dependencies* (read how to specify the correct

       *groupId/artifactId/version* triplet

       [here](https://imagej.net/Maven#How_to_find_a_dependency.27s_groupId.2FartifactId.2Fversion_.28GAV.29.3F))

    5. the *developer* information

    6. the *scm* information

4. Remove the `Process_Pixels.java` file and add your own `.java` files

   to `src/main/java//` (if you need supporting files -- like icons

   -- in the resulting `.jar` file, put them into `src/main/resources/`)

5. Edit `src/main/resources/plugins.config`

6. Replace the contents of `README.md` with information about your project.

7. Make your initial

   [commit](https://help.github.com/en/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project) and

   [push the results](https://help.github.com/en/articles/pushing-commits-to-a-remote-repository)!

### Eclipse: To ensure that Maven copies the plugin to your ImageJ folder

1. Go to _Run Configurations..._

2. Choose _Maven Build_

3. Add the following parameter:

    - name: `scijava.app.directory`

    - value: `/path/to/ImageJ.app/`

This ensures that the final `.jar` file will also be copied to

your ImageJ plugins folder everytime you run the Maven build.