Difference between pages "Visit" and "IntelliJ Setup"

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: @@
-{{
-#vardefine:name|visit}}{{
-#vardefine:return_type|boolean}}{{
-FunctionPage|
+==== KoLmafia has migrated to the GitHub with gradle builds. ====
-name={{#var:name}}|
-function1={{Function|
-name={{#var:name}}|
-aggregate={{#var:aggregate}}|
-return_type=boolean|
-return_also={{#var:return_also}}|
-parameter1={{Param|coinmaster|master}}|
-p1desc={{pspan|master}} is the coinmaster to purchase from|
-}}|
+[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.
-function_description=Visits a coinmaster to see what is currently for sale there. This is useful for coinmasters whose inventory may change, such as the Hermit, Mr. Store and Traveling Trader. Returns true if the visit was successful or false if it was unsuccessful.|
+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.
-code1={{CodeSample|
+== Create a Project ==
-title=Code Sample|
+=== Create a new project ===
-description=This checks to see if a clover is currently available for purchase.|
+# Start IntelliJ IDEA. In the ''Welcome to IntelliJ IDEA'' dialog, click '''Get from VCS'''.<br>[[File:Intellij-setup-c2021.2-welcome.png|300px]]
-code=
+# In the ''Get from Version Control'' dialog, select the '''Repository URL''' tab.
-<syntaxhighlight>
+## In ''Version control'', select '''GitHub'''.<br>[[File:Intellij-setup-c2021.2-get-from-vcs.png|300px]]
-if(visit($coinmaster[Hermit])) {
+## 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]]
-   if(sells_item($coinmaster[Hermit], $item[ten-leaf clover]))
+## 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]]
-      print("There is still a ten-leaf clover available to purchase today!");
+## Click '''OK''' to close the popup.
-   else print("The Hermit is out of clovers. :(");
+## 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]]
-} else print(inaccessible_reason($coinmaster[Hermit]));
+# 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.
-</syntaxhighlight>
+# 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
-}}|
-see_also={{SeeAlso|is_accessible|sells_item|buys_item}}|
+=== 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
-[[Category:Item Management]]
+===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