Forge 1.19

* Bump pack.mcmeta formats
* 1.19 biome modifiers
* Mark ClientPlayerNetworkEvent.LoggedOutEvent's getters as nullable
* Add docs and package-info to client extension interfaces package
* Move RenderBlockOverlayEvent hooks to ForgeHooksClient
* Add package-infos to client events package
* Rename SoundLoadEvent to SoundEngineLoadEvent

This reduces confusion from consumers which may think the
name SoundLoadEvent refers to an individual sound being loaded rather
than the sound engine.
* Document and change SoundLoadEvent to fire on mod bus

Previously, it fired on both the mod bus and the Forge bus, which is
confusing for consumers.
* Delete SoundSetupEvent

Looking at its original implementation shows that there isn't an
appropriate place in the new sound code to reinsert the event, and the
place of 'sound engine/manager initialization event' is taken already by SoundLoadEvent.
* Perform some cleanup on client events

 - Removed nullable annotations from ClientPlayerNetworkEvent
 - Renamed #getPartialTicks methods to #getPartialTick, to be consistent
  with vanilla's naming of the partial tick
 - Cleanup documentation to remove line breaks, use the
  spelling 'cancelled' over
  'canceled', and improve docs on existing and
   new methods.
* Remove EntityEvent.CanUpdate

Closes MinecraftForge#6394
* Switch to Jetbrains nullability annotations
* New PlayLevelSoundEvent; replaces old PlaySoundAtEntityEvent
* Remove ForgeWorldPresetScreens
* Remove IForgeRegistryEntry
* Remove use of List<Throwable> in FML's CompletableFutures
* Add docs to mod loading stages, stages, and phases
* Gradle 7.4.2
* Use SLF4J in FMLLoader and other subprojects
* Switch dynamic versions in subprojects to pinned ones
* Switch ForgeRoot and MDK to FG plugin markers
* Configure Forge javadoc task

The task now uses a custom stylesheet with MCForge elements, and
configured to combine the generation from the four FML subprojects
(fmlloader, fmlcore, javafmllanguage, mclanguage) and the Forge project
into the javadoc output.
* Update docs/md files, for 1.19 update and the move away from IRC to Discord.
* Make "Potentially dangerous alternative prefix" a debug warning, not info.

Co-authored-by: Curle <[email protected]>
Co-authored-by: sciwhiz12 <[email protected]>
Signed-off-by: SizableShrimp <[email protected]>

.gitignore

@@ -33,6 +33,7 @@
 /projects/**/*.launch
 /repo/
 src/generated/resources/.cache/
+src/generated_test/resources/.cache/
 
 #Patch rejects
 /patches-/

build.gradle

@@ -1,14 +1,3 @@
-buildscript {
-    repositories {
-        mavenLocal()
-        maven { url = 'https://maven.minecraftforge.net/' }
-        mavenCentral()
-    }
-    dependencies {
-        classpath 'net.minecraftforge.gradle:ForgeGradle:[5.1.39,)'
-    }
-}
-
 import groovy.json.JsonBuilder
 
 import java.nio.file.Files
@@ -31,6 +20,8 @@ plugins {
     id 'net.minecraftforge.gradleutils' version '2.+'
     id 'eclipse'
     id 'de.undercouch.download' version '4.1.2'
+    id 'net.minecraftforge.gradle.patcher' version '[5.1.39,)' apply false
+    id 'net.minecraftforge.gradle.mcp' version '[5.1.39,)' apply false
 }
 
 Util.init() //Init all our extension methods!
@@ -45,32 +36,46 @@ ext {
         ]
     }
     MAPPING_CHANNEL = 'official'
-    MAPPING_VERSION = '1.18.2'
-    MC_VERSION = '1.18.2'
-    MCP_VERSION = '20220404.173914'
+    MAPPING_VERSION = '1.19'
+    MC_VERSION = '1.19'
+    MCP_VERSION = '20220607.102129'
     SPI_VERSION = '4.0.10'
     ACCESSTRANSFORMERS_VERSION = '8.0.4'
     COREMODS_VERSION = '5.0.1'
     EVENTBUS_VERSION = '5.0.3'
     MODLAUNCHER_VERSION = '9.1.3'
     SECUREJARHANDLER_VERSION = '1.0.3'
     BOOTSTRAPLAUNCHER_VERSION = '1.0.0'
-    ASM_VERSION = '9.2'
+    ASM_VERSION = '9.3'
     INSTALLER_VERSION = '2.1.+'
     MIXIN_VERSION = '0.8.5'
+    TERMINALCONSOLEAPPENDER_VERSION = '1.2.0'
+    JLINE_VERSION = '3.12.+'
+    NIGHTCONFIG_VERSION = '3.6.4'
+    JETBRAINS_ANNOTATIONS_VERSION = '23.0.0'
+    SLF4J_API_VERSION = '1.8.0-beta4'
+    APACHE_MAVEN_ARTIFACT_VERSION = '3.8.5'
+
+    // These versions should be kept in sync with the version manifest JSON
+    // To use a version newer than the version manifest JSON, the dependency must be added to the installer configuration
+    MOJANG_LOGGING_VERSION = '1.0.0'
+    LOG4J_VERSION = '2.17.0'
+    GUAVA_VERSION = '31.0.1-jre'
+    GSON_VERSION = '2.8.9'
+    APACHE_COMMONS_LANG3_VERSION = '3.12.0'
+    JOPT_SIMPLE_VERSION = '5.0.4'
+    COMMONS_IO_VERSION = '2.11.0'
 
     GIT_INFO = gradleutils.gitInfo
     VERSION = gradleutils.getFilteredMCTagOffsetBranchVersion(true, '[0-9]', MC_VERSION)
     // FML_VERSION = gradleutils.getFilteredMCTagOffsetBranchVersion(true, 'FML', MC_VERSION)
     FORGE_VERSION = VERSION.substring(MC_VERSION.length() + 1)
 
-    SPECIAL_SOURCE = 'net.md-5:SpecialSource:1.10.0'
-    BINPATCH_TOOL = 'net.minecraftforge:binarypatcher:1.0.12:fatjar'
+    BINPATCH_TOOL = 'net.minecraftforge:binarypatcher:1.1.1:fatjar'
     INSTALLER_TOOLS = 'net.minecraftforge:installertools:1.3.0'
     JAR_SPLITTER = 'net.minecraftforge:jarsplitter:1.1.4'
     FART = 'net.minecraftforge:ForgeAutoRenamingTool:0.1.22:all'
     MIN_TAG_FOR_CHANGELOG = "39.0"
-    LAST_RB = GIT_INFO.tag.rsplit('.', 1)[1] as int >= 1 ? GIT_INFO.tag + '.0' : null
 }
 
 println('Version: ' + VERSION +
@@ -138,6 +143,10 @@ subprojects {
             name = 'forge'
             url = 'https://maven.minecraftforge.net/'
         }
+        maven {
+            name = 'minecraft'
+            url = 'https://libraries.minecraft.net/'
+        }
     }
 
     java.toolchain.languageVersion = JavaLanguageVersion.of(17)
@@ -259,19 +268,19 @@ def sharedDeps = {
     installer "org.ow2.asm:asm-util:${ASM_VERSION}"
     installer "org.ow2.asm:asm-analysis:${ASM_VERSION}"
     installer "net.minecraftforge:accesstransformers:${ACCESSTRANSFORMERS_VERSION}"
-    installer 'org.antlr:antlr4-runtime:4.9.1' //Dep of AccessTransformer
+    installer 'org.antlr:antlr4-runtime:4.9.1' // Dep of AccessTransformer
     installer "net.minecraftforge:eventbus:${EVENTBUS_VERSION}"
     installer "net.minecraftforge:forgespi:${SPI_VERSION}"
     installer "net.minecraftforge:coremods:${COREMODS_VERSION}"
     installer "cpw.mods:modlauncher:${MODLAUNCHER_VERSION}"
     installer 'net.minecraftforge:unsafe:0.2.+'
-    installer 'com.electronwill.night-config:core:3.6.4'
-    installer 'com.electronwill.night-config:toml:3.6.4'
-    installer 'org.apache.maven:maven-artifact:3.6.3'
+    installer "com.electronwill.night-config:core:${NIGHTCONFIG_VERSION}"
+    installer "com.electronwill.night-config:toml:${NIGHTCONFIG_VERSION}"
+    installer "org.apache.maven:maven-artifact:${APACHE_MAVEN_ARTIFACT_VERSION}"
     installer 'net.jodah:typetools:0.8.3'
-    installer 'net.minecrell:terminalconsoleappender:1.2.0'
-    installer 'org.jline:jline-reader:3.12.+'   //Dep of TerminaalConsoleeAppender
-    installer 'org.jline:jline-terminal:3.12.+' //Dep of TerminaalConsoleeAppender
+    installer "net.minecrell:terminalconsoleappender:${TERMINALCONSOLEAPPENDER_VERSION}"
+    installer "org.jline:jline-reader:${JLINE_VERSION}"   // Dep of TerminalConsoleAppender
+    installer "org.jline:jline-terminal:${JLINE_VERSION}" // Dep of TerminalConsoleAppender
     installer "org.spongepowered:mixin:${MIXIN_VERSION}"
     installer 'org.openjdk.nashorn:nashorn-core:15.3'
 
@@ -1049,6 +1058,7 @@ project(':forge') {
                             '--mod', 'tag_based_tool_types',
                             '--mod', 'custom_transformtype_test',
                             '--mod', 'data_pack_registries_test',
+                            '--mod', 'biome_modifiers_test',
                             '--output', rootProject.file('src/generated_test/resources/'),
                             '--existing', sourceSets.main.resources.srcDirs[0],
                             '--existing', sourceSets.test.resources.srcDirs[0]
@@ -1180,42 +1190,45 @@ project(':forge') {
         lineEnding = '\n'
     }
 
-    def baseForgeVersion = LAST_RB == null ? null : "${MC_VERSION}-${LAST_RB}"
+    def baseForgeVersion = System.getProperty("forge.compatibility_check_version")
+    if (baseForgeVersion == null)
+        baseForgeVersion = "${MC_VERSION}-${GIT_INFO.tag}.0"
+    if (baseForgeVersion == "null")
+        baseForgeVersion = null // Allow disabling from system property if not wanted
+    def baseForgeUniversal = null
+    if (baseForgeVersion != null)
+        baseForgeUniversal = project.dependencies.create("net.minecraftforge:forge:${baseForgeVersion}:universal")
+    def jarCompatibilityTaskSetup = { task ->
+        task.group = 'jar compatibility'
+        task.onlyIf {
+            baseForgeVersion != null
+        }
+        task.inputs.property 'baseForgeVersion', baseForgeVersion
+    }
 
     task downloadBaseCompatibilityBinPatches(type: DownloadBaseCompatibilityBinPatches) {
         inputVersion = baseForgeVersion
     }
 
     task applyBaseCompatibilityJarBinPatches(type: ApplyBinPatches) {
-        group = 'jar compatibility'
-        onlyIf {
-            baseForgeVersion != null
-        }
-        inputs.property 'baseForgeVersion', baseForgeVersion
+        jarCompatibilityTaskSetup(it)
 
         clean = createJoinedSRG.output
         patch = downloadBaseCompatibilityBinPatches.output
         output = project.layout.buildDirectory.dir(name).map { it.file('output.jar') }
     }
 
     task checkJarCompatibility(type: CheckJarCompatibility) {
-        group = 'jar compatibility'
-        onlyIf {
-            baseForgeVersion != null
-        }
-        inputs.property 'baseForgeVersion', baseForgeVersion
+        jarCompatibilityTaskSetup(it)
 
         if (baseForgeVersion != null) {
-            def baseForgeUniversal = project.configurations.detachedConfiguration(project.dependencies.create("net.minecraftforge:forge:${baseForgeVersion}:universal"))
             def fmlLibs = project.configurations.detachedConfiguration(PACKED_DEPS.collect {
                 def artifactId = it.split(':')[1]
                 return project.dependencies.create("net.minecraftforge:${artifactId}:${baseForgeVersion}")
             }.toArray(Dependency[]::new))
 
             baseJar = project.tasks.applyBaseCompatibilityJarBinPatches.output
-            baseLibraries.from(project.file(project.provider {
-                baseForgeUniversal.resolve().iterator().next()
-            }))
+            baseLibraries.from(baseForgeUniversal)
             baseLibraries.from(project.tasks.createJoinedSRG.output)
             baseLibraries.from(fmlLibs)
 
@@ -1578,6 +1591,83 @@ project(':forge') {
         sourceSets.test.java.srcDirs.each { extractMappedNew.addTarget it }
     }
 
+    tasks.named('javadoc', Javadoc).configure {
+        description 'Generates the combined javadocs for the FML projects and the main Forge project'
+        var includedProjects = [ ':fmlcore', ':fmlloader', ':javafmllanguage', ':mclanguage' ]
+        source includedProjects.collect { project(it).sourceSets.main.allJava }
+        classpath = classpath + files(includedProjects.collect { project(it).sourceSets.main.compileClasspath })
+
+        var docsDir = rootProject.file('src/docs/')
+        inputs.dir(docsDir)
+            .withPropertyName('docs resources directory')
+            .withPathSensitivity(PathSensitivity.RELATIVE)
+            .optional()
+
+        failOnError = false
+
+        // Exclude the Minecraft classes if not enabled
+        if (!project.hasProperty('generateAllDocumentation')) {
+            exclude 'net/minecraft/**'
+            exclude 'com/mojang/**'
+        }
+        exclude 'mcp/**'
+
+        options.addStringOption('Xdoclint:all,-missing', '-public')
+        options {
+            stylesheetFile = new File(docsDir, 'stylesheet.css')
+
+            tags = [
+                'apiNote:a:<em>API Note:</em>',
+                'implSpec:a:<em>Implementation Requirements:</em>',
+                'implNote:a:<em>Implementation Note:</em>'
+            ]
+
+            groups = [
+                'Forge Mod Loader': [
+                    'net.minecraftforge.fml.common.asm*',
+                    'net.minecraftforge.fml.loading*',
+                    'net.minecraftforge.fml.server*'
+                ],
+                'FML Core':  [
+                    'net.minecraftforge.fml',
+                    'net.minecraftforge.fml.config*',
+                    'net.minecraftforge.fml.event*',
+                    'net.minecraftforge.fml.util*'
+                ],
+                'FML Common': [
+                    'net.minecraftforge.fml.core',
+                    'net.minecraftforge.fml.event.config',
+                    'net.minecraftforge.fml.event.lifecycle'
+                ],
+                'FML Java/MC Language Providers': [
+                    'net.minecraftforge.fml.common',
+                    'net.minecraftforge.fml.javafmlmod',
+                    'net.minecraftforge.fml.mclanguageprovider'
+                ],
+                'Minecraft Forge API': [
+                    'net.minecraftforge*'
+                ]
+            ]
+
+            author = false
+            noSince = true
+            noHelp = true
+
+            bottom = "Minecraft Forge is an open source modding API for Minecraft: Java Edition, licensed under the Lesser GNU General Public License, version 2.1."
+            windowTitle = "Minecraft Forge API ${VERSION}"
+            docTitle = "Minecraft Forge API - ${FORGE_VERSION} for Minecraft ${MC_VERSION}"
+            header = "<div style=\"margin-top: 9px;padding: 5px 6px;\"><strong>${FORGE_VERSION} for Minecraft ${MC_VERSION}</strong></div>"
+        }
+
+        doLast {
+            project.copy {
+                from docsDir
+                exclude '/stylesheet.css'
+                into destinationDir
+            }
+        }
+    }
+
     publishing {
         publications {
             mavenJava(MavenPublication) {

buildSrc/build.gradle

@@ -2,8 +2,9 @@ repositories {
     maven { url = 'https://maven.minecraftforge.net/' }
 	mavenCentral()
 }
+
 dependencies {
-	implementation 'org.ow2.asm:asm:9.1'
-	implementation 'org.ow2.asm:asm-tree:9.1'
+	implementation 'org.ow2.asm:asm:9.3'
+	implementation 'org.ow2.asm:asm-tree:9.3'
     implementation 'net.minecraftforge:srgutils:0.4.+'
 }

docs/CONTRIBUTING.md

@@ -1,11 +1,11 @@
 Contributing to Forge
 =====================
 
-1) Keep patches to Minecraft classes minimal. If you need a lot of things done, you may either add to relevant forge classes or make a new class.
+1) Keep patches to Minecraft classes together. If you need a lot of things done, you may either add to relevant forge classes or make a new class. Try not to spread out your patches across multiple disjoint lines, as this makes maintenance of your patches difficult.
 
-2) An example mod must be provided for all PRs adding events/hooks to Forge. Whether it's a full mod using your proposed hooks, or just a pastebin containing a simple example, an example mod is required. Please also explain in detail what your new hook does.
+2) TODO: Test Mods
 
-3) Follow Forge coding guidelines (braces on newlines, spaces instead of tabs, etc)
+3) Follow the code style of the class you're working in (braces on newlines & spaces instead of tabs in Forge classes, inline brackets in patches, etc).
 
 For more information, refer to [the wiki](https://github.com/MinecraftForge/MinecraftForge/wiki/If-you-want-to-contribute-to-Forge)
 

docs/README.md

@@ -8,10 +8,10 @@ MinecraftForge
 
 Forge is a free, open-source modding API all of your favourite mods use!
 
-|    Version    |    Support    |
-| ------------- | ------------- |
-|    1.18.x     |    Active     |
-|    1.16.x     |    LTS        |
+| Version |    Support    |
+|---------| ------------- |
+| 1.19.x  |    Active     |
+| 1.18.x  |    LTS        |
 
 * [Download]
 * [Forum]
@@ -29,7 +29,7 @@ You can download the installer for the *Recommended Build* or the
  into your vanilla launcher environment, where you can then create a new
  profile using that version and play the game!
 
-For support and questions, visit [the Support Forum](https://www.minecraftforge.net/forum/forum/18-support-bug-reports/).
+For support and questions, visit [the Support Forum](https://www.minecraftforge.net/forum/forum/18-support-bug-reports/) or [the Forge Discord server](https://discord.gg/forge).
 
 [Here is a short video from Rorax showing how to install and setup Forge.](https://www.youtube.com/watch?v=lB3ArN_-3Oc)
 
@@ -41,7 +41,7 @@ For support and questions, visit [the Support Forum](https://www.minecraftforge.
 
 If you wish to actually inspect Forge, submit PRs or otherwise work
  with Forge itself, you're in the right place!
- 
+
  [See the guide to setting up a Forge workspace](http://mcforge.readthedocs.io/en/latest/forgedev/).
 
 ### Pull requests
@@ -51,13 +51,14 @@ If you wish to actually inspect Forge, submit PRs or otherwise work
 Please read the contributing guidelines found [here](CONTRIBUTING.md) before making a pull request.
 
 ### Contributor License Agreement
-We require all contributors to acknowledge the [Forge Contributor
- License Agreement](https://cla-assistant.io/MinecraftForge/MinecraftForge). Please ensure you have a valid email address
- associated with your GitHub account to do this. If you have previously
+We require all contributors to acknowledge the [Forge Contributor License Agreement](https://cla-assistant.io/MinecraftForge/MinecraftForge). 
+Please ensure you have a valid email address associated with your GitHub account to do this. If you have previously 
  signed it, you should be OK.
 
 #### Donate
-*Forge is a large project with many collaborators working on it around the clock. Forge is and will always remain free to use and modify. However, it costs money to run such a large project as this, so please consider [becoming a patron](https://www.patreon.com/LexManos).*
+*Forge is a large project with many collaborators working on it around the clock. Forge is and will always remain free 
+ to use and modify. However, it costs money to run such a large project as this, so please consider 
+ [becoming a patron](https://www.patreon.com/LexManos).*
 
 [Download]: https://files.minecraftforge.net/
 [Forum]: https://www.minecraftforge.net/forum/

docs/SUPPORT.md

@@ -76,15 +76,16 @@ If you're certain you've found an issue that is directly caused by Forge, you ha
 
  1. **Forge Forums:** There's a dedicated [Support & Bug Report](http://www.minecraftforge.net/forum/forum/18-support-bug-reports/) section on the Forge forums, which is led by team of moderators and volunteers who will try to deal with your reports as quickly as possible. *As a player you should probably report here first.*
    - For modders, there also is a separate [Modder Support](http://www.minecraftforge.net/forum/forum/70-modder-support/) section where you can ask all your development-related questions. *You should prefer this section for coding help.*
- 2. **Forge IRC Channel:** You can find a lot of help on the official [`#minecraftforge`](irc://irc.esper.net:6667/minecraftforge) channel on EsperNet. Especially smaller issues that you quickly need help with could be reported there. *Be aware that the channel is more suited towards development questions, so while you may get support there as a player, you should almost always prefer the forums.*
+ 2. **Forge Discord Server:** You can find a lot of help on the official [Discord Server](https://discord.gg/forge), especially smaller issues that you quickly need help with. *Be aware that the channel is more suited towards development questions, so while you may get support there as a player, you should almost always prefer the forums.*
  3. **Forge Issue Tracker:** If you're absolutely certain that you've found an issue in the Forge codebase (e.g. you're a modder yourself and have analyzed the stacktrace and relevant code), don't refrain from reporting it on this repository's [issue tracker](https://github.com/MinecraftForge/MinecraftForge/issues). *Please do not use the issues as a means of getting coding help. For developers, the IRC and the [official documentation](https://mcforge.readthedocs.io) are the best sources of information.*
 
 ### Mod Support
 
 A lot of mods also use GitHub or other source management systems and their integrated issue trackers. The following options will give you the best chances of reporting your issue in the right place:
 
  - **CurseForge:** Many mods are hosted on the [CurseForge platform](https://minecraft.curseforge.com) nowadays. Chances are you already downloaded them from there or as a part of a modpack hosted there. Projects may specify an issue reporting link on their own page, so simply look for it on the mod's project page and you should be directed to the preferred means of error reporting.
- - **Searching for a repository directly:** You may need to try and find a repository directly on source control sites. The most common ones are [GitHub](https://github.com) and [BitBucket](https://bitbucket.org). Both come with search capabilities, so simply try to search for the mod's name.
+ - **Modrinth:** Some modders use [Modrinth](https://modrinth.com/mods) to host their mods, but be mindful that not all mods on this platform are for the Forge modloader.
+ - **Searching for a repository directly:** You may need to try and find a repository directly on source control sites. The most common ones are [GitHub](https://github.com), [GitLab](https://gitlab.com), and [BitBucket](https://bitbucket.org). Both come with search capabilities, so simply try to search for the mod's name.
 
 ### Vanilla Support
 

fmlcore/build.gradle

@@ -10,10 +10,12 @@ apply plugin: 'org.javamodularity.moduleplugin'
 dependencyUpdates.rejectVersionIf { isNonStable(it.candidate.version) }
 
 dependencies {
-    compileOnly('org.jetbrains:annotations:21.0.1')
+    compileOnly("org.jetbrains:annotations:${JETBRAINS_ANNOTATIONS_VERSION}")
+
+    api("net.minecraftforge:eventbus:${EVENTBUS_VERSION}")
+
     implementation(project(':fmlloader'))
-    api('net.minecraftforge:eventbus:5.0.+')
-    implementation('commons-io:commons-io:2.5')
+    implementation("commons-io:commons-io:${COMMONS_IO_VERSION}")
 }
 
 task sourcesJar(type: Jar) {