-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
62 changed files
with
4,919 additions
and
457 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # NeoForge Development Gradle Plugin | ||
|
|
||
| ## NeoForge Project Structure | ||
|
|
||
| Before understanding the `buildSrc` plugin, one should understand the structure of the NeoForge Gradle project it is | ||
| applied to. | ||
|
|
||
| The project consists of a project tree with the following structure: | ||
|
|
||
| | Folder Path | Gradle Project Path | Applied Plugins | Description | | ||
| |------------------------------------------------------------------------|----------------------|:------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | [`/build.gradle`](../build.gradle) | `:` | — | The root project. Since this project is reused for Kits, the root project name is based on the checkout folder, which actually can lead to issues if it is called `NeoForge`. | | ||
| | [`/projects/neoforge/build.gradle`](../projects/neoforge/build.gradle) | `:neoforge` | [NeoDevPlugin](#neodevplugin) | The core NeoForge project, which produces the artifacts that will be published. | | ||
| | [`/projects/base/build.gradle`](../projects/base/build.gradle) | `:base` | [NeoDevBasePlugin](#neodevbaseplugin) | A utility project that contains the Minecraft sources without any NeoForge additions. Can be used to quickly compare what NeoForge has changed. | | ||
| | [`/tests/build.gradle`](../tests/build.gradle) | `:tests` | [NeoDevExtraPlugin](#neodevextraplugin) | Contains the game and unit tests for NeoForge. | | ||
| | [`/testframework/build.gradle`](../testframework/build.gradle) | `:testframework` | [MinecraftDependenciesPlugin](#minecraftdependenciesplugin) | A library providing support classes around writing game tests. | | ||
| | [`/coremods/build.gradle`](../coremods/build.gradle) | `:neoforge-coremods` | — | Java Bytecode transformers that are embedded into NeoForge as a nested Jar file. | | ||
| | | ||
|
|
||
| ## Plugins | ||
|
|
||
| ### NeoDevBasePlugin | ||
|
|
||
| Sources: [NeoDevBasePlugin.java](src/main/java/net/neoforged/neodev/NeoDevBasePlugin.java) | ||
|
|
||
| Implicitly applies: [MinecraftDependenciesPlugin](#minecraftdependenciesplugin). | ||
|
|
||
| Sets up a `setup` task that reuses code from [NeoDevPlugin](#neodevplugin) to decompile Minecraft and place the | ||
| decompiled sources in `projects/base/src/main/java`. | ||
|
|
||
| ### NeoDevPlugin | ||
|
|
||
| Sources: [NeoDevPlugin.java](src/main/java/net/neoforged/neodev/NeoDevPlugin.java) | ||
|
|
||
| Implicitly applies: [MinecraftDependenciesPlugin](#minecraftdependenciesplugin). | ||
|
|
||
| This is the primary of this repository and is used to configure the `neoforge` subproject. | ||
|
|
||
| #### Setup | ||
|
|
||
| It creates a `setup` task that performs the following actions via various subtasks: | ||
|
|
||
| - Decompile Minecraft using the [NeoForm Runtime](https://github.com/neoforged/neoformruntime) and Minecraft version specific [NeoForm data](https://github.com/neoforged/NeoForm). | ||
| - Applies [Access Transformers](../src/main/resources/META-INF/accesstransformer.cfg) to Minecraft sources. | ||
| - Applies [NeoForge patches](../patches) to Minecraft sources. Any rejects are saved to the `/rejects` folder in the repository for manual inspection. During updates to new versions, the task can be run with `-Pupdating=true` to apply patches more leniently. | ||
| - Unpacks the patched sources to `projects/neoforge/src/main/java`. | ||
|
|
||
| #### Config Generation | ||
|
|
||
| The plugin creates and configures the tasks to create various configuration files used downstream to develop | ||
| mods with this version of NeoForge ([CreateUserDevConfig](src/main/java/net/neoforged/neodev/CreateUserDevConfig.java)), or install it ([CreateInstallerProfile](src/main/java/net/neoforged/neodev/installer/CreateInstallerProfile.java) and [CreateLauncherProfile](src/main/java/net/neoforged/neodev/installer/CreateLauncherProfile.java)). | ||
|
|
||
| A separate userdev profile is created for use by other subprojects in this repository. | ||
| The only difference is that it uses the FML launch types ending in `dev` rather than `userdev`. | ||
|
|
||
| #### Patch Generation | ||
|
|
||
| NeoForge injects its hooks into Minecraft by patching the decompiled source code. | ||
| Changes are made locally to the decompiled and patched source. | ||
| Since that source cannot be published, patches need to be generated before checking in. | ||
| The plugin configures the necessary task to do this | ||
| ([GenerateSourcePatches](src/main/java/net/neoforged/neodev/GenerateSourcePatches.java)). | ||
|
|
||
| The source patches are only used during development of NeoForge itself and development of mods that use Gradle plugins implementing the decompile/patch/recompile pipeline. | ||
| For use by the installer intended for players as well as Gradle plugins wanting to replicate the production artifacts more closely, binary patches are generated using the ([GenerateBinaryPatches](src/main/java/net/neoforged/neodev/GenerateBinaryPatches.java)) task. | ||
|
|
||
| ### NeoDevExtraPlugin | ||
|
|
||
| Sources: [NeoDevExtraPlugin.java](src/main/java/net/neoforged/neodev/NeoDevExtraPlugin.java) | ||
|
|
||
| This plugin can be applied to obtain a dependency on the `neoforge` project to depend on NeoForge including Minecraft | ||
| itself. Besides wiring up the dependency, it also creates run configurations based on the run-types defined in the | ||
| `neoforge` project. | ||
|
|
||
| ### MinecraftDependenciesPlugin | ||
|
|
||
| This plugin is reused from [ModDevGradle](https://github.com/neoforged/ModDevGradle/). | ||
|
|
||
| It sets up repositories and attributes such that | ||
| the [libraries that Minecraft itself depends upon](https://github.com/neoforged/GradleMinecraftDependencies) can be | ||
| used. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,28 @@ | ||
| plugins { | ||
| id 'java-gradle-plugin' | ||
| id 'groovy-gradle-plugin' | ||
| } | ||
|
|
||
| repositories { | ||
| gradlePluginPortal() | ||
| mavenCentral() | ||
| maven { | ||
| name = "NeoForged" | ||
| url = "https://maven.neoforged.net/releases" | ||
| content { | ||
| includeGroup "codechicken" | ||
| includeGroup "net.neoforged" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| dependencies { | ||
| // buildSrc is an includedbuild of the parent directory (gradle.parent) | ||
| // ../settings.gradle sets these version properties accordingly | ||
| implementation "net.neoforged:moddev-gradle:${gradle.parent.ext.moddevgradle_plugin_version}" | ||
|
|
||
| implementation "com.google.code.gson:gson:${gradle.parent.ext.gson_version}" | ||
| implementation "io.codechicken:DiffPatch:${gradle.parent.ext.diffpatch_version}" | ||
|
|
||
| implementation "org.ow2.asm:asm:${gradle.parent.ext.asm_version}" | ||
| } |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| project.plugins.apply('net.neoforged.gradleutils') | ||
|
|
||
| project.gradleutils.version { | ||
| minecraftVersion project.rootProject.minecraft_version | ||
| versionPrefix = null // Reset version prefix, which is set by prev. line | ||
| tags { | ||
| label = 'beta' | ||
| cleanMarkerLabel = 'stable' | ||
| } | ||
| branches { | ||
| suffixBranch = true | ||
| } | ||
| } |
85 changes: 85 additions & 0 deletions
85
buildSrc/src/main/java/net/neoforged/neodev/ApplyAccessTransformer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| package net.neoforged.neodev; | ||
|
|
||
| import net.neoforged.neodev.utils.FileUtils; | ||
| import org.gradle.api.file.ConfigurableFileCollection; | ||
| import org.gradle.api.file.RegularFileProperty; | ||
| import org.gradle.api.provider.Property; | ||
| import org.gradle.api.tasks.Classpath; | ||
| import org.gradle.api.tasks.Input; | ||
| import org.gradle.api.tasks.InputFile; | ||
| import org.gradle.api.tasks.InputFiles; | ||
| import org.gradle.api.tasks.Internal; | ||
| import org.gradle.api.tasks.JavaExec; | ||
| import org.gradle.api.tasks.OutputFile; | ||
| import org.gradle.api.tasks.TaskAction; | ||
|
|
||
| import javax.inject.Inject; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.io.UncheckedIOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
|
|
||
| /** | ||
| * Runs <a href="https://github.com/neoforged/JavaSourceTransformer">JavaSourceTransformer</a> to apply | ||
| * access transformers to the Minecraft source code for extending the access level of existing classes/methods/etc. | ||
| * <p> | ||
| * Note that at runtime, FML also applies access transformers. | ||
| */ | ||
| abstract class ApplyAccessTransformer extends JavaExec { | ||
| @InputFile | ||
| public abstract RegularFileProperty getInputJar(); | ||
|
|
||
| @InputFiles | ||
| public abstract ConfigurableFileCollection getAccessTransformers(); | ||
|
|
||
| @Input | ||
| public abstract Property<Boolean> getValidate(); | ||
|
|
||
| @OutputFile | ||
| public abstract RegularFileProperty getOutputJar(); | ||
|
|
||
| // Used to give JST more information about the classes. | ||
| @Classpath | ||
| public abstract ConfigurableFileCollection getLibraries(); | ||
|
|
||
| @Internal | ||
| public abstract RegularFileProperty getLibrariesFile(); | ||
|
|
||
| @Inject | ||
| public ApplyAccessTransformer() {} | ||
|
|
||
| @Override | ||
| @TaskAction | ||
| public void exec() { | ||
| try { | ||
| FileUtils.writeLinesSafe( | ||
| getLibrariesFile().getAsFile().get().toPath(), | ||
| getLibraries().getFiles().stream().map(File::getAbsolutePath).toList(), | ||
| StandardCharsets.UTF_8); | ||
| } catch (IOException exception) { | ||
| throw new UncheckedIOException("Failed to write libraries for JST.", exception); | ||
| } | ||
|
|
||
| var args = new ArrayList<>(Arrays.asList( | ||
| "--enable-accesstransformers", | ||
| "--access-transformer-validation", getValidate().get() ? "error" : "log", | ||
| "--libraries-list", getLibrariesFile().getAsFile().get().getAbsolutePath() | ||
| )); | ||
|
|
||
| for (var file : getAccessTransformers().getFiles()) { | ||
| args.addAll(Arrays.asList( | ||
| "--access-transformer", file.getAbsolutePath() | ||
| )); | ||
| } | ||
|
|
||
| args.addAll(Arrays.asList( | ||
| getInputJar().getAsFile().get().getAbsolutePath(), | ||
| getOutputJar().getAsFile().get().getAbsolutePath())); | ||
|
|
||
| args(args); | ||
|
|
||
| super.exec(); | ||
| } | ||
| } |
Oops, something went wrong.