IntelliJ Setup: Difference between revisions

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

Start IntelliJ IDEA. In the Welcome to IntelliJ IDEA dialog, click Get from VCS.
In the Get from Version Control dialog, select the Repository URL tab.
1. In Version control, select GitHub.
2. Add a new repository location. To do so, click the + button next to Repositories.
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
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.
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).

Click OK to continue.
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

Open the Gradle Toolbar Item (typically on the right side, and not very large)
Click the + button to add a build file
Choose build.gradle from the file selector and press Open
Run Configurations should contain kolmafia [runShadow]. 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 runShadow and select it

How to build and run/debug

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
Click the play button to build and run
Or click the bug button to build and debug

@@ 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'''
-##Verify that the project is visible to IDEA and press Finish
-#Add the Ant Build File
-## Open the Ant Toolbar Item (typically on the right side, and not very large)
-## Choose the '''+''' button to add a build file
-## Choose build.xml from the file selector and press Open
-## Verify that a list of ANT targets appears in the Ant Toolbar
-#Check Project Settings
-## From the '''File''' Menu, choose '''Project Structure...'''
-## Select '''Project''' on the Left Menu
-### set the '''Name''' to kolmafia
-### set the '''Project SDK''' to any SDK version 1.8 or higher
-### set the project language level to 8
-### set the project compiler output to the build subdirectory
-## Select the '''libraries''' tab
-### Choose the '''+''' button to add library
-### Select Type: Java
-### Open the lib/jar directory and select all jars
-### Select add to kolmafia  ''default is to name the library after the first jar.  This can be changed on the next step.''
-### Select the '''Name''' field and enter "kol-external-jars"
-## Select '''Modules''' in the Left Menu
-### In the '''Paths''' tab, select '''Inherit project compile output path'''
-## Close the Project Settings window
-#c Add Run/Debug Configuration
-## From the '''Run''' Menu choose '''Edit Configurations...'''
-## Choose the '''+''' button to add a new configuration
-## Select '''Application'''
-## In the '''Name''' Field, enter "KoLmafia"
-## In the '''Main Class''' Field, select the Selector '''[...]''', wait for it to populate the field, and choose KoLmafia
-## Add any VM or program arguments needed (typically none)
-## for the working directory, add the directory of your KoLmafia user data (e.g.  ~/Library/Application\ Support/kolmafia )
-## set the "before launch" tasks at bottom (may need to scroll to see the bottom of the configurations window...)
-### Select the '''+''' button at the bottom of the  the before launch group
-### Select Run ANT target '''set.released.false''' and drag it above the Build task.
-### Select Run ANT target '''set.version''' and drag it above the Build task.
-### Select Run ANT target '''unset.properties'''.  Leave it below the Build Task
-# Choose '''Apply'''
-# Choose '''Close'''
+[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.
-Test by pressing the run arrow next to your config name in the toolbar at the top of the window.
+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.
-For easier coding, download the [[:File:KoLMafia Style.xml|KoLMafia Style Definitions]] and import them in the IntelliJ Code Style Preferences
+== Create a Project ==
+=== Create a new project ===
+# Start IntelliJ IDEA. In the ''Welcome to IntelliJ IDEA'' dialog, click '''Get from VCS'''.<br>[[File:Intellij-setup-c2021.2-welcome.png|300px]]
+# In the ''Get from Version Control'' dialog, select the '''Repository URL''' tab.
+## In ''Version control'', select '''GitHub'''.<br>[[File:Intellij-setup-c2021.2-get-from-vcs.png|300px]]
+## 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]]
+## 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]]
+## Click '''OK''' to close the popup.
+## 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]]
+# 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.
+# 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
+=== Add the Gradle Build File ===
+# Open the Gradle Toolbar Item (typically on the right side, and not very large)
+# Click the '''+''' button to add a build file
+# Choose build.gradle from the file selector and press Open
+#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