From 2e261f72f94b0a28c4adca4752c7ff2c8e985731 Mon Sep 17 00:00:00 2001 From: cech12 Date: Wed, 3 Jan 2024 20:29:10 +0100 Subject: [PATCH] add new build.gradle adjustments to readme --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4774288..f2a1120 100644 --- a/README.md +++ b/README.md @@ -33,21 +33,22 @@ Add the following to your `build.gradle` file: ```groovy repositories { - maven { url 'https://jitpack.io' } + maven { + name 'Jitpack' + url 'https://jitpack.io' + } } dependencies { - compileOnly fg.deobf("com.github.cech12:BucketLib:${project.bucketlib_version}:api") - runtimeOnly fg.deobf("com.github.cech12:BucketLib:${project.bucketlib_version}") + implementation fg.deobf("com.github.cech12:BucketLib:${loader}:${bucketlib_version}") } ``` -Replace `${project.bucketlib_version}` with the version of BucketLib that you want to use. The actual versions can be found [here](https://jitpack.io/api/builds/com.github.cech12/BucketLib) or on the Github Releases page. +Replace `${loader}` with the loader (`forge` or `neoforge`) you want to use. -### Since BucketLib 1.19.3-1.2.0.0 - -BucketLib 1.19.3-1.2.0.0 added mixins and developers will need to make sure to tweak their run configurations in order to launch the game in their development environment if using this version or newer as a dependency. +Replace `${bucketlib_version}` with the version of BucketLib that you want to use. The actual versions can be found [here](https://jitpack.io/api/builds/com.github.cech12/BucketLib) or on the Github Releases page. +BucketLib adds mixins and developers need to make sure to tweak their run configurations in order to launch the game in their development environment. Add both of these lines to the `configureEach {}` run configuration block in the `build.gradle` (or to both the `client {}` and `server {}`). These can be placed anywhere within the run configuration, the order does not matter. ```groovy @@ -57,4 +58,6 @@ property 'mixin.env.refMapRemappingFile', "${buildDir}/createSrgToMcp/output.srg Don't forget to re-generate your IDE runs. (`genIntellijRuns`, `genEclipseRuns`, or `genVSCodeRuns`) +Before BucketLib ***1.20.2-3.0.0.0*** the `build.gradle` file adjustments were different. + For detailed information please see the [Developer Guide](https://github.com/cech12/BucketLib/wiki/Developer-Guide).