1. Go to http://www.eclipse.org/downloads/ and download "Eclipse IDE for Java Developers" for your platform. When the download completes, unzip or install Eclipse and start it up.
2. Eclipse will ask you where to store it's workspace. The default is fine. You can click "Use this as the default and do not ask again." if you don't want to be bothered every time you start Eclipse.
3. When Eclipse starts you will see a Welcome screen. Close the Welcome screen by clicking the small X in the tab.
4. You should now see the Package Explorer tab. Right click in this area and select Import.
5. On the Import screen, expand "Git", select "Projects from Git" and click Next.
6. On the Select Repository Source screen select "Clone URI" and click Next.
7. On the Source Git Repository screen enter https://github.com/openpnp/openpnp.git in the URI field¹ or enter the address to your fork at Github if you would like to contribute back to the project later² and click Next.
8. On the Branch Selection screen select the "develop" branch and unselect all other branches, then click Next.
9. On the Local Destination screen enter the directory where you would like to store the OpenPnP source code. You can keep the default if it's okay. Then click Next.
10. Eclipse will now download the OpenPnP source code. This may take a few minutes.
11. When it finishes, on the same screen select the "Import as general project" option and click Next.
12. On the Import Projects screen accept the default project name of "openpnp" and click Finish.
13. The openpnp project will now appear in the Package Explorer. Right click on the project "openpnp" and in the menu select Configure -> Convert to Maven Project. Eclipse will download any resources that it needs and build the project. This can take some time and you need to wait for it to complete before proceeding to the next step.
14. Expand the openpnp project and look for the src/main/java folder. Under this folder expand the org.openpnp folder and look for Main.java.
15. Right click Main.java and from the menu select Run As -> Java Application.
16. After a few seconds OpenPnP will start.
17. You can now edit files in Eclipse, the changes will automatically be hot swapped if enabled "Project" -> "Build Automatically". If function signatures were changed hot swap does not apply and you need to rerun OpenPnP with your changes, just click the green Run button in the toolbar. The button is a green circle with a white right facing arrow in it.
18. Close OpenPnP

• ¹ It is possible to later change so your clone is pointing to your fork at Github.
• ² You cannot directly push your changes to OpenPnP, it must go through your own fork.

A the time of writing this, you likely need to resolve a Java Modules issues, reported with error messages of the following type:

The package javax.xml.transform.sax is accessible from more than one module: <unnamed>, java.xml EagleLoader.java ...

To resolve this, follow these steps:

1. Exit Eclipse.
2. Open the .settings/org.eclipse.jdt.core.prefs file inside your openpnp git directory.
3. Add the following line: org.eclipse.jdt.core.compiler.ignoreUnnamedModuleForSplitPackage=enabled
4. Restart Eclipse.
5. Do Maven / Update Project ... (or Alt-F5).

Source: https://stackoverflow.com/a/74890645/15218951

See also: https://groups.google.com/g/openpnp/c/3dv0B3Me9uw/m/HloqU8kkBQAJ

To edit user interface Wizards etc. you need to install a graphical UI designer like WindowBuilder.

Follow the video:

• Eclipse WindowBuilder Setup

To support translations in different languages and scriptures in Eclipse, go to Windows / Preferences / General / Content Type / Text / Java Properties File and set Default encoding to UTF-8:

NOTE: the translation.properties file is always kept in the sorting order of property names, i.e. ordered by translation Key (binary collation). Eclipse and Window Builder will always preserve the order to keep versioning stable. Please adhere to it when using external editors.

Open the project properties, go to Java Build Path, select the Sources tab, and Remove the exclusion pattern from the openpnp/src/main/resources path:

It appears, this exclusion pattern is mistakenly (?) added in the maven project conversion. See Eclipse/m2e bug, and follow up here.

The WindowBuilder designer has built-in localization support, so you can directly select the language in the drop-down (click on arrow-down, see below) and then set and preview texts like labels and tooltips transparently in the graphical designer. WindowBuilder will automatically generate the translation key, add missing translation entries and texts to the Java properties files.

You can also click on the center of the drop-down button to get a tabular editor for all the text strings:

The default table contains all the strings in OpenPnP. Select the "Show strings only for current form" checkbox, to just translate the current form.

Some text strings in the source code might be outside the scope of WindowBuilder's designer. To make these source code texts available for translation, you can use menu Source / Externalize Strings....

Press Configure... to check whether the configuration is correct, if not, make it so:

If you can't set this, you likely forgot to include Resources into the build in Maven.

The dialog lists all the yet untreated strings found in the source code. Select an entry to position to the code.

CAUTION: it is very, very important to understand the nature of a string. If it is a string that has is used for a computation purpose rather than as a human readable text, you must select it and press the Ignore button. If in doubt, or if the string has both a human readable and computation meaning, select the string and press Ignore, as in the following example. Multi-selection is possible. An x sign must appear on the left:

Only if the string is clearly intended as a text to only be read by a human, you can leave it checked. Make sure to set a speaking Key, so that the meaning of the text is still understandable for developers. The externalized string will be removed from the source code, so the Key is all that is left for understanding it:

Yes, composing all these keys well is hard work! Leaving just the proposed numbers is unacceptable (pull requests with these will not be accepted).

After having carefully assessed each string, press Next to review the changes.

Strings that are not externalized will be marked with the //$NON-NLS-x$ pattern (if there are multiple strings on one line, x is denoting the position):

String that are externalized are replaced with the Translations.getString() call, using the defined key:

The externalized key=string pair is automatically added to the translations.properties file.

When launching OpenPNP from within Eclipse IDE it will use your default configuration directory. If you want to use an own directory, for example if you are using different branches with different machine.xml, then you can supply the configDir variable in the "Run Configuration":

• Select menu "Run -> Run configurations"
• Select your Main Java Application settings
• Choose the Arguments tab
• In the section VM arguments add: -DconfigDir=yourdirectory

1. Ensure you have the automatic code formatter for eclipse activated. See the coding style-section in the developers guide to download a preconfigured settings file.
2. You need to run tests by executing "Maven test". Maven test needs the full JDK + GIT be installed (not only JRE).
   • Download and install the JDK.
   • Download and install GIT.
3. Add the JDK to the environments in eclipse: