|
||
---|---|---|
common | ||
resources/assets/ee3 | ||
.classpath | ||
.gitignore | ||
.project | ||
build.xml | ||
build_number.properties | ||
COPYING | ||
COPYING.LESSER | ||
README.md | ||
version.xml |
Welcome to Equivalent Exchange 3!
LATEST OFFICIAL VERSION: EE3 pre1h for 1.5.1/1.5.2
Compiling EE3 - For those that want the latest unreleased features.
Contributing - For those that want to help out.
Compiling Equivalent Exchange 3
IMPORTANT: Please report any issues you have, there might be some problems with the documentation!
Prerequisites
- 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. 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_25
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
;%JAVA_HOME%\bin
, and clickOk
.
- Download Apache Ant here.
- 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
;%ANT_HOME%\bin
exactly as shown to the end.
- Download and install Github here (Windows) or here (Mac OS X 10.7+). For Linux, you can use a different Git application. NOTE: Github For Windows/Mac is OPTIONAL. You can use your own Git application.
- Create an account.
- Scroll to the top of this page, login at the top-right, and then click
Clone to Windows/Mac
at the bottom of the right-hand toolbar. - 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
- Download the latest version of MCP from [here] (http://mcp.ocean-labs.de/download.php?list.2), e.g. mcp751.zip.
- 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.1/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), the 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.- This will take some time, be patient.
Setup EE3
- Inside
mcdev
, create a directory namedsource
. - Move/clone
Equivalent-Exchange-3
intosource
.- WARNING: Use
77c1560c24083d9a6dfe864158eeee70b55088a0
or it will not work! (Later versions are for 1.6.2)
- WARNING: Use
- 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.mcp=../../mcp/
dir.mod=/
dir.release=Releases
release.minecraft.version=1.6.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 build
. 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.6.2\pre2
.- You should see a
.jar
file namedee3-universal-pre2.jar
.
- You should see a
- 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). - If you haven't already, create a Github account.
- Click the
Fork
icon at the top-right of this page (below your username). - Make the changes that you want to.
- Click
Pull Request
at the right-hand side of the gray bar directly below your fork's name. - Click
Click to create a pull request for this comparison
, 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.
- Click
New Issue
right belowStar
andFork
. - 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!