Skip to content

Commit 3e28db6

Browse files
committed
docs on mod dev environment migration
1 parent 921ee10 commit 3e28db6

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,28 @@ And many more to come! And of course, all of these features are toggleable via a
3232
Coming soon!
3333

3434
## How to Install (Existing Project)
35-
Coming soon!
35+
- Download the latest master as a zip file from [here](https://github.com/GregTechCEu/Buildscripts/archive/refs/heads/master.zip)
36+
- Rename your `build.gradle` file to `build.gradle.old`
37+
- Copy the [`build.gradle`](https://github.com/GregTechCEu/Buildscripts/blob/master/build.gradle), [`dependencies.gradle`](https://github.com/GregTechCEu/Buildscripts/blob/master/dependencies.gradle), and [`repositories.gradle`](https://github.com/GregTechCEu/Buildscripts/blob/master/repositories.gradle) files from this zip to your project
38+
- Copy the [`settings.gradle`](https://github.com/GregTechCEu/Buildscripts/blob/master/settings.gradle) file from this zip to your project and replace your current one
39+
- Copy all the options from the [`gradle.properties`](https://github.com/GregTechCEu/Buildscripts/blob/master/gradle.properties) file to your `gradle.properties` (or copy entirely if you did not have one). You can leave your existing options if you know you need them, otherwise they can likely be removed
40+
- Configure `gradle.properties` for your mod
41+
- Move the necessary `dependencies` and/or `repositories` from `build.gradle.old` to the respective files (`dependencies.gradle`, `repositories.gradle`)
42+
- NOTE that if you enable the `includeWellKnownRepositories` option in `gradle.properties`, this build script will automatically have the following Maven locations, meaning you don't need to add them yourself in `repositories.gradle`:
43+
1. Curse Maven
44+
2. Modrinth Maven
45+
3. BlameJared Maven
46+
4. CleanroomMC Maven
47+
- NOTE that if you enable the `includeCommonDevEnvMods` option in `gradle.properties`, this build script will automatically have the following Mods, meaning you don't need to add them yourself in `dependencies.gradle`:
48+
1. JEI
49+
2. The One Probe
50+
- Delete the `build.gradle.old` file
51+
52+
### Advanced
53+
- If your project was using Mixins, you may get a new mixin config file generated as `mixins.{modid}.json`, if yours was not named this way. Currently, you will have to move your Mixin config options to this newly generated file. If this behavior does not suit your needs, feel free to open an issue and start a discussion on different behavior
54+
- If your project was using environment variables for CI deployments, see the `gradle.properties` file's comments to view the environment variable names this script checks for
55+
- If you have any additional build script code that you need to be applied, create an `addon.gradle` file and put it there
56+
- If your project has no dependencies, you can safely delete the `repositories.gradle` and `dependencies.gradle` files, they are optional
3657

3758
## How to Use
3859
### Files

0 commit comments

Comments
 (0)