From e25bc9f585b8aa4da71ae2e4f56a195ac971dfac Mon Sep 17 00:00:00 2001 From: Dmytro <13066272+TheElan@users.noreply.github.com> Date: Sat, 6 Nov 2021 22:37:33 +0200 Subject: [PATCH 1/3] add getting started section; move motivation to the top --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e565b6d..a8d11a5 100644 --- a/README.md +++ b/README.md @@ -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 (e.g. modid, author(s) name, etc.) +4. Run `./gradlew setupDecompWorkspace` +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 From 8c936e3756666637f0bb96d6f0633a787fdd8811 Mon Sep 17 00:00:00 2001 From: Dmytro <13066272+TheElan@users.noreply.github.com> Date: Sat, 6 Nov 2021 22:42:11 +0200 Subject: [PATCH 2/3] clarify why we need setupDecompWorkspace --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a8d11a5..e4f91cc 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ We had our fair share in struggles with build scripts for Minecraft Forge. There 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 (e.g. modid, author(s) name, etc.) -4. Run `./gradlew setupDecompWorkspace` +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! From ab7b4a4c1d781d34476bee0522e43d1a352d0a47 Mon Sep 17 00:00:00 2001 From: Dmytro <13066272+TheElan@users.noreply.github.com> Date: Sun, 7 Nov 2021 00:11:22 +0200 Subject: [PATCH 3/3] clarify placeholder examples --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e4f91cc..809f2f6 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ We had our fair share in struggles with build scripts for Minecraft Forge. There 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 (e.g. modid, author(s) name, etc.) +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!