Welcome to LaserLevel!
Compiling
Setup Java
The Java JDK is used to compile LaserLevel.
- Download and install the Java JDK.
- Windows/Mac download link. Scroll down, accept the
Oracle Binary Code License Agreement for Java SE
, and download it (if you have a 64-bit OS, please download the 64-bit version). - Linux: Installation methods for certain popular flavors of Linux are listed below. If your distribution is not listed, follow the instructions specific to your package manager or install it manually here.
- Gentoo:
emerge dev-java/oracle-jdk-bin
- Archlinux:
pacman -S jdk7-openjdk
- Ubuntu/Debian:
apt-get install openjdk-7-jdk
- Fedora:
yum install java-1.7.0-openjdk
- Gentoo:
- Windows/Mac download link. Scroll down, accept the
- Set up the environment.
- Windows: Set environment variables for the JDK.
- Go to
Control Panel\System and Security\System
, and click onAdvanced System Settings
on the left-hand side. - Click on
Environment Variables
. - Under
System Variables
, clickNew
. - For
Variable Name
, inputJAVA_HOME
. - For
Variable Value
, input something similar toC:\Program Files\Java\jdk1.7.0_45
exactly as shown (or wherever your Java JDK installation is), and clickOk
. - Scroll down to a variable named
Path
, and double-click on it. - Append
;%JAVA_HOME%\bin
EXACTLY AS SHOWN and clickOk
. Make sure the location is correct; double-check just to make sure.
- Go to
- Windows: Set environment variables for the JDK.
- Open up your command line and run
javac
. If it spews out a bunch of possible options and the usage, then you're good to go. If not try the steps again.
Setup Git
Git is used to clone LaserLevel and update your local copy.
- Download and install Git here.
- Optional Download and install a Git GUI client, such as Github for Windows/Mac, SmartGitHg, TortoiseGit, etc. A nice list is available here.
Setup LaserLevel
This section assumes that you're using the command-line version of Git.
- Open up your command line.
- Navigate to a place where you want to download LaserLevel's source (eg
C:\Development\Github\Minecraft\
) by executingcd [folder location]
. This location is known asmcdev
from now on. - Execute
git clone git@github.com:Lunatrius/LaserLevel.git
. This will download LaserLevel's source intomcdev
. - Right now, you should have a directory that looks something like:
mcdev
\-LaserLevel
\-LaserLevel's files (should have build.gradle)
Compile LaserLevel
- Execute
gradlew setupDevWorkspace
. This sets up Forge and downloads the necessary libraries to build LaserLevel. This might take some time, be patient.- You will generally only have to do this once until the Forge version in
build.properties
changes.
- You will generally only have to do this once until the Forge version in
- Execute
gradlew build
. If you did everything right,BUILD SUCCESSFUL
will be displayed after it finishes. This should be relatively quick.- If you see
BUILD FAILED
, check the error output (it should be right aroundBUILD FAILED
), fix everything (if possible), and try again.
- If you see
- Go to
mcdev\LaserLevel\build\libs
.- You should see a
.jar
file namedLaserLevel-#.#.#-#.#.#.#-universal.jar
.
- You should see a
- Copy the jar into your Minecraft mods folder, and you are done!
Updating Your Repository
In order to get the most up-to-date builds, you'll have to periodically update your local repository.
- Open up your command line.
- Navigate to
mcdev
in the console. - Make sure you have not made any changes to the local repository, or else there might be issues with Git.
- If you have, try reverting them to the status that they were when you last updated your repository.
- Execute
git pull master
. This pulls all commits from the official repository that do not yet exist on your local repository and updates it.
Shamelessly based this README off pahimar's version.