IntelliJ Setup

From Kolmafia
Revision as of 04:01, 23 October 2020 by imported>Mcroft
Jump to navigation Jump to search

This guide assumes that you have a recent enough version of JAVA JDK, ANT, and IntelliJ Idea. Completing Compiling from Source is a requirement for this guide, although experienced developers can skip to whatever step is appropriate.

  1. From the IntelliJ IDEA ***File*** Menu, choose ***New***>***New Project from Existing Sources...***
    1. Choose the directory with the kolmafia build.xml file and press ***Open***
    2. Choose ***Create Project from Existing Sources*** and press ***Next***
    3. Enter the name KoLmafia and press ***Next***
    4. Verify that the project is visible to IDEA and press Finish
  2. Add the Ant Build File
    1. Open the Ant Toolbar Item (typically on the right side, and not very large)
    2. Choose the ***+*** button to add a build file
    3. Choose build.xml from the file selector and press Open
    4. Verify that a list of ANT targets appears in the Ant Toolbar
  3. Check Project Settings
    1. From the ***File*** Menu, choose ***Project Structure...***
    2. Select ***Project*** on the Left Menu
      1. set the ***Name*** to kolmafia
      2. set the ***Project SDK*** to any SDK version 1.8 or higher
      3. set the project language level to 8
      4. set the project compiler output to the build subdirectory
    3. Select the ***libraries*** tab
      1. Choose the ***+*** button to add library
      2. Select Type: Java
      3. Open the lib/jar directory and select all jars
      4. Select add to kolmafia **default is to name the library after the first jar. This can be changed on the next step.**
      5. Select the ***Name*** field and enter "kol-external-jars"
    4. Select ***Modules*** in the Left Menu
      1. In the ***Paths*** tab, select ***Inherit project compile output path***
    5. Close the Project Settings window
  4. c Add Run/Debug Configuration
    1. From the ***Run*** Menu choose ***Edit Configurations...***
    2. Choose the ***+*** button to add a new configuration
    3. Select ***Application***
    4. In the ***Name*** Field, enter "KoLmafia"
    5. In the ***Main Class*** Field, select the Selector ***[...]***, wait for it to populate the field, and choose KoLmafia
    6. Add any VM or program arguments needed (typically none)
    7. for the working directory, add the directory of your KoLmafia user data (e.g. ~/Library/Application\ Support/kolmafia )
    8. set the "before launch" tasks at bottom (may need to scroll to see the bottom of the configurations window...)
      1. Select the ***+*** button at the bottom of the the before launch group
      2. Select Run ANT target ***set.released.false*** and drag it above the Build task.
      3. Select Run ANT target ***set.version*** and drag it above the Build task.
      4. Select Run ANT target ***unset.properties***. Leave it below the Build Task
  5. Choose ***Apply***
  6. Choose ***Close***

Test by pressing the run arrow next to your config name in the toolbar at the top of the window.