Difference between revisions of "IntelliJ Setup"

From Kolmafia
Jump to navigation Jump to search
imported>Mcroft
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
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.
 
  
−
#From the IntelliJ IDEA File Menu, choose New>New Project from Existing sources
+
==== KoLmafia has migrated to the GitHub with gradle builds. ====
−
##Choose the directory with the kolmafia build.xml file and press Open
+
 
−
##Choose Create Project from Existing Sources and press Next
+
 
−
##Enter the name KoLmafia and press Next
+
[https://www.jetbrains.com/idea/ IntelliJ IDEA] is an IDE for developing Java applications. 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.
−
##Verify that the project is visible to IDEA and press Finish
+
 
−
#Add the Ant Build File
+
The following instructions are based on IntelliJ IDEA 2021.2 Community Edition. Instructions for other versions/editions of IntelliJ may be slightly different.  The latest version is recommended.
−
## Open the Ant Toolbar item (typically on the right side, and not very large)
+
 
−
## Choose the + button to add a build file
+
== Create a Project ==
−
## Choose build.xml from the file selector and press Open
+
=== Create a new project ===
−
## Verify that a list of ANT targets appears in the Ant Toolbar
+
# Start IntelliJ IDEA. In the ''Welcome to IntelliJ IDEA'' dialog, click '''Get from VCS'''.<br>[[File:Intellij-setup-c2021.2-welcome.png|300px]]
−
#Check Project Settings
+
# In the ''Get from Version Control'' dialog, select the '''Repository URL''' tab.
−
## From the File Menu, choose Project Structure...
+
## In ''Version control'', select '''GitHub'''.<br>[[File:Intellij-setup-c2021.2-get-from-vcs.png|300px]]
−
## Select Project on the Left Menu
+
## Add a new repository location. To do so, click the '''+''' button next to ''Repositories''.<br>[[File:Intellij-setup-c2021.2-get-from-vcs-subversion.png|300px]]
−
### set the name to kolmafia
+
## In the ''New Repository Location'' popup, enter the URL to KoLmafia's GitHub repository. If you have a GitHub account and a Personal Access Token, use  git@github.com:kolmafia/kolmafia.git  If you do not have a GitHub account, use  https://github.com/kolmafia/kolmafia.git<br>[[File:Intellij-setup-c2021.2-new-repository-location.png|200px]]
−
### set the Project SDK to any SDK version 1.8 or higher
+
## Click '''OK''' to close the popup.
−
### set the project language level to 8
+
## Once the repository has been added, '''click the repository URL to highlight it''', then click '''Check Out'''.<br>[[File:Intellij-setup-c2021.2-get-from-vcs-check-out.png|300px]]
−
### set the project compiler output to build
+
# If the ''Destination Directory'' popup appears, choose a directory to check out the working copy.<br>''Caution'': Don't choose a common directory like <samp>C:\Users\&lt;username&gt;\Documents</samp>. Instead, create a new directory under it (by clicking the folder icon) and give it an appropriate name (e.g. <samp>kolmafia</samp>).<br>[[File:Intellij-setup-c2021.2-choose-working-copy-dir.png|200px]]<br>Click '''OK''' to continue.
−
## Select Modules on the Left Menu
+
# IntelliJ will generate a new project. If it asks you whether to add <code>kolmafia.iml</code> to Subversion, you may click '''Cancel''' to skip it
−
###
+
 
−
## Select Libraries on the Left Menu
+
=== Add the Gradle Build File ===
−
## Select Problems on the Left Menu (if the menu item shows any problems)
+
# Open the Gradle Toolbar Item (typically on the right side, and not very large)
−
## Press Apply
+
# Click the '''+''' button to add a build file
−
## Press OK
+
# Choose build.gradle from the file selector and press Open
−
#Add Run/Debug Configuration
+
#Run Configurations should contain <code>kolmafia [runShadow]</code>. If it does not, continue to the next steps.
 +
#In the Gradle Toolbar click on the elephant to Execute Gradle Task
 +
#A window titled ''Run Anything'' will popup. Search for <code>runShadow</code> and select it
 +
 
 +
===How to build and run/debug===
 +
#Click the drop down in the top right and select the desired option
 +
##<code>kolmafia [runShadow]</code> is the application itself
 +
##<code>Tests in 'KoLMafia'</code> are the unit tests
 +
#Click the play button to build and run
 +
#Or click the bug button to build and debug

Latest revision as of 01:09, 5 December 2023

KoLmafia has migrated to the GitHub with gradle builds.

IntelliJ IDEA is an IDE for developing Java applications. 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.

The following instructions are based on IntelliJ IDEA 2021.2 Community Edition. Instructions for other versions/editions of IntelliJ may be slightly different. The latest version is recommended.

Create a Project

Create a new project

  1. Start IntelliJ IDEA. In the Welcome to IntelliJ IDEA dialog, click Get from VCS.
    Intellij-setup-c2021.2-welcome.png
  2. In the Get from Version Control dialog, select the Repository URL tab.
    1. In Version control, select GitHub.
      Intellij-setup-c2021.2-get-from-vcs.png
    2. Add a new repository location. To do so, click the + button next to Repositories.
      Intellij-setup-c2021.2-get-from-vcs-subversion.png
    3. In the New Repository Location popup, enter the URL to KoLmafia's GitHub repository. If you have a GitHub account and a Personal Access Token, use git@github.com:kolmafia/kolmafia.git If you do not have a GitHub account, use https://github.com/kolmafia/kolmafia.git
      Intellij-setup-c2021.2-new-repository-location.png
    4. Click OK to close the popup.
    5. Once the repository has been added, click the repository URL to highlight it, then click Check Out.
      Intellij-setup-c2021.2-get-from-vcs-check-out.png
  3. If the Destination Directory popup appears, choose a directory to check out the working copy.
    Caution: Don't choose a common directory like C:\Users\<username>\Documents. Instead, create a new directory under it (by clicking the folder icon) and give it an appropriate name (e.g. kolmafia).
    Intellij-setup-c2021.2-choose-working-copy-dir.png
    Click OK to continue.
  4. IntelliJ will generate a new project. If it asks you whether to add kolmafia.iml to Subversion, you may click Cancel to skip it

Add the Gradle Build File

  1. Open the Gradle Toolbar Item (typically on the right side, and not very large)
  2. Click the + button to add a build file
  3. Choose build.gradle from the file selector and press Open
  4. Run Configurations should contain kolmafia [runShadow]. If it does not, continue to the next steps.
  5. In the Gradle Toolbar click on the elephant to Execute Gradle Task
  6. A window titled Run Anything will popup. Search for runShadow and select it

How to build and run/debug

  1. Click the drop down in the top right and select the desired option
    1. kolmafia [runShadow] is the application itself
    2. Tests in 'KoLMafia' are the unit tests
  2. Click the play button to build and run
  3. Or click the bug button to build and debug
Retrieved from "https://wiki.kolmafia.us/index.php?title=IntelliJ_Setup&oldid=9236"