https://wiki.kolmafia.us/api.php?action=feedcontributions&feedformat=atom&user=AliumKolmafia - User contributions [en]2026-04-30T19:26:52ZUser contributionsMediaWiki 1.44.0https://wiki.kolmafia.us/index.php?title=IntelliJ_Setup&diff=9148IntelliJ Setup2022-02-18T03:04:12Z<p>Alium: Added steps to confirm gradle runShadow and how to build/run/debug</p>
<hr />
<div><br />
==== KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. ====<br />
<br />
<br />
[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.<br />
<br />
The following instructions are based on IntelliJ IDEA 2021.2 Community Edition. Instructions for other versions/editions of IntelliJ may be slightly different.<br />
<br />
== Create a Project ==<br />
=== Create a new project ===<br />
# Start IntelliJ IDEA. In the ''Welcome to IntelliJ IDEA'' dialog, click '''Get from VCS'''.<br>[[File:Intellij-setup-c2021.2-welcome.png|300px]]<br />
# In the ''Get from Version Control'' dialog, select the '''Repository URL''' tab.<br />
## In ''Version control'', select '''GitHub'''.<br>[[File:Intellij-setup-c2021.2-get-from-vcs.png|300px]]<br />
## 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]]<br />
## 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]]<br />
## Click '''OK''' to close the popup.<br />
## 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]]<br />
# 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.<br />
# 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<br />
<br />
=== Add the Gradle Build File ===<br />
# Open the Gradle Toolbar Item (typically on the right side, and not very large)<br />
# Click the '''+''' button to add a build file<br />
# Choose build.gradle from the file selector and press Open<br />
#Run Configurations should contain <code>kolmafia [runShadow]</code>. If it does not, continue to the next steps.<br />
#In the Gradle Toolbar click on the elephant to Execute Gradle Task<br />
#A window titled ''Run Anything'' will popup. Search for <code>runShadow</code> and select it<br />
<br />
===How to build and run/debug===<br />
#Click the drop down in the top right and select the desired option<br />
##<code>kolmafia [runShadow]</code> is the application itself<br />
##<code>Tests in 'KoLMafia'</code> are the unit tests<br />
#Click the play button to build and run<br />
#Or click the bug button to build and debug</div>Alium