diff --git a/README.md b/README.md index 94aa7473..eac4be27 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ## Welcome to Equivalent Exchange 3! -Setup MCP was done mostly by the people who update How to Compile for Beginners on the wiki, I just updated/changed it a bit. Some credit goes to BuildCraft's README.md, which I based this README off of. +**LATEST OFFICIAL VERSION**: EE3 pre1f for MC 1.4.7(pre). -The Minecraft Forums page can be found [here] (http://www.minecraftforum.net/topic/1540010-equivalent-exchange-3). +[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) @@ -9,10 +9,10 @@ The Minecraft Forums page can be found [here] (http://www.minecraftforum.net/top ### 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!) 0. WARNING: Make sure you know EXACTLY what you're doing! It's not any of our faults if your OS crashes, becomes corrupted, etc. -1. 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. +1. 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. * 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`. @@ -37,12 +37,12 @@ ________________________________________________________________________________ #### 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. mcp725.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. mcp726.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.6 and unzip it into `mcp`. You need at least Forge 6.5.0.470, best way is to get it from [here] (http://files.minecraftforge.net/). +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/). * 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. +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. #### Setup EE3 (Some tested for Linux, tested fully for Windows) 1. Inside `mcdev`, create a directory named `source`. @@ -62,18 +62,18 @@ ________________________________________________________________________________ *** 4. Inside `Equivalent-Exchange-3`, create a new file called `build.properties`. - * Open it up, and type into it the following: + * Open it up with any text editor, and type into it the following (fully customizable except for `dir.development`): * `dir.development=../../` * `dir.share=Shared` (or what you want it to be-optional) * `dir.release=Releases` (what you want it to be) - * `release.minecraft.version=1.4.6` (as of 12/25) - * `release.mod.version=pre1e` (or whatever version # want it to be) + * `release.minecraft.version=1.4.7` (as of 1/04) + * `release.mod.version=your version number here` 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`. 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.6\pre1e` (This might be different according to what you put in build.properties). - * You should see a .jar named `ee3-universal-pre1d.jar` (Again, might be different). +8. Go to `mcdev\source\Equivalent-Exchange-3\Releases\1.4.7\[version number]` (This might be different according to what you put in build.properties). + * You should see a .jar named `ee3-universal-[version number]jar`. 9. Copy the jar into your Minecraft mods folder, and play Minecraft! #### Update EE3 (For Windows/Mac) @@ -85,7 +85,7 @@ ________________________________________________________________________________ 6. 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!