Anvilcraft/equivalent-exchange-3
2
1
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Updated README.md for 1.5.x

Browse source 
Tada!  Here it is!  :)
This commit is contained in:
Wliu 2013-04-11 18:03:26 -04:00
parent 75dfff2dba
commit f46acc8ab9
1 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,5 +1,5 @@
## Welcome to Equivalent Exchange 3!
**LATEST OFFICIAL VERSION**: [EE3 pre1f for Minecraft 1.4.6/1.4.7] (http://adf.ly/GjT3c)
**LATEST OFFICIAL VERSION**: [EE3 pre1g for 1.5.1] (http://adf.ly/Mj3ZL)
[Minecraft Forums page] (http://www.minecraftforum.net/topic/1540010-equivalent-exchange-3)
@ -12,35 +12,34 @@ IMPORTANT: This is not guaranteed to work as it has not been tested extensively
***
#### Prerequisites (Tested for Windows ONLY!)
1. **WARNING: Make sure you know EXACTLY what you're doing! It's not any of our faults if your OS crashes, becomes corrupted, etc.**
2. Download and install the Java JRE [here] (http://www.java.com/inc/BrowserRedirect1.jsp?locale=en) (necessary for Ant).
3. 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).
2. 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 on `Advanced System Settings` on the left-hand side.
* Click on `Environment Variables`.
* Under `System Variables`, click `New`.
* For `Variable Name`, input `JAVA_HOME`.
* For `Variable Value`, input something similar to `;C:\Program Files (x86)\Java\jdk1.7.0_11` exactly as shown to the end (or wherever your Java JDK installation is), and click `Ok`.
* For `Variable Value`, input something similar to `;C:\Program Files (x86)\Java\jdk1.7.0_15` exactly as shown to the end (or wherever your Java JDK installation is), and click `Ok`.
* Scroll down to a variable named `Path`, and double-click on it.
* Append `;C:\Program Files (x86)\Java\jdk1.7.0_11\bin` (or wherever your Java JDK installation is \bin), and click `Ok`.
4. Download Apache Ant [here] (http://ant.apache.org).
* Append `;C:\Program Files (x86)\Java\jdk1.7.0_15\bin` (or your Java JDK installation directory\bin), and click `Ok`.
3. Download Apache Ant [here] (http://ant.apache.org).
* Unzip the files anywhere you want, eg `C:\Program Files (x86)\Ant`.
* Again, go to `Environment Variables` just like you did for the Java JDK.
* Under `System Variables`, click `New`.
* For `Variable Name`, input `ANT_HOME`.
* For `Variable Value`, input `C:\Ant\apache-ant-1.8.4` (or your Ant directory \apache-ant-1.8.4).
* For `Variable Value`, input `C:\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.8.4\bin` exactly as shown to the end (or your Ant directory \apache-ant-1.8.4\bin).
5. Download and install Github [here] (http://windows.github.com/) (Windows) or [here] (http://mac.github.com/) (Mac OS X 10.7+). For Linux, I *guess* you could download it as a .zip/tarball and unzip it?
* Append `;C:\Ant\apache-ant-1.8.4\bin` exactly as shown to the end (or your Ant directory\apache-ant-1.9.0\bin).
4. 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 to `C:\Users\(username)\Documents\GitHub\Equivalent-Exchange-3`, you can change it if you want but then you have to find it again on Github).
6. 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.
5. 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)
1. Download the latest version of MCP from [here] (http://mcp.ocean-labs.de/index.php/MCP_Releases), e.g. mcp726.zip. Install MCP dependencies as listed on the website if neccessary.
1. Download the latest version of MCP from [here] (http://mcp.ocean-labs.de/index.php/MCP_Releases), e.g. mcp744.zip. Install MCP dependencies as listed on the website if neccessary.
2. Inside `mcdev`, create a directory named `mcp` and unzip the MCP .zip file into it.
* To verify, check if a file named `CHANGELOG` exists inside `mcp`.
3. Download the latest forge **source** for Minecraft 1.4.7 and unzip it into `mcp`. You need at least Forge 6.6.0.***, best way is to get it from [here] (http://files.minecraftforge.net/).
3. Download the latest forge **source** for Minecraft 1.5.1 and unzip it into `mcp`. You need at least Forge 7.7.1.500, best way is to get it from [here] (http://files.minecraftforge.net/).
* To verify, check if a application named `install.sh` exists.
4. Execute `install.sh` (Linux and Mac) or `install.cmd` (Windows), both found in `mcdev\mcp\forge`. On Linux you might have to `chmod +x install.sh` before you can execute it. On some system configurations you need to execute `install.sh` from within the `forge` directory whereas on others it doesn't matter. Just check the output for error messages to find out what you need to do.
@ -65,13 +64,13 @@ IMPORTANT: This is not guaranteed to work as it has not been tested extensively
* 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.4.7` (as of 1/31)
* `release.minecraft.version=1.5.1`
* `release.mod.version=pre2`
5. [FOR WINDOWS] Open up `cmd` by typing `cmd` in Run.
6. [FOR WINDOWS] Navigate to `mcdev\source\Equivalent-Exchange-3` by executing `cd mcdev's location\source\Equivalent-Exchange-3`.
5. Open up your OS's command line (Command Prompt in Windows, Terminal in Linux and Mac).
6. Navigate to `mcdev\source\Equivalent-Exchange-3` by executing `cd mcdev's location\source\Equivalent-Exchange-3`.
7. 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 around `BUILD FAILED`), fix everything, and try again.
8. Go to `mcdev\source\Equivalent-Exchange-3\Releases\1.4.7\pre2`.
8. Go to `mcdev\source\Equivalent-Exchange-3\Releases\1.5\pre2`.
* You should see a .jar named `ee3-universal-pre2.jar`.
9. Copy the jar into your Minecraft mods folder, and play Minecraft!
@ -79,7 +78,7 @@ IMPORTANT: This is not guaranteed to work as it has not been tested extensively
1. Check to see if pahimar updated EE3 since you last compiled. If he did, follow these instructions.
2. Open Github.
3. Double-click on pahimar/Equivalent-Exchange-3.
4. At the top, there is a button named `Sync`/`Sync Branch` (Mac) (or `Refreshing...` if it's still checking).
4. At the top, there is a button named `Sync`/`Sync Branch` (or `Refreshing...` if it's still checking).
5. Click `Sync`, and wait for it to finish.
6. Re-compile (or move it to `mcdev\source` then re-compile, depending on what you did.)
@ -99,7 +98,8 @@ So you found a bug in pahimar's code? Think you can make it more efficient? Wa
#### Creating an Issue
EE3 crashes every time? Have a suggestion? Found a bug? Create an issue now!
1. Go to [the issues page] (http://github.com/pahimar/Equivalent-Exchange-3/issues).
2. Click `New Issue` right below `Graphs`.
3. 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").
4. Click `Submit new issue`, and you're done!
1. 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! :smile:
2. Go to [the issues page] (http://github.com/pahimar/Equivalent-Exchange-3/issues).
3. Click `New Issue` right below `Graphs`.
4. 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").
5. Click `Submit new issue`, and you're done!