Difference between revisions of "Compiling from Source"

From Kolmafia
Jump to navigation Jump to search
m (→‎Windows: draft)
(→‎Windows: untested!)
Line 21: Line 21:
 
### click on the 'edit environment variables' suggestion
 
### 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.
 
### 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.
−
# Get Source and Build
+
# 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)
−
## Connect to the Gi 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.
+
# Clone the source code for the KoLmafia Project.<br>
−
## Copy %ANT_HOME%/bin/ant.bat to your Desktop/kolmafia/ folder. If you have set up ANT correctly (and it's hard not to - there aren't many options) then double clicking on this file should compile the program.
+
##''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>''
 +
 
 +
=== 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)]
 
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.
 
# Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.
  

Revision as of 05:58, 5 December 2021

GREAT BIG NEWS

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

Windows

  1. Download Tools
    1. Download and install Java Development Kit 11 or newer, available from Adoption. The current recommended version is Java 17.
    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
  2. 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.
  3. 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)
  4. Clone the source code for the KoLmafia Project.
    1. If you have a github account:
      git clone git@github.com:kolmafia/kolmafia.git
    2. If not:
      git clone https://github.com/kolmafia/kolmafia.git
  5. 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)

  1. Compiling creates a "build" and "dist" folder. The end program is in dist/Kolmafia.jar.

Linux

Do once:

  1. Install git - you probably already have this. If not, follow this guide.
  2. Get an appropriate JDK. The safest and easiest way to do this is with Adoptium.
  3. Clone the repo:
    1. 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}"

Actually compile:

cd /where/you/cloned/kolmafia
./gradlew clean shadowJar

Get new updates with 

git pull

You have a KoLmafia jar file that can be invoked with 

java -jar dist/KoLmafia-*.jar

Do other installation steps as you wish.

MacOSX (updated for Git/Gradle)

  1. Verify required packages
    1. java --version
      • if not found or less than Java 11... Install Java Development Kit version 17 from Adoptium Temurin
    2. git --version
  2. Configure development environment
    Most of these steps can be included in .profile or the equivalent for your terminal 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
  3. 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)
  4. Clone the source code for the KoLmafia Project.
    1. If you have a github account:
      git clone git@github.com:kolmafia/kolmafia.git
    2. If not:
      git clone https://github.com/kolmafia/kolmafia.git
  5. Compile KoLmafia with the Gradle wrapper 
    cd kolmafia && ./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) '

Retrieved from "https://wiki.kolmafia.us/index.php?title=Compiling_from_Source&oldid=9125"