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

Update README.md

Browse source 
Update forge version again, warning message not to make any build.xml PRs, updated for Win8.
This commit is contained in:
Wliu 2012-12-25 19:44:36 -05:00
parent 33ce484205
commit 071c0c3a69
1 changed files with 7 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -10,7 +10,7 @@ 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 7 ONLY!)
#### 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.
* Go to `Control Panel\System and Security\System`, and click on `Advanced System Settings` on the left-hand side.
@ -33,26 +33,21 @@ ________________________________________________________________________________
* 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).
4. 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. You are now ready to setup MCP!
#### Setup MCP (Linux and Windows 7 tested)
#### 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.
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.4.0, best way is to get it from [here] (http://files.minecraftforge.net/).
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/).
* 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.
#### Setup EE3 (Some tested for Linux, tested fully for Windows)
1. Inside `mcdev`, create a directory named `source`.
2. Move/clone `Equivalent-Exchange-3` into `source`.
3. Right now, you should have a directory that looks something like:
***
mcdev
@ -69,29 +64,22 @@ ________________________________________________________________________________
* `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/20)
* `release.mod.version=pre1d` (or whatever version # 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)
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\pre1d` (This might be different according to what you put in build.properties).
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).
9. Copy the jar into your Minecraft mods folder, and play Minecraft!
#### Update EE3 (For Windows/Mac)
1. Check to see if pahimar updated EE3 since you last compiled. If he/she 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).
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.)
###Contributing
@ -99,6 +87,7 @@ ________________________________________________________________________________
#### 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!
0. IMPORTANT: PAHIMAR DOES **NOT** WANT ANY `build.xml` CHANGES, UNLESS it fixes up something broken (See #90).
1. If you haven't already, create a Github account.
2. Click `Fork` at the top-right of this page (below your username)
3. Make the changes that you want to.