Installation/Source
Installing Minecraft Forge is a simple process. Follow these steps exactly, and you should be fine. You should also read all of the instructions before beginning, including the common errors and warnings.
Installation Process
You MUST have the JDK installed
If you do not, install Java SDK Standard Edition (short JDK). Then, add the paths to your JDK and JRE bin folders to the Environment Variable PATH.
Example for Windows users of what you have to add to the variable (entries are seperated by ";" ):
C:\Program Files\Java\jdk1.6.0_24\bin;C:\Program Files\Java\jre6\bin
You should also be able to use Java 7 (JDK 1.7), but doing so means that all users of your mod must also be using Java 7.
Installation
Download a fresh copy of the recommended 'src' build. You can also try the latest build, but it may be buggy.
When you extract the zip, it'll create a new directory 'forge' in the directory extracted to. DO NOT RENAME IT! You can do it later after the install.
For Linux users insure you have Astyle and Wine installed. This is required for the patches to apply correctly.
Your project folder should now include a "forge" directory containing all extracted files. If so, just run install.cmd (Windows) or install.sh (Mac/Linux). This will do quite a lot of tasks:
- Download most requirements (Minecraft, MCP(Mod Coder Pack), Java Libraries)
- Set up MCP
- Decompile Minecraft
If you have "Permission Denied" errors on Linux/Mac OS, run chmod +x install.sh in the forge directory.
The time it takes to decompile properly can vary on the hardware. Less than ten minutes is average, but there have been reports of decompilation taking over an hour. Why not get something to eat while this happens?
When the script is finished, Minecraft will be properly decompiled with Forge.
Common Errors and General Warnings
Snapshots
Forge includes a snapshot of the MCP mappings. The mappings may not be the most current, but you must use the provided mappings in order for the patch files to work together.
MCP Scripts
You do not need to run any of the MCP scripts to decompile Minecraft and install Forge. Forge's install.sh will do it for you.
KEEP the recompile and reobfuscate scripts! You will need them to distribute your mod.
Also, keep the update scripts around (the reasons are obvious).
If you see an error which looks like this
WindowsError: [Error 5] Access is denied: '<..>\\mcp72\\eclipse'
Try deleting the eclipse directory within your MCP directory, and then run the install script.
Please ensure that Eclipse is closed before installation.
6,000/7,000 Errors Upon Opening Eclipse
You might be using one of the revisions of Forge that borks up /mcp/eclipse. Move /forge/fml/eclipse to /mcp/eclipse or get the latest version of Forge and install that instead.
IDEs
Using an IDE
- Eclipse for Eclipse IDE users.
- NetBeans for NetBeans users.
- Forge Development in IntelliJ IDEA for IntelliJ IDEA users.
Forge Directory Structure
If it's not listed here, the you probably aren't going to need to care about the directory/file.
- /forge/
- Where all forge related files are found. The folder created during extraction. Contains all the readmes and
- /forge/install.sh or /forge/install.cmd
- The installation script for installing Forge.
- /forge/mcp/
- The location of the Minecraft Coder Pack tools.
- /forge/mcp/eclipse/
- The pre-built workspace for Eclipse IDE users.
- /forge/mcp/src/
- The location of your source files
- /forge/mcp/recompile.sh /forge/mcp/reobfuscate.sh (.bat for Windows)
- Scripts that get your mod from source code into a releaseable state.
- /forge/mcp/reobf/
- The location of your class files after running reobfuscate.sh (.bat for Windows)