Browse Source

Replace the TODO on the README.md with basic building instructions

OvermindDL1 1 year ago
parent
commit
7cfcde124e
Signed by: OvermindDL1 <overminddl1@gmail.com> GPG Key ID: 3AB7DC53B6993840
1 changed files with 24 additions and 1 deletions
  1. 24
    1
      README.md

+ 24
- 1
README.md View File

@@ -15,4 +15,27 @@ You can use the Issue Tracker, or you can just use the [Forums](https://forum.me
15 15
 
16 16
 # Dev Environment Setup
17 17
 
18
-TODO: OvermindDL1 should replace this with proper instructions. ;)
18
+Once you have this project cloned then forge needs to be set up.  There are 2 options:
19
+
20
+* If you want to just compile GT6 as quick as possible, then start by running `./gradlew setupCIWorkspace`.  This tasks just builds enough of Minecraft and Forge to be able to build Forge Mods, but not to do any development.
21
+* If you want to compile GT6 and want the full decompiled and deobfuscated source code in the development environment and want to be able to run MC from within the development environment then run `./gradlew setupDevWorkspace setupDecompWorkspace`.
22
+
23
+Once you have set up your environment then you can run the `assemble` task to build GT6 like:  `./gradlew assemble`
24
+
25
+If you want to run the client then you can run the `runClient` task:  `./gradlew runClient`
26
+
27
+Ditto with `runServer` for a server run.
28
+
29
+To edit the code in an IDE just open the gradle project in IntelliJ or other decent IDE.  Use the `assemble` gradle task to build or `runClient` or `runServer` tasks to be able to actively debug the running the game.
30
+
31
+On the commandline you can combine classes altogether, for example, to just build GT6 you can do this after a fresh clone:
32
+```sh
33
+./gradlew setupCIWorkspace assemble
34
+```
35
+And the file will be in `build/libs` as usual.
36
+
37
+Can fully get a full dev environment, build, and run the client all at once from a fresh clone with:
38
+```sh
39
+./gradlew setupDevWorkspace setupDecompWorkspace assemble runClient
40
+```
41
+

Loading…
Cancel
Save