Fully hand-held tutorial on setting up the Java environment to a usable state as quickly as possible. No prior software experience is expected, nor is any understanding of third-party softwareOnly 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.

Table of Contents

Ubuntu

Java

Gradle

IDE

Windows

Java

Gradle

...

Note

icon	false
title	IHMC Only

For more detailed tutorials, see

...

General Development Environment Setup Guide

The general steps are:

Install Java
Install Gradle
Import Repositories
Install and configure IDE

Panel

Table of Contents

maxLevel	2

...

Ubuntu

...

Curl

...

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

Code Block
$ sudo apt install curl

Verify installation by running

Code Block
$ curl --version

Java

...

Open a terminal.

Multiexcerpt include

MultiExcerptName	OpenJDK Ubuntu
PageWithExcerpt	Java

Gradle

...

We are currently on 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)

Open a terminal and run the following:

Multiexcerpt include

MultiExcerptName	Gradle quickstart
PageWithExcerpt	Gradle

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 ubuntu example ihmc employee
PageWithExcerpt Gradle
Multiexcerpt include
MultiExcerptName gradle.properties ubuntu example
PageWithExcerpt Gradle

Import Repositories

...

Quick:

Multiexcerpt include

MultiExcerptName	clone command line
PageWithExcerpt	Java Environment Setup Quickstart

More details:

Multiexcerpt include

MultiExcerptName	Repo group structure
PageWithExcerpt	General Development Environment Setup Guide

IDE

...

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

Eclipse

Note

icon	false
title	IHMC Only

Full guide: Eclipse IDE

Intellij

Note

icon	false
title	IHMC Only

Full guide: IntelliJ IDEA

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

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.

Multiexcerpt include

MultiExcerptName	networkConfig for IHMC
PageWithExcerpt	General Development Environment Setup Guide

...

Windows

...

Git

Install Git. Use the 64-bit standalone installer
- https://git-scm.com/download/win

This will be used for all terminal interactions on Windows. Access by searching for Git Bash on the windows search.

Hereby, "open a terminal/console" will refer to launching git bash.

Image Added

Java

...

We use Java 17.

Multiexcerpt include

MultiExcerptName	Java SDK Windows
PageWithExcerpt	Java

Gradle

...

We use Gradle. 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 distribution.
- 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-X.X.X`to 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-X.X.X\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

Import Repositories

...

Quick:

Multiexcerpt

MultiExcerptName	clone command line

We will be cloning repositories from the command line.

Open a terminal and cd to a directory where you want to hold your files. The directory is arbitrary, but you will need to remember it.

First, consider a name for your repository group. "repos" works if you only need one workspace. That name will referred to as <repo-name> below.

Run the following:

Your folder structure should now match what is shown in the next section.

More Details:

Multiexcerpt include

MultiExcerptName	Repo group structure
PageWithExcerpt	General Development Environment Setup Guide

Long Paths

...

Long paths needs to be configured on Windows for our repositories.

Multiexcerpt include

SpaceWithExcerpt	PUBLIC
MultiExcerptName	windows git longpaths
PageWithExcerpt	Long Paths in Windows

IDE

...

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

Eclipse

Note

icon	false
title	IHMC Only

Full guide: Eclipse IDE

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.

Multiexcerpt include

MultiExcerptName	networkConfig for IHMC
PageWithExcerpt	General Development Environment Setup Guide

Versions Compared

Old Version 1

New Version Current

Key

Ubuntu

Java

Gradle

IDE

Windows

Java

Gradle

Ubuntu

Curl

Java

Gradle

Import Repositories

Quick:

More details:

IDE

Eclipse

Intellij

Network Parameters

Windows

Git

Java

Gradle

Import Repositories

Quick:

More Details:

Long Paths

IDE

Eclipse

Intellij

Network Parameters

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Ubuntu

Java

Gradle

IDE

Windows

Java

Gradle

Ubuntu

Curl

Java

Gradle

Import Repositories

Quick:

More details:

IDE

Eclipse

Intellij

Network Parameters

Windows

Git

Java

Gradle

Import Repositories

Quick:

More Details:

Long Paths

IDE

Eclipse

Intellij

Network Parameters