Fully hand-held tutorial on setting up the Java environment to a usable state as quickly as possible. Only knowledge of using the terminal is expected. This tutorial will be completely self-contained (excluding links to downloads).

This guide contains some links to some internal pages; these links are not necessary for setting up the environment and only exist as additional assistance for IHMC personnel and others with access.

The general steps are:

• Install Java
• Install Gradle
• Import Repositories
• Install and configure IDE

...

Ubuntu

...

Curl

...

Curl is a package manager that we will use to install some software. To install it, open a terminal and run:

...

Configure for IHMC software

• Copy paste the following lines into the file

• Multiexcerpt include
  MultiExcerptName gradle.properties ubuntu example ihmc employee PageWithExcerpt Gradle

• Multiexcerpt include
  MultiExcerptName gradle.properties ubuntu example PageWithExcerpt Gradle

...

This guide currently only contains instructions for IntelliJ. We are working on Eclipse.

Eclipse

Intellij

• Download IntelliJ Community. 
  • https://www.jetbrains.com/idea/download/#section=linux
  • Open a terminal and cd into the folder where you downloaded the tar file

  • Extract the file and move it to /opt/. (If you already downloaded from the link above, there is no need to run curl). Replace the names appropriately based on the version you download.

  • Multiexcerpt include
    MultiExcerptName Ubuntu Get IntelliJ PageWithExcerpt IntelliJ IDEA

  • Multiexcerpt include
    MultiExcerptName Run Intellij PageWithExcerpt IntelliJ IDEA

  • Multiexcerpt include
    MultiExcerptName IntellijDesktopLauncher PageWithExcerpt IntelliJ IDEA

• Now you will need to configure IntelliJ to the Java environment you installed.

• Multiexcerpt include
  MultiExcerptName IntellijConfiguration Quickstart PageWithExcerpt IntelliJ IDEA

• Multiexcerpt include
  MultiExcerptName Intellij quickstart successful PageWithExcerpt IntelliJ IDEA

...

...

This step is necessary if you are working on high-level behaviors, but not necessary to run the simulations.

...

Gradle

...

We are currently on use Gradle 7. We will install it manually for ease of understanding. The official guide is here for reference. (Aside: we do not use the Gradle Wrapper)

• Download the latest Gradle 7 distribution (7.4.2 as of writing).
  • Choose the complete version.
  • Remember where you downloaded it.

• Unpack Gradle (the following are excerpted from the gradle website)

  Excerpt
  Create a new directory C:\Gradle with File Explorer. Open a second File Explorer window and go to the directory where the Gradle distribution was downloaded. Double-click the ZIP archive to expose the content. Drag the content folder gradle-7X.4X.2 Xto your newly created C:\Gradle folder.

• Add to path

  Excerpt
  In File Explorer right-click on the This PC (or Computer) icon, then click Properties -> Advanced System Settings -> Environmental Variables. Under System Variables select Path, then click Edit. Add an entry for C:\Gradle\gradle-7X.4X.2X\bin. Click OK to save.

• Multiexcerpt include
  MultiExcerptName gradle verify PageWithExcerpt Gradle

• Configure for IHMC software

• Multiexcerpt include
  MultiExcerptName gradle.properties home location PageWithExcerpt Gradle

  • Copy paste the following lines into the file

  • Multiexcerpt include
    MultiExcerptName gradle.properties windows example ihmc employee PageWithExcerpt Gradle

  • Multiexcerpt include
    MultiExcerptName gradle.properties windows example PageWithExcerpt Gradle

...

IDE

...

This guide currently only contains instructions for IntelliJ. We are working on Eclipse.

Eclipse

...

Intellij

...

Note
icon false title IHMC Only
Full guide: IntelliJ IDEA

• Download IntelliJ Community. Choose the .exe for convenience
  • https://www.jetbrains.com/idea/download/#section=windows
  • All default installation options are fine.
• Now you will need to configure IntelliJ to the Java environment you installed.

• Multiexcerpt include
  MultiExcerptName IntellijConfiguration Quickstart PageWithExcerpt IntelliJ IDEA

• Multiexcerpt include
  MultiExcerptName Intellij quickstart successful PageWithExcerpt IntelliJ IDEA

Note
icon false title IHMC Only
Network Parameters

...

...

This step is necessary if you are working on high-level behaviors, but not necessary to run the simulations.

...