Runix is a mod that is is heavily influence and based on [Runecraft] (http://dev.bukkit.org/bukkit-plugins/runecraft/)
To contribute Runix you must:
1: Have a basic to working knowledge of Java and the Forge api.
2: Have a basic to working knowledge of how git works.
3: A GitHub account
4: Fork the project
The Java JDK is used to compile Runix.
- 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
- 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_51
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
- 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.
Gradle is used to execute the various build tasks when compiling Runix.
- Download and install Gradle.
- Windows/Mac download link. You only need the binaries, but choose whatever flavor you want.
- Unzip the package and put it wherever you want, eg
C:\Gradle
.
- Unzip the package and put it wherever you want, eg
- 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/gradle-bin
- Archlinux: You'll have to install it from the AUR.
- Ubuntu/Debian:
apt-get install gradle
- Fedora: Install Gradle manually from its website (see above), as Fedora ships a "broken" version of Gradle. Use
yum install gradle
only if you know what you're doing.
- Gentoo:
- Windows/Mac download link. You only need the binaries, but choose whatever flavor you want.
- Windows: Set environment variables for Gradle.
- Go back to
Environment Variables
and then create a new system variable. - For
Variable Name
, inputGRADLE_HOME
. - For
Variable Value
, input something similar toC:\Gradle-1.11
exactly as shown (or wherever your Gradle installation is), and clickOk
. - Scroll down to
Path
again, and append;%GRADLE_HOME%\bin
EXACTLY AS SHOWN and clickOk
. Once again, double-check the location.
- Go back to
- Open up your command line and run
gradle
. If it says "Welcome to Gradle [version].", then you're good to go.
Git is used to clone Runix 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.
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 Runix's source (eg
C:\Github\Runix\
) by executingcd [folder location]
. This location is known asWorkingDIR
from now on. - Execute
git clone https://github.com/Runix-Minecraft/Runix.git
. This will download Runix's source intoWorkingDIR
. - Right now, you should have a directory that looks something like:
WorkingDIR
\-Runix
\-Runix's files (should have `build.gradle`)
- Execute
gradlew setupCiWorkspace
. This sets up Forge and downloads the necessary libraries to build Runix. 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
- Navigate to
WorkingDIR\Runix\build\libs
.- You should see a
.jar
file namedRunix-1.7.10-majorversion.minorversion.local.jar
- NOTE: The local in the file name means that the jar was not built on our build server
- You should see a
- Copy the jar
A PR MUST meet these standards befor being merged:
1: The PR MUST be singed off by the author
2: The coding style MUST be uniform with Runix's(LordIllyohs HATES none uniform styles)
3: The PR MUST pass a Travis-ci build, if it fails odds are it won't be merged.
-If you think it should still be merged please give us a GOOD reason to do so.
[Forum Page] (http://www.minecraftforum.net/topic/2259223-wip-runix-the-block-based-magic-mod-inspired-by-runecraft/)
[Wiki Page] (http://runix.wikia.com/wiki/Runix_Wiki)
[Runix's licence] (http://creativecommons.org/licenses/by-nc-sa/4.0/)