Compiling from Source - Revision history

Mcroft: /* Optional */

2023-12-05T01:00:28Z

Optional

← Older revision		Revision as of 01:00, 5 December 2023
Line 27:		Line 27:
	# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''		# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && gradlew.bat runShadow</syntaxhighlight>''

	=== Optional ===		===== Optional =====
	If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]		If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
	====Linux====		====Linux====

Mcroft: Organiazation

2023-12-05T00:59:38Z

Organiazation

← Older revision		Revision as of 00:59, 5 December 2023
Line 1:		Line 1:
	=== News ===		== News ==
	''Once great and big, now secondhand news...''		''Once great and big, now secondhand news...''

	==KoLmafia has migrated to the GitHub, GIT and gradle.==		===KoLmafia has migrated to the GitHub, GIT and gradle.===
	The Windows, Linux and macOS instructions have been updated, and might have been lightly tested		The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

Line 9:		Line 9:
	To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the git repository, and be comfortable writing Java Code. Instructions for the first two are included below:		To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the git repository, and be comfortable writing Java Code. Instructions for the first two are included below:

	==Windows==		====Windows====
	# Download Tools		# Download Tools
	## Download and install Java Development Kit 17 or newer, available from [https://adoptium.net/temurin/releases/?version=17 Adoptium]. The minimum recommended version is Java 17, but check the Recommended Java version on the [https://kolmafia.us KoLmafia Forums] to be up to date].		## Download and install Java Development Kit 17 or newer, available from [https://adoptium.net/temurin/releases/?version=17 Adoptium]. The minimum recommended version is Java 17, but check the Recommended Java version on the [https://kolmafia.us KoLmafia Forums] to be up to date].
Line 29:		Line 29:
	=== Optional ===		=== Optional ===
	If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]		If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
	==Linux==		====Linux====

	Do once:		Do once:
Line 49:		Line 49:
	Do other installation steps as you wish.		Do other installation steps as you wish.

	==macOS==		====macOS====
	# Verify required packages		# Verify required packages
	## <code>''java --version''</code>		## <code>''java --version''</code>

Mcroft: /* News (once great and big, now secondhand news) */

2023-12-05T00:57:23Z

News (once great and big, now secondhand news)

← Older revision		Revision as of 00:57, 5 December 2023
Line 1:		Line 1:
	=== News ~~(once~~ great and big, now secondhand news~~) ===~~		=== News ===
			''Once great and big, now secondhand news...''

	==KoLmafia has migrated to the GitHub, GIT and gradle.==		==KoLmafia has migrated to the GitHub, GIT and gradle.==

Mcroft at 00:56, 5 December 2023

2023-12-05T00:56:05Z

← Older revision		Revision as of 00:56, 5 December 2023
Line 1:		Line 1:
	=== ~~GREAT BIG NEWS~~ ===		=== News (once great and big, now secondhand news) ===

	==KoLmafia has migrated to the GitHub, GIT and gradle.==		==KoLmafia has migrated to the GitHub, GIT and gradle.==
	The Windows, Linux and macOS instructions have been updated, and might have been lightly tested		The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

	The good news is that the [[Development Environment Setup\|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.~~		The good news is that the [[Development Environment Setup\|IDE setup]] is a lot easier. The bad news is you'll need to take some steps to build anything.

	To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the git repository, and be comfortable writing Java Code. Instructions for the first two are included below:		To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the git repository, and be comfortable writing Java Code. Instructions for the first two are included below:
Line 10:		Line 10:
	==Windows==		==Windows==
	# Download Tools		# Download Tools
	## Download and install Java Development Kit 11 or newer, available from [https://adoptium.net/~~installation.html Adoption~~]. The ~~current~~ recommended version is Java 17.		## Download and install Java Development Kit 17 or newer, available from [https://adoptium.net/temurin/releases/?version=17 Adoptium]. The minimum recommended version is Java 17, but check the Recommended Java version on the [https://kolmafia.us KoLmafia Forums] to be up to date].
	## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]		## Download and install GIT following the instructions from [https://www.atlassian.com/git/tutorials/install-git#windows Atlassian's GIT install page.]
	## Download and install Tortoise GIT (if needed) from https://tortoisegit.org		## Download and install Tortoise GIT (if needed) from https://tortoisegit.org
Line 51:		Line 51:
	# Verify required packages		# Verify required packages
	## <code>''java --version''</code>		## <code>''java --version''</code>
	##* if not found or less than Java 11... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]		##* if not found or less than Java 17... Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
	## <code>''git --version''</code>		## <code>''git --version''</code>
	##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]		##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]

Mcroft: /* KoLmafia has migrated to the GitHub, GIT and gradle. */

2021-12-28T17:44:52Z

KoLmafia has migrated to the GitHub, GIT and gradle.

← Older revision		Revision as of 17:44, 28 December 2021
Line 4:		Line 4:
	The Windows, Linux and macOS instructions have been updated, and might have been lightly tested		The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

	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.		The good news is that the [[Development Environment Setup\|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.

	To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the git repository, and be comfortable writing Java Code. Instructions for the first two are included below:		To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the git repository, and be comfortable writing Java Code. Instructions for the first two are included below:

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

2021-12-28T17:11:13Z

KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.: --just fixing the ToC entry

← Older revision		Revision as of 17:11, 28 December 2021
Line 1:		Line 1:
	=== GREAT BIG NEWS ===		=== GREAT BIG NEWS ===

	==KoLmafia has migrated to the GitHub ~~repository and we are retooling for~~ GIT and gradle ~~builds~~.==		==KoLmafia has migrated to the GitHub, GIT and gradle.==
	The Windows, Linux and macOS instructions have been updated, and might have been lightly tested		The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

Mcroft: /* macOS */

2021-12-28T17:09:51Z

macOS

← Older revision		Revision as of 17:09, 28 December 2021
Line 54:		Line 54:
	## <code>''git --version''</code>		## <code>''git --version''</code>
	##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]		##* If not found ... Install git: Atlassian has a great document on [https://www.atlassian.com/git/tutorials/install-git the various ways to install Git]
	# Configure development environment<br>Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your ~~terminal~~ of choice.		# Configure development environment<br>Most of these steps can be included in ''<code>.profile</code>'' or the equivalent for your shell of choice.
	## In the terminal set JAVA_HOME to the java home directory. <br>''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home.<br>If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>		## In the terminal set JAVA_HOME to the java home directory. <br>''<code>/usr/libexec/java_home -V</code>'' will list all known values for java_home.<br>If you have multiple copies of java, choose the version you want to use''.'' <code>''export JAVA_HOME=`/usr/libexec/java_home -v17''</code>
	# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)		# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd ~/projects</code>, or some similar directory)

Heeheehee: Update Linux / Mac instructions to be more consistent about fetching updates from the remote repository.

2021-12-06T13:28:43Z

Update Linux / Mac instructions to be more consistent about fetching updates from the remote repository.

← Older revision		Revision as of 13:28, 6 December 2021
Line 6:		Line 6:
	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.		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.

	To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the ~~SVN~~ and be comfortable writing Java Code. Instructions for the first two are included below:		To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the git repository, and be comfortable writing Java Code. Instructions for the first two are included below:

	==Windows==		==Windows==
Line 32:		Line 32:
	Do once:		Do once:
	# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]		# Install git - you probably already have this. If not, follow [https://www.atlassian.com/git/tutorials/install-git#linux this guide.]
	# Get an appropriate JDK. ~~The~~ safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].		# Get an appropriate JDK. If your package manager does not contain a sufficiently up-to-date version of Java, the safest and easiest way to do this is with [https://adoptium.net/installation.html#x64_linux-jdk Adoptium].
	# Clone the repo:		# Clone the repo:
	## If you have a github account:<syntaxhighlight lang="bash">		## If you have a github account:<syntaxhighlight lang="bash">
Line 39:		Line 39:

	Do every session:		Do every session:
	Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre>		# Set up your environment to use that JDK you just downloaded<pre> export PATH="/where/you/put/that/jdk/bin:${PATH}"</pre> (Optionally, put this in your ''.profile'' or ''.bashrc'' if you want to set and forget.)
			# Navigate to your cloned repository: <pre>cd /where/you/cloned/kolmafia</pre>
	~~Actually compile~~:<pre>cd /where/you/cloned/kolmafia</pre>		# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
	<pre>~~./gradlew clean shadowJar~~</pre>		# Build the new jar: <pre>./gradlew clean shadowJar</pre>

	~~Get~~ new ~~updates with~~ <pre>~~git pull~~</pre>

	You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>		You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>
Line 50:		Line 48:
	Do other installation steps as you wish.		Do other installation steps as you wish.

	==~~MacOSX~~==		==macOS==
	# Verify required packages		# Verify required packages
	## <code>''java --version''</code>		## <code>''java --version''</code>
Line 63:		Line 61:
	git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>		git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
	##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>		##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</syntaxhighlight>
	# Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">~~cd kolmafia &&~~ ./gradlew runShadow</syntaxhighlight>''
			Do every session:

			# Navigate to your cloned repository: <pre>cd ~/projects/kolmafia</pre>
			# Get new updates with <pre>git pull</pre> If you have local uncommitted changes, you may want to instead use ''git stash && git pull && git stash pop''.
			# Compile KoLmafia with the Gradle wrapper: ''<syntaxhighlight lang="bash">./gradlew runShadow</syntaxhighlight>''

	=== Optional ===		=== Optional ===
	If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]		If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
	''[[Category:Tech Support]]''		''[[Category:Tech Support]]''

Mcroft: /* MacOSX (updated for Git/Gradle) */

2021-12-05T06:01:23Z

MacOSX (updated for Git/Gradle)

← Older revision		Revision as of 06:01, 5 December 2021
Line 50:		Line 50:
	Do other installation steps as you wish.		Do other installation steps as you wish.

	==MacOSX ~~(updated for Git/Gradle)~~==		==MacOSX==
	# Verify required packages		# Verify required packages
	## <code>''java --version''</code>		## <code>''java --version''</code>

Mcroft: /* GREAT BIG NEWS */

2021-12-05T06:00:40Z

GREAT BIG NEWS

← Older revision		Revision as of 06:00, 5 December 2021
Line 2:		Line 2:

	==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==		==KoLmafia has migrated to the GitHub repository and we are retooling for GIT and gradle builds.==
	The Windows ~~section of this page is currently out of date. The~~ Linux and macOS ~~ones~~ have been updated.		The Windows, Linux and macOS instructions have been updated, and might have been lightly tested

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



	To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:		To contribute to the Mafia project, you'll need to be able to install the Java Development Kit, connect to the SVN and be comfortable writing Java Code. Instructions for the first two are included below:
Line 30:		Line 28:
	=== Optional ===		=== Optional ===
	If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]		If you intend to commit code to GitHub, you will need to follow GitHub's instructions for [https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token adding a Personal Access Token (PAT)]
	~~# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.~~

	==Linux==		==Linux==