diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 7 insertions, 3 deletions
@@ -2,10 +2,14 @@ **For other templates, do check out the [other branches of this repository](https://github.com/romangraef/Forge1.8.9Template/branches/all)** -To get started, clone this repository and replace all references to `examplemod` or `com.example` with your own names. +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. + +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`, delete the `mixins.examplemod.json` and the `com.example.mixin` package. +the `build.gradle.kts` at the lines specified with comments and the `com.example.mixin` package. 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. @@ -15,7 +19,7 @@ from [here](https://adoptium.net/temurin/releases) (or use your own downloads). When you import your project into IntelliJ, you need to set the gradle jvm to the Java 17 JDK in the gradle tab, and the Project SDK to the Java 1.8 JDK. Then click on the sync button in IntelliJ, and it should create a run task -called `Minecraft Client`. If it doesn't then try relaunching your IntelliJ. **Warning for Mac users**: You might have to remove the `-XStartOnFirstThread` vm argument from your run configuration. In the future, that should be handled by the plugin, but for now you'll probably have to do that manually. +called `Minecraft Client`. If it doesn't then try relaunching your IntelliJ. **Warning for Mac users**: You might have to remove the `-XStartOnFirstThread` vm argument from your run configuration. In the future, that should be handled by the plugin, but for now you'll probably have to do that manually. To export your project, run the `gradle build` task, and give other people the file `build/libs/<modid>-<version>.jar`. Ignore the jars in the `build/badjars` folder. Those are intermediary jars that |