Getting started with IntelliJ

From VASSAL
Jump to: navigation, search

Prerequisites

  • a git client
    • on Windows, git-bash is recommended
  • a JDK >= 11

Installation

Download and install "IntelliJ Community Edition" from https://www.jetbrains.com/idea/download

On Ubuntu Linux, run sudo snap install intellij-idea-community

Project setup

Import project

Assuming the code has been cloned to /home/user/projects/vassal:

  1. start IntelliJ
  2. open project
  3. navigate to /home/user/projects/vassal/pom.xml
  4. confirm

Configure JDK

Under File -> Project Structure, configure at least one JDK: Intellij-configure-jdk.png

Run/Debug configuration

Vassal Player

Intellij-runconfig-player.png

Vassal Editor

Intellij-runconfig-editor.png

Optional plugins

Under File -> Settings -> Plugins, install any of the following:

CheckStyle-IDEA

For Java code contributors. Configure like this:

Intellij-configure-checkstyle.png

AsciiDoc

For changing the documentation in vassal-doc/src/main/