|
|
| Line 1: |
Line 1: |
| − | === GREAT BIG NEWS ===
| + | sun-java6-jdk is no longer available past squeeze and has been replaced by openjdk. Could someone test if the openjdk package can be used to compile kolmafia properly and replace the info in the page? Thanks - PASTA_KING99 |
| | | | |
| − | ==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.
| |
| | | | |
| − | | + | ===TODO=== |
| − | | + | test and fix Windows instructions. |
| − | 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== | |
| − | # 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 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>''
| |
| − | | |
| − | === 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.
| |
| − | | |
| − | ==Linux==
| |
| − | | |
| − | 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. 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>
| |
| − | | |
| − | Actually compile:<pre>cd /where/you/cloned/kolmafia</pre>
| |
| − | <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>
| |
| − | | |
| − | Do other installation steps as you wish.
| |
| − | | |
| − | ==MacOSX (updated for Git/Gradle)==
| |
| − | # Verify required packages
| |
| − | ## <code>''java --version''</code>
| |
| − | ##* if not found or less than Java 11... 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 terminal 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>
| |
| − | # Compile KoLmafia with the Gradle wrapper ''<syntaxhighlight lang="bash">cd kolmafia && ./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]]''
| |