upstream/Postea
1
0 Fork 0
mirror of https://github.com/GTNewHorizons/Postea.git synced 2026-11-12 16:37:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from TheElan/add-getting-started-readme-section

Browse Source 
add getting started section; move motivation to the top
This commit is contained in:
Johann Bernhardt authored and GitHub committed 2021-11-06 23:16:34 +01:00
2 parents c589d240a7 ab7b4a4c1d
commit 0bbd636bc6
1 file changed
+13 -4
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -4
View File
@@ -5,6 +5,19 @@
An example mod for Minecraft 1.7.10 with Forge focussed on a stable, updatable setup.
### Motivation
We had our fair share in struggles with build scripts for Minecraft Forge. There are quite a few pitfalls from non-obvious error messages. This Example Project provides you a build system you can adapt to over 90% of Minecraft Forge mods and can easily be updated if need be.
### Getting started
1. Fork this repository (you can keep the fork to simplify merging any build script updates in the future)
2. Clone repository
3. Replace placeholders (edit values in gradle.properties, change example package and class names, etc.)
4. Run `./gradlew setupDecompWorkspace` (if build fails with `Could not find :forgeBin:1.7.10-10.13.4.1614-1.7.10.` this should fix it)
5. Make sure to checkout the rest sections of this file.
6. You are good to go!
### Features
- Updatable: Replace [`build.gradle`](https://github.com/SinTh0r4s/ExampleMod1.7.10/blob/main/build.gradle) with a newer version
@@ -19,10 +32,6 @@ An example mod for Minecraft 1.7.10 with Forge focussed on a stable, updatable s
- GitHub CI
- [Jitpack](https://jitpack.io) CI
### Motivation
We had our fair share in struggles with build scripts for Minecraft Forge. There are quite a few pitfalls from non-obvious error messages. This Example Project provides you a build system you can adapt to over 90% of Minecraft Forge mods and can easily be updated if need be.
### Files
- [`build.gradle`](https://github.com/SinTh0r4s/ExampleMod1.7.10/blob/main/build.gradle): This is the core script of the build process. You should not need to tamper with it, unless you are trying to accomplish something out of the ordinary. __Do not touch this file! You will make a future update near impossible if you do so!__
- [`gradle.properties`](https://github.com/SinTh0r4s/ExampleMod1.7.10/blob/main/gradle.properties): The core configuration file. It includes