IntelliJ Setup - Revision history

Mcroft: /* KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. */

2023-12-05T01:09:20Z

KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.

← Older revision		Revision as of 01:09, 5 December 2023
Line 1:		Line 1:

	==== KoLmafia has migrated to the GitHub ~~repository and we are retooling for GIT and~~ gradle builds. ====		==== KoLmafia has migrated to the GitHub with gradle builds. ====


	[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.		[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.

	The following instructions are based on IntelliJ IDEA 2021.2 Community Edition. Instructions for other versions/editions of IntelliJ may be slightly different.		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 Project ==

Alium: Added steps to confirm gradle runShadow and how to build/run/debug

2022-02-18T03:04:12Z

Added steps to confirm gradle runShadow and how to build/run/debug

← Older revision		Revision as of 03:04, 18 February 2022
Line 23:		Line 23:
	# Click the '''+''' button to add a build file		# Click the '''+''' button to add a build file
	# Choose build.gradle from the file selector and press Open		# 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

	=== ~~From~~ the ~~Gradle Menu,~~ select ~~Applications~~>run ~~===~~		===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

Mcroft: /* Updated for GitHub

2021-10-29T03:39:13Z

/* Updated for GitHub

Show changes

Mcroft: start of new build instructions

2021-09-29T02:09:11Z

start of new build instructions

← Older revision		Revision as of 02:09, 29 September 2021
Line 1:		Line 1:

			== KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds. ==
			Exactly nothing below here is accurate, and we'll need to do a thorough cleanup of the build page and the IDE setup page.

			The good news is that the IDE setup is a lot easier. The bad news is you'll need to take some steps to build anything. In addition, we are discussing changing to a newer required JDK, so even these instructions will not be permanent.


	[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.		[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.

Philmasterplus: Update guide, adding screenshots from IntelliJ IDEA 2021.2 Community edition

2021-08-02T09:43:49Z

Update guide, adding screenshots from IntelliJ IDEA 2021.2 Community edition

Show changes

Mcroft: Added Test Folder designation, because IJ doesn't always automatically detect it (thanks, PhilMasterPlus)

2021-02-09T04:27:16Z

Added Test Folder designation, because IJ doesn't always automatically detect it (thanks, PhilMasterPlus)

← Older revision		Revision as of 04:27, 9 February 2021
Line 33:		Line 33:
	## Select the '''Name''' field and enter "kol-source-jars"		## Select the '''Name''' field and enter "kol-source-jars"
	# Select '''Modules''' in the Left Menu		# Select '''Modules''' in the Left Menu
			## Choose the '''Sources''' tab
			### Right-click the '''lib''' and '''src''' folders and verify that each is marked as ''Sources''
			### Right-click the '''test''' folder and verify that it is marked ''Test''
	## In the '''Paths''' tab, select '''Inherit project compile output path'''		## In the '''Paths''' tab, select '''Inherit project compile output path'''
	# Close the Project Settings window		# Close the Project Settings window

Philmasterplus at 03:07, 9 February 2021

2021-02-09T03:07:23Z

Philmasterplus: Use better sections

2021-02-09T03:06:02Z

Use better sections

@@ 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.
-=== Build and Config Project Setup ===
+== Build and Config Project Setup ==
-#From the IntelliJ IDEA '''File''' Menu, choose '''New'''>'''New Project from Existing Sources...'''
+# From the IntelliJ IDEA '''File''' Menu, choose '''New'''>'''New Project from Existing Sources...'''
-##Choose the directory with the kolmafia build.xml file and press '''Open'''
+#Choose the directory with the kolmafia build.xml file and press '''Open'''
-##Choose '''Create Project from Existing Sources''' and press '''Next'''
+#Choose '''Create Project from Existing Sources''' and press '''Next'''
-##Enter the name KoLmafia and press '''Next'''
+#Enter the name KoLmafia and press '''Next'''
-##Verify that the project is visible to IDEA and press Finish
+#Verify that the project is visible to IDEA and press Finish
-Test by pressing the run arrow next to your config name in the toolbar at the top of the window.
+== Add Run/Debug Configuration ==
-====== Optional Steps ======
+Test by pressing the Run arrow next to your config name in the toolbar at the top of the window.
 * Setup SVN to update from IntelliJ (can still be done from the command line or a tool)
 *# TODO: FIXME...
-* For easier coding, download the [[:File:KoLMafia Style.xml|KoLMafia Style Definitions]] and import them in the IntelliJ Code Style Preferences.
+* To use the Reformat Code feature, download the [[:File:KoLMafia Style.xml|KoLMafia Style Definitions]] and import them in the IntelliJ Code Style Preferences.

Philmasterplus: /* Build and Config Project Setup */ Adding "before launch" tasks for IntelliJ IDEA 2020.3

2021-02-09T03:02:27Z

Build and Config Project Setup: Adding "before launch" tasks for IntelliJ IDEA 2020.3

← Older revision		Revision as of 03:02, 9 February 2021
Line 40:		Line 40:
	## Add any VM or program arguments needed (typically none)		## 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 )		## 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.~~..)~~		## Add the following "before launch" tasks. For IntelliJ IDEA 2020.3, click ''Modify options'' at top right and select ''Add before launch task''. For older versions of IntelliJ, 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 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.released.false''' and drag it above the Build task.

Mcroft: Updated to match new src/jar config

2020-11-25T02:00:59Z

Updated to match new src/jar config

← Older revision		Revision as of 02:00, 25 November 2020
Line 24:		Line 24:
	### Open the lib/jar directory and select all jars		### 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 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 the '''Name''' field and enter "kol-library-jars"
			### Choose the '''+''' button to add another library
			### Open the src/jar directory and select all jars
			### Select add to kolmafia
			### Select the '''Name''' field and enter "kol-source-jars"
	## Select '''Modules''' in the Left Menu		## Select '''Modules''' in the Left Menu
	### In the '''Paths''' tab, select '''Inherit project compile output path'''		### In the '''Paths''' tab, select '''Inherit project compile output path'''

← Older revision		Revision as of 03:07, 9 February 2021
Line 2:		Line 2:

	== Build and Config Project Setup ==		== Build and Config Project Setup ==
			=== Load the project into IntelliJ ===
	# From the IntelliJ IDEA '''File''' Menu, choose '''New'''>'''New Project from Existing Sources...'''		# From the IntelliJ IDEA '''File''' Menu, choose '''New'''>'''New Project from Existing Sources...'''
	#Choose the directory with the kolmafia build.xml file and press '''Open'''		#Choose the directory with the kolmafia build.xml file and press '''Open'''
Line 8:		Line 9:
	#Verify that the project is visible to IDEA and press Finish		#Verify that the project is visible to IDEA and press Finish

	== Add the Ant Build File ==		=== Add the Ant Build File ===
	# Open the Ant Toolbar Item (typically on the right side, and not very large)		# Open the Ant Toolbar Item (typically on the right side, and not very large)
	# Choose the '''+''' button to add a build file		# Choose the '''+''' button to add a build file
Line 14:		Line 15:
	# Verify that a list of ANT targets appears in the Ant Toolbar		# Verify that a list of ANT targets appears in the Ant Toolbar

	== Check Project Settings ==		=== Check Project Settings ===
	# From the '''File''' Menu, choose '''Project Structure...'''		# From the '''File''' Menu, choose '''Project Structure...'''
	# Select '''Project''' on the Left Menu		# Select '''Project''' on the Left Menu
Line 35:		Line 36:
	# Close the Project Settings window		# Close the Project Settings window

	== Add Run/Debug Configuration ==		=== Add Run/Debug Configuration ===
	# From the '''Run''' Menu choose '''Edit Configurations...'''		# From the '''Run''' Menu choose '''Edit Configurations...'''
	# Choose the '''+''' button to add a new configuration		# Choose the '''+''' button to add a new configuration