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

Updating the README.md.

Browse source 
Extended linux descriptions, changed build instructions for 1.6.x compilations.
This commit is contained in:
lluixhi 2013-09-22 16:03:15 -07:00
parent 9b5584cf28
commit 83bee17534
1 changed files with 59 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

88
README.md
View file

@ -10,72 +10,96 @@
### Compiling Equivalent Exchange 3
IMPORTANT: Please report any issues you have, there might be some problems with the documentation!
***
#### Prerequisites
#### Prerequisites (Windows/Mac)
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 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 (If you have a 64bit OS, install the 64bit version) [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_25` 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\Java\jdk1.7.0_40` 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 `;%JAVA_HOME%\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`.
* Unzip the files anywhere you want, eg `C:\Program Files\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.9.0` (or your Ant directory\apache-ant-1.9.0).
* For `Variable Value`, input `C:\Ant\apache-ant-1.9.2` (or your Ant directory\apache-ant-1.9.2).
* Scroll down to `Path`, and double-click on it.
* Append `;%ANT_HOME%\bin` exactly as shown to the end.
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 can use a different Git application. NOTE: Github For Windows/Mac is OPTIONAL. You can use your own Git application.
4. Download and install Github [here](http://windows.github.com/) (Windows) For Mac OSX (10.7+) [here](http://mac.github.com/) (Mac) NOTE: The Github application is optional, you can use whatever you want, e.g. TortoiseGit
* 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 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).
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.
5. Create an empty directory for EE3 development. This directory is referenced as `mcdev` from now on. It can be where you cloned EE3, but it'll be a little messy.
#### Linux prerequisites
1. Make sure you have the latest Java JDK installed
* In Gentoo, `emerge dev-java/oracle-jdk-bin`
* In Archlinux, `pacman -S jdk7-openjdk`
* In Ubuntu, `apt-get install openjdk7-jdk`
* In Debian, `apt-get install openjdk-7-jdk`
* In Fedora, `yum install java-1.7.0-openjdk`
* etc.
2. Install Apache Ant
* In Gentoo, `emerge dev-java/ant`
* In Archlinux, `pacman -S apache-ant`
* In Ubuntu/Debian, `apt-get install ant`
* In Fedora, `yum install ant`
* etc.
3. Install Git
* In Gentoo, `emerge dev-vcs/git`
* In Archlinux, `pacman -S git`
* In Ubuntu/Debian, `apt-get install git`
* In Fedora, `yum install git`
* etc.
4. Open your shell and move to a convenient directory, then run `git clone https://github.com/pahimar/Equivalent-Exchange-3`. This will download the repository.
5. Create an empty directory for EE3 development. This directory is referenced as `mcdev` from now on. It can be where you cloned EE3, but it'll be a little messy.
#### Setup MCP
1. Download the latest version of MCP from [here] (http://mcp.ocean-labs.de/download.php?list.2), e.g. mcp751.zip.
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.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.
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.
1. Download the latest version of Forge source from here: http://files.minecraftforge.net
2. Inside `mcdev`, unzip the forge source zip
* You should get a folder named "forge" inside "mcdev" containing the forge patches, and licenses.
4. Execute `install.sh` (Linux and Mac) or `install.cmd` (Windows), both found in `mcdev\forge`. On Linux you might have to `chmod +x install.sh` before you can execute it.
* This will take some time, be patient.
#### Setup EE3
1. Inside `mcdev`, create a directory named `source`.
2. Move/clone `Equivalent-Exchange-3` into `source`.
* **WARNING: Use `77c1560c24083d9a6dfe864158eeee70b55088a0` or it will not work!** (Later versions are for 1.6.2)
3. Right now, you should have a directory that looks something like:
***
mcdev
\-mcp
\-complicated mcp stuff (should have CHANGELOG).
\-forge
\-jars
\-forge
\-mcp
\-jars
\-install.cmd
\-install.sh
\-source
\-Equivalent-Exchange-3
\-EE3's files (should have build.xml).
***
4. Inside `Equivalent-Exchange-3`, create a new file called `build.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`
4. Inside `Equivalent-Exchange-3`, create a new file called `environment.properties`.
* Open it up with any text editor, and type into it the following (change the base_location to wherever you have "mcdev."):
* base_location=C:/mcdev/
* source_location=${base_location}/source/Equivalent-Exchange-3
* mcp_location=${base_location}/forge/mcp
* release_location=${base_location}/source/Equivalent-Exchange-3/Releases
* You may also edit the build.properties to show what build string and minecraft version you are building for.
* minecraft_version=1.6.3
* forge_version=9.11.0.878
* mod_version=pre2
* build_number=1
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 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 around `BUILD FAILED`), fix everything, and try again.
8. Go to `mcdev\source\Equivalent-Exchange-3\Releases\1.6.2\pre2`.
* If you see `BUILD FAILED`, check the error output (it should be right around `BUILD FAILED`), fix everything (if possible), and try again.
8. Go to `mcdev\source\Equivalent-Exchange-3\Releases\MC 1.6.3\pre2`.
* You should see a `.jar` file named `ee3-universal-pre2.jar`.
9. Copy the jar into your Minecraft mods folder, and play Minecraft!
9. Copy the jar into your Minecraft mods folder, and play Minecraft (If you have forge installed, of course).
#### Updating Your Repo (For Windows/Mac)
1. Check to see if pahimar updated EE3 since you last compiled. If he did, follow these instructions.
@ -85,6 +109,12 @@ IMPORTANT: Please report any issues you have, there might be some problems with
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.)
### Updating Your Repo (For Linux)
1. Check to see if pahimar updated EE3 since you last compiled. If he did, follow these instructions.
2. cd to your repository
3. run "git pull"
4. Re-compile (or move it to `mcdev\source` then re-compile, depending on what you did.)
###Contributing
***
#### Submitting a PR
@ -93,7 +123,7 @@ So you found a bug in pahimar's code? Think you can make it more efficient? Wa
1. **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)).
2. If you haven't already, create a Github account.
3. Click the `Fork` icon at the top-right of this page (below your username).
4. Make the changes that you want to.
4. Make the changes that you want to. (In Linux, you'll have to run `git push` after cloning your forked repository)
5. Click `Pull Request` at the right-hand side of the gray bar directly below your fork's name.
6. 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.
7. Click `Send pull request`, and you're done!