Difference between revisions of "Compiling from Source"

Latest revision as of 01:00, 5 December 2023

News

Once great and big, now secondhand news...

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

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

Download Tools
1. Download and install Java Development Kit 17 or newer, available from Adoptium. The minimum recommended version is Java 17, but check the *Recommended Java* version on the KoLmafia Forums to be up to date].
2. Download and install GIT following the instructions from Atlassian's GIT install page.
3. Download and install Tortoise GIT (if needed) from https://tortoisegit.org
Configure Windows Environment Variables

Win 10 Environment Variable Editor
1. Windows 10
  1. Go to settings
  2. type 'enviro' in the search
  3. click on the 'edit environment variables' suggestion
  4. add or edit JAVA_HOME, and PATH variables
    PATH should include JAVA_HOME
    If the JAVA installer has already set these variables, they can be updated or left alone.
Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. cd %USERPROFILE%\projects, or some similar directory)

Clone the source code for the KoLmafia Project.

If you have a github account:

git clone git@github.com:kolmafia/kolmafia.git

If not:

git clone https://github.com/kolmafia/kolmafia.git

Compile KoLmafia with the Gradle wrapper cd kolmafia && gradlew.bat runShadow

Optional

If you intend to commit code to GitHub, you will need to follow GitHub's instructions for adding a Personal Access Token (PAT)

Linux

Do once:

Install git - you probably already have this. If not, follow this guide.
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 Adoptium.

Clone the repo:

If you have a github account:

git clone git@github.com:kolmafia/kolmafia.git

If not:

git clone https://github.com/kolmafia/kolmafia.git

Do every session:

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

You have a KoLmafia jar file that can be invoked with

java -jar dist/KoLmafia-*.jar

Do other installation steps as you wish.

macOS

Verify required packages
1. java --version
  - if not found or less than Java 17... Install Java Development Kit version 17 from Adoptium Temurin
2. git --version
  - If not found ... Install git: Atlassian has a great document on the various ways to install Git
Configure development environment
Most of these steps can be included in .profile or the equivalent for your shell of choice.
1. In the terminal set JAVA_HOME to the java home directory.
  /usr/libexec/java_home -V will list all known values for java_home.
  If you have multiple copies of java, choose the version you want to use. export JAVA_HOME=`/usr/libexec/java_home -v17
Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/projects, or some similar directory)

Clone the source code for the KoLmafia Project.

If you have a github account:

git clone git@github.com:kolmafia/kolmafia.git

If not:

git clone https://github.com/kolmafia/kolmafia.git

Do every session:

Navigate to your cloned repository:
```
cd ~/projects/kolmafia
```
Get new updates with
```
git pull
```
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: ./gradlew runShadow

Optional

If you intend to commit code to GitHub, you will need to follow GitHub's instructions for adding a Personal Access Token (PAT) '

@@ Line 1: / Line 1: @@
-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:
+== News ==
+''Once great and big, now secondhand news...''
-==Windows==
+===KoLmafia has migrated to the GitHub, GIT and gradle.===
-# Download and install the Java Development Kit, available here: http://java.sun.com/javase/downloads/index.jsp
+The Windows, Linux and macOS instructions have been updated, and might have been lightly tested
-# Download and install Subversion, available here: http://www.collab.net/downloads/subversion/
-# Download and install Tortoise SVN (or of course, another SVN program), available here: http://tortoisesvn.tigris.org/
-# Download and install WinAnt, available here: http://code.google.com/p/winant/
-# Connect to the SVN server and download the source code for the Mafia Project. Using Tortoise SVN, you have to right-click on your desktop, select "SVN Checkout", and put the URL of the repository as "svn://svn.code.sf.net/p/kolmafia/code/". Leave all other settings as they are, and click OK.
-# Copy C:/Program Files/WinAnt/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up WinAnt correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.
-# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.
-===Troubleshooting===
-====Double-Clicking ''ant.bat''====
-Due to how bat files work when you double-click them, ''ant.bat'' will auto-close before you can read its output.
-# ant assumes that builds are done from a command shell.  You'll need to run from the command shell to execute any ant target other than the default, such as ''ant.bat exec'' or ''ant.bat daily''
-# An easy workaround is to add a "pause" near the bottom of the file before it has a chance to auto-close on you.<br>When you run it again, you'll be able to read its output and it will exit after you ''Press any key to continue...''
-# Alternatively, you can create a wrapper batch file that calls the existing ''ant.bat'' file and adds a pause after executing it.  This method allows you to set different ant targets and also prevents updates to ant from overwriting your modifications.
-====''tools.jar'' not found====
-If you get an error message about "tools.jar" not being found, this means you're trying to build with the JRE (which doesn't contain this file) rather than the JDK (which contains it).<br>
-To fix this, right click on ''my computer'' -> ''properties'' -> ''advanced system settings'' -> ''Environment Variables...'' then make sure your PATH contains a reference to the location of your JDK directory.
-==Linux==
+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.
-# Install Sun Java Development Kit ( debian: apt-get install sun-java6-jdk )
+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:
-# Install Subversion ( debian: apt-get install svn )
-# Install Ant ( debian: apt-get install ant )
-# Connect to the SVN server and download the source code for the Mafia Project. ( svn checkout svn://svn.code.sf.net/p/kolmafia/code/ kolmafia )
-# Verify tou are using sun-java with ( debian: update-alternatives --all )
-# I had to change $JAVA_HOME to compile ( export JAVA_HOME=/usr/lib/jvm/java-6-sun-1.6.0.12 )
-# Compile kolmafia with Ant ( debian: cd kolmafia && ant debian )
-# Install kolmafia ( debian: cd dist && dpkg -i kolmafia*.deb )
-==MacOSX==
+====Windows====
+# 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 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
+# Configure Windows Environment Variables[[File:Environment vars.jpg|thumb|Win 10 Environment Variable Editor]]
+## Windows 10
+### Go to settings
+### type 'enviro' in the search
+### click on the 'edit environment variables' suggestion
+### add or edit JAVA_HOME, and PATH variables<br>''PATH should include JAVA_HOME''</br>If the JAVA installer has already set these variables, they can be updated or left alone.
+# Open a new Command Prompt (or Powershell) window and navigate to the directory to which you wish to create kolmafia (e.g. <code>cd %USERPROFILE%\projects</code>, or some similar directory)
+# Clone the source code for the KoLmafia Project.<br>
+##''If you have a github account:''<syntaxhighlight lang="bash">
+git clone git@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.bat runShadow</syntaxhighlight>''
-# Install the appropriate developer tools for your version of MacOSX from the Mac Dev Center (http://developer.apple.com/devcenter/mac/index.action) or from your original OS install disks.
+===== Optional =====
-# Open a new terminal window and navigate to the directory to which you wish to create kolmafia (e.g. cd ~/Projects, or some similar directory)
+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)]
-# Connect to the SVN server and download the source code for the Mafia Project. (svn checkout <nowiki>svn://svn.code.sf.net/p/kolmafia/code/</nowiki> kolmafia )
+====Linux====
-# Compile kolmafia with Ant (cd kolmafia && ant jarbundler) (use ant daily jarbundler after the initial install to update kol and build in one step)
-# copy the application to your preferred location: (cp ./dist/KoLMafia.app /Applications)
-[[Category:Tech Support]]
+Do once:
+# 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. 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:
+## If you have a github account:<syntaxhighlight lang="bash">
+git clone git@github.com:kolmafia/kolmafia.git
+</syntaxhighlight>If not:<pre>git clone https://github.com/kolmafia/kolmafia.git</pre>
+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> (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>
+# 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''.
+# Build the new jar: <pre>./gradlew clean shadowJar</pre>
+You have a KoLmafia jar file that can be invoked with <pre>java -jar dist/KoLmafia-*.jar</pre>
+Do other installation steps as you wish.
+====macOS====
+# Verify required packages
+## <code>''java --version''</code>
+##* if not found or less than Java 17...  Install Java Development Kit version 17 from [https://adoptium.net Adoptium Temurin]
+## <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]
+# 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>
+# 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)
+# Clone the source code for the KoLmafia Project.<br>
+##''If you have a github account:''<syntaxhighlight lang="bash">
+git clone git@github.com:kolmafia/kolmafia.git</syntaxhighlight>
+##''If not:''<syntaxhighlight lang="bash">git clone https://github.com/kolmafia/kolmafia.git</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 ===
+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]]''

Difference between revisions of "Compiling from Source"

Latest revision as of 01:00, 5 December 2023

Contents

News

KoLmafia has migrated to the GitHub, GIT and gradle.

Windows

Optional

Linux

macOS

Optional

Navigation menu

Search