From 0d032277f5569fedc431978f26719e8c020920c1 Mon Sep 17 00:00:00 2001 From: Linnea Gräf Date: Wed, 17 Apr 2024 11:35:32 +0200 Subject: Add warning about use this template --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3f299e2..79b81ca 100644 --- a/README.md +++ b/README.md @@ -8,14 +8,10 @@ Check out https://moddev.nea.moe/ for a full tutorial on legacy modding. Alternatively, read here for a basic overview on how to use this repository. -To get started, clone this repository. -In `build.gradle.kts`, replace the values of `baseGroup` and `group` with your own names. -In `settings.gradle.kts` change `rootProject.name` to your desired mod id. +To get started, [Use this template](https://github.com/new?template_name=Forge1.8.9Template&template_owner=nea89o). -The `com.example` package needs to be renamed to match the value of `baseGroup`. - -If you don't want mixins (which allow for modifying vanilla code), then you can remove the references to mixins from -the `build.gradle.kts` at the lines specified with comments and the `com.example.mixin` package. +> [!WARNING] +> Do not Fork or Clone or Download ZIP this template. If you "use" this template a custom mod id will be generated. You can do that manually using the `make-my-own` script, if you are on linux. If not, just click the use this template button. If you want to use kotlin or make a 1.12 mod check the "Include all branches" and change the default branch in https://github.com/yourname/yourreponame/branches This project uses [DevAuth](https://github.com/DJtheRedstoner/DevAuth) per default, so you can log in using your real minecraft account. If you don't need that, you can remove it from the buildscript. @@ -31,6 +27,9 @@ To export your project, run the `gradle build` task, and give other people the file `build/libs/-.jar`. Ignore the jars in the `build/badjars` folder. Those are intermediary jars that are used by the build system but *do not work* in a normal forge installation. +If you don't want mixins (which allow for modifying vanilla code), then you can remove the references to mixins from +the `build.gradle.kts` at the lines specified with comments and the `com.example.mixin` package. + ### For those who have not an attention span [![Youtube Tutorial](https://i.ytimg.com/vi/nWzHlomdCgc/maxresdefault.jpg)](https://www.youtube.com/watch?v=nWzHlomdCgc) -- cgit