Skip to content

Commit 1ae9b06

Browse files
committed
Update BUILDING.md
1 parent 525301f commit 1ae9b06

File tree

2 files changed

+25
-5
lines changed

2 files changed

+25
-5
lines changed

.idea/codeStyles/Project.xml

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

BUILDING.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ to be enabled)
2222

2323
The channels are all linked to Discord and some even to IRC.
2424

25-
## Setting Up
25+
## How to set up a local development environment
2626

2727
### git
2828

@@ -31,10 +31,27 @@ want to browse the source, you can clone the official repository. But it is best
3131
practice to actually fork the repository and clone your own copy.
3232

3333
The git command line is `git clone https://github.com/RS485/LogisticsPipes.git`
34-
where you can replace RS485 by your own user name, **if** you forked the
34+
where you can replace *RS485* by your own user name, **if** you forked the
3535
repository.
3636

37-
### Development environment
37+
### Gradle
3838

39-
[Here is a video](https://streamable.com/a2cjb) that shows how to set up your
40-
repository and development environment with the prerequisites above.
39+
After cloning you can build LP with `./gradlew build` and find the output in
40+
`build/libs`. If the task fails there may be something wrong with maven
41+
repositories or [a Java update broke ForgeGradle 2](https://github.com/MinecraftForge/ForgeGradle/issues/652)
42+
or something may be wrong with your setup. You may definitely ask for help on
43+
the mentioned communication channels above, but please be sure to state your
44+
issue as good as possible and be nice to others.
45+
46+
### Running Minecraft from your dev environment
47+
48+
After you successfully built LP you can probably run Minecraft directly from
49+
your IDE. There may be a ton of missing texture errors and missing language
50+
files though and this problem even happens when using a new clean mod template,
51+
but don't be sad! The solution is to copy your `build/resources/main/*` into
52+
`build/classes/java/main` before launching the game or you may link those two
53+
together:
54+
55+
```shell script
56+
$ rm -r build/resources/main && ln -s ../classes/java/main build/resources/main
57+
```

0 commit comments

Comments
 (0)