7.3 KiB
7.3 KiB
Welcome to Equivalent Exchange 3!
LATEST OFFICIAL VERSION: [EE3 pre1g for 1.5.1/1.5.2] (http://adf.ly/Mj3ZL)
[Minecraft Forums page] (http://www.minecraftforum.net/topic/1540010-equivalent-exchange-3)
[Compiling EE3] (https://github.com/pahimar/Equivalent-Exchange-3#compiling-equivalent-exchange-3) - For those that want the latest unreleased features.
[Contributing] (https://github.com/pahimar/Equivalent-Exchange-3#contributing) - For those that want to help out.
Compiling Equivalent Exchange 3
IMPORTANT: This is not guaranteed to work as it has not been tested extensively (Linux and Windows tested).
Prerequisites (Tested for Windows ONLY!)
- WARNING: Make sure you know EXACTLY what you're doing! It's not any of our faults if your OS crashes, becomes corrupted, etc.
- Download and install the Java JDK [here] (http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html). Scroll down, accept the
Oracle Binary Code License Agreement for Java SE
, and download the one pertaining to your OS (necessary for MCP).- Go to
Control Panel\System and Security\System
, and click onAdvanced System Settings
on the left-hand side. - Click on
Environment Variables
.
- Go to
- Under
System Variables
, clickNew
. - For
Variable Name
, inputJAVA_HOME
. - For
Variable Value
, input something similar to;C:\Program Files (x86)\Java\jdk1.7.0_21
exactly as shown to the end (or wherever your Java JDK installation is), and clickOk
. - Scroll down to a variable named
Path
, and double-click on it. - Append
;C:\Program Files (x86)\Java\jdk1.7.0_21\bin
(or your Java JDK installation directory\bin), and clickOk
.
- Download Apache Ant [here] (http://ant.apache.org).
- Unzip the files anywhere you want, eg
C:\Program Files (x86)\Ant
.
- Unzip the files anywhere you want, eg
- Again, go to
Environment Variables
just like you did for the Java JDK. - Under
System Variables
, clickNew
. - For
Variable Name
, inputANT_HOME
. - For
Variable Value
, inputC:\Ant\apache-ant-1.9.0
(or your Ant directory\apache-ant-1.9.0). - Scroll down to
Path
, and double-click on it. - Append
;C:\Ant\apache-ant-1.9.0\bin
exactly as shown to the end (or your Ant directory\apache-ant-1.9.0\bin).
- Download and install Github [here] (http://windows.github.com/) (Windows) or [here] (http://mac.github.com/) (Mac OS X 10.7+). For Linux, you could download it as a .zip/tarball and unzip it.
- Create an account.
- Scroll to the top of this page, login at the top-right, and then click
Clone to Windows/Mac
near the top-left of the page. - You should see Github flash and
pahimar/Equivalent-Exchange-3
appear. (The local repository on Windows defaults toC:\Users\(username)\Documents\GitHub\Equivalent-Exchange-3
, you can change it if you want but then you have to find it again on Github).
- Create an empty directory for EE3 development. This directory is refernced as
mcdev
from now on. It can be where you cloned EE3, but it'll be a little messy.
Setup MCP (Tested on Linux and Windows)
- Download the latest version of MCP from [here] (http://mcp.ocean-labs.de/index.php/MCP_Releases), e.g. mcp751.zip. Install MCP dependencies as listed on the website if neccessary.
- Inside
mcdev
, create a directory namedmcp
and unzip the MCP .zip file into it.- To verify, check if a file named
CHANGELOG
exists insidemcp
.
- To verify, check if a file named
- Download the latest forge source for Minecraft 1.5.2 and unzip it into
mcp
. You need at least Forge 7.7.1.500 (Forge 7.8.0.684 if using 1.5.2), best way is to get it from [here] (http://files.minecraftforge.net/).- To verify, check if a application named
install.sh
exists.
- To verify, check if a application named
- Execute
install.sh
(Linux and Mac) orinstall.cmd
(Windows), both found inmcdev\mcp\forge
. On Linux you might have tochmod +x install.sh
before you can execute it. On some system configurations you need to executeinstall.sh
from within theforge
directory whereas on others it doesn't matter. Just check the output for error messages to find out what you need to do.
Setup EE3 (Some tested for Linux, tested fully for Windows)
- Inside
mcdev
, create a directory namedsource
. - Move/clone
Equivalent-Exchange-3
intosource
. - Right now, you should have a directory that looks something like:
mcdev
\-mcp
\-complicated mcp stuff (should have CHANGELOG).
\-forge
\-jars
\-source
\-Equivalent-Exchange-3
\-EE3's files (should have build.xml).
- Inside
Equivalent-Exchange-3
, create a new file calledbuild.properties
.- Open it up with any text editor, and type into it the following (fully customizable except for
dir.development
):dir.development=../../
dir.release=Releases
release.minecraft.version=1.5.2
release.mod.version=pre2
- Open it up with any text editor, and type into it the following (fully customizable except for
- Open up your OS's command line (Command Prompt in Windows, Terminal in Linux and Mac).
- Navigate to
mcdev\source\Equivalent-Exchange-3
by executingcd mcdev's location\source\Equivalent-Exchange-3
. - Execute
ant release
. This will generally take around 5-15 minutes, depending on your computer. If you've done everything right,BUILD SUCCESSFUL
is displayed after it finishes.- If you see
BUILD FAILED
, check the error output (it should be right aroundBUILD FAILED
), fix everything, and try again.
- If you see
- Go to
mcdev\source\Equivalent-Exchange-3\Releases\1.5.2\pre2
.- You should see a .jar named
ee3-universal-pre2.jar
.
- You should see a .jar named
- Copy the jar into your Minecraft mods folder, and play Minecraft!
Updating Your Repo (For Windows/Mac)
- Check to see if pahimar updated EE3 since you last compiled. If he did, follow these instructions.
- Open Github.
- Double-click on pahimar/Equivalent-Exchange-3.
- At the top, there is a button named
Sync
/Sync Branch
(orRefreshing...
if it's still checking). - Click
Sync
, and wait for it to finish. - Re-compile (or move it to
mcdev\source
then re-compile, depending on what you did.)
###Contributing
Submitting a PR
So you found a bug in pahimar's code? Think you can make it more efficient? Want to help in general? Great!
- IMPORTANT: PAHIMAR DOES NOT WANT ANY
build.xml
CHANGES, UNLESS it fixes up something broken (See [Pull Request #90] (https://github.com/pahimar/Equivalent-Exchange-3/pull/90)). - If you haven't already, create a Github account.
- Click the little branch/plus icon at the top-right of this page (below your username).
- Make the changes that you want to.
- Click
Pull Request
at the top-middle of the page (left of your fork's name, to the right ofWatch
andFork
). - Enter your PR's title, and create a detailed description telling pahimar what you changed.
- Click
Send pull request
, and you're done!
Creating an Issue
EE3 crashes every time? Have a suggestion? Found a bug? Create an issue now!
- Please, please don't make any frivolous issues! If it's a crash, try asking the people in IRC or MCF before creating an issue. If it's a bug/suggestion, make sure it hasn't been reported/suggested already. Thanks! 😄
- Go to [the issues page] (http://github.com/pahimar/Equivalent-Exchange-3/issues).
- Click
New Issue
right belowGraphs
. - Enter your Issue's title (something that summarizes your issue), and then create a detailed description ("Hey pahimar, could you add/change xxx?" or "Hey, found an exploit: stuff").
- Click
Submit new issue
, and you're done!