keith/ForgePatch
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Wiki Activity

Update README.txt

Browse source
This commit is contained in:
LexManos 2015-06-05 13:28:07 -07:00
parent d6bc936ffa
commit 26bc23602a
1 changed files with 31 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
fml/install/README.txt
View file

@ -14,21 +14,43 @@ Source pack installation information:
Standalone source installation Standalone source installation
============================== ==============================
To install this source code for development purposes, extract this zip file. Step 1: Open your command-line and browse to the folder where you extracted the zip file.
It ships with a demonstration mod. Run 'gradlew setupDevWorkspace' to create
a gradle environment primed with FML. Run 'gradlew eclipse' or 'gradlew idea' to Step 2: Once you have a command window up in the folder that the downloaded material was placed, type:
create an IDE workspace of your choice.
Refer to ForgeGradle for more information about the gradle environment Windows: "gradlew setupDecompWorkspace"
Note: On macs or linux you run the './gradlew.sh' instead of 'gradlew' Linux/Mac OS: "./gradlew setupDecompWorkspace"
Step 3: After all that finished, you're left with a choice.
For eclipse, run "gradlew eclipse" (./gradlew eclipse if you are on Mac/Linux)
If you preffer to use IntelliJ, steps are a little different.
1. Open IDEA, and import project.
2. Select your build.gradle file and have it import.
3. Once it's finished you must close IntelliJ and run the following command:
"gradlew genIntellijRuns" (./gradlew genIntellijRuns if you are on Mac/Linux)
Step 4: The final step is to open Eclipse and switch your workspace to /eclipse/ (if you use IDEA, it should automatically start on your project)
If at any point you are missing libraries in your IDE, or you've run into problems you can run "gradlew --refresh-dependencies" to refresh the local cache. "gradlew clean" to reset everything {this does not effect your code} and then start the processs again.
Should it still not work,
Refer to #ForgeGradle on EsperNet for more information about the gradle environment.
Tip:
If you do not care about seeing Minecraft's source code you can replace "setupDecompWorkspace" with one of the following:
"setupDevWorkspace": Will patch, deobfusicated, and gather required assets to run minecraft, but will not generated human readable source code.
"setupCIWorkspace": Same as Dev but will not download any assets. This is useful in build servers as it is the fastest because it does the least work.
Tip:
When using Decomp workspace, the Minecraft source code is NOT added to your workspace in a editable way. Minecraft is treated like a normal Library. Sources are there for documentation and research purposes and usually can be accessed under the 'referenced libraries' section of your IDE.
Forge source installation Forge source installation
========================= =========================
MinecraftForge ships with this code and installs it as part of the forge MinecraftForge ships with this code and installs it as part of the forge
installation process, no further action is required on your part. installation process, no further action is required on your part.
For reference this is version @MAJOR@.@MINOR@.@REV@.@BUILD@ of FML
for Minecraft version @MCVERSION@.
LexManos' Install Video LexManos' Install Video
======================= =======================
https://www.youtube.com/watch?v=8VEdtQLuLO0&feature=youtu.be https://www.youtube.com/watch?v=8VEdtQLuLO0&feature=youtu.be