Setting Up Eclipse

Download

Note

If you choose to use Eclipse when developing plugins with the Sponge API, we recommend using Eclipse Luna or later.

Eclipse can be downloaded for free from http://www.eclipse.org/downloads/.

The download will come in the form of a compressed file, such as a .zip or .tar.gz. Decompress this file into the directory of your choice; your Program Files (on Windows) or Applications (on Mac OS X) folder is recommended.

You may then proceed to run Eclipse from the directory it was downloaded into. Eclipse does not have an installer.

Starting Your Project

Note

You may skip this section if you only plan on developing plugins with the Sponge API.

We recommend using Gradle or Maven when developing plugins with the Sponge API. Gradle and Maven help significantly when managing dependencies, such as the Sponge API, for your project. This is preferable to including the .jar file in your project.

Gradle

To create your project:

You must first install the Gradle Integration Plugin before using Gradle in Eclipse. This only needs to be done upon the creation of your first project.

Note

Typically, you do not need the optional Spring modules distributed with this plugin, so you can uncheck them during installation.

  • Open Eclipse.
  • Click Help > Eclipse Marketplace.
  • Search for Gradle Integration Plugin.
  • Install the Gradle Integration Plugin.

You may then proceed to create your project.

  • Click File > New > Other.
  • Select Gradle > Gradle Project.
  • Click Next.
  • Enter a project name, then click Finish.

To import the Sponge API as a dependency:

  • Open build.gradle in the navigator.
  • Manually add the official Sponge API Maven artifact as a dependency. An example can be found on the aforementioned Artifacts article.
  • Right-click your project, and select Gradle > Refresh Dependencies.

Maven

To create your project:

  • Open Eclipse.
  • Click File > New > Other.
  • Select Maven on the left side of the popup, and select Maven Project on the right side.
  • Click Next.
  • Select Create a simple project, unless you require a more advanced setup.
  • Enter your Group ID, Artifact ID, Version, project name, and project description.
    • Your Group ID should correspond to your organization name, or something similar.
    • Your Artifact ID should correspond to your project name.
    • Your Version is up to you.
  • Click Finish.

Tip

Eclipse often does not open new projects after creating them. If this happens, try closing the Eclipse welcome screen; your project should be open behind it.

To import the Sponge API as a dependency:

  • Open pom.xml in the navigator.
  • Click the Dependencies tab on the bottom, and click Add.
  • Enter the Group ID, Artifact ID, and Version of the official Sponge API Maven artifact.
  • Click OK.

Git Integration

The Eclipse Foundation offers documentation on using Eclipse’s EGit plugin:

http://www.eclipse.org/egit/documentation/

Track Continuation

If you are following a track in Preparing for Development, your next step is: