NeoForge Platform Support (#3781)

* Initial work on Forge platform

* Rework modded platforms to use a common module

* Add support for integrated worlds on modded platforms

* Fix classload errors and move mixins to shared module

* Fix Fabric mixins and check min height in mod world manager

* Add Forge command support

* Add back modrinth publishing

* Don't apply application plugin to shared mod sources

* Fix docs

* Delete unused class

* Clean up repositories

* - Update to 1.20.2
- set custom refmap name
- fixed console commands crashing the server (hasPermission now accepts CommandSourceStack instead of Player)
- Forge wants fastutil relocated, so be it

Current issues:
- ClassNotFound exceptions with classes that are clearly present

* - Fix ClassNotFound errors on Forge due to weird Classloader
- Dont relocate gson

* merge upstream

* oh no

* Bump lombok, architectury-loom

* init: neoforge 1.20.4 support

* NeoForge builds

Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com>

* Archive neoforge artifacts

* transformForge -> transformNeoForge

* Neoforge boots!
* Fix mixins on neoforge
* Update build/pr file names
* Update mods.toml to new neoforge standard
* Fix refmap naming

* more fixes
- no need to include gson
- cleanup nullable/nonnull annotations
- add more info to geyser dumps on neoforge

* yeet platform executor

* yet another temp branch to figure out the runServer task

* yeet transitive dependency, that cant be right

* Attempt at getting the runServer task to work, part two

* Revert the changes for the runServer task, try and shut down the injector

* Remove spigot weird bug workaround, shut down properly
Also add a compileOnly dependency for the mod module to get rid of spammy false warnings

* Update to latest restart changes
- fix duplicate nodes crashing neoforge
- connector -> geyser in GeyserModCommandExecutor
- create command manager early to fix issues with permission gather event

* Consistent NeoForge spelling, move some dependencies to the version toml

* Add lombok to version catalogue

* Add plugins to version catalogue

* revert move to buildSrc

* Create `assets/geyser/icon.png` to reference icon from a single file on standalone/neoforge/fabric

* add fabric permissions api to libs.versions.toml

---------

Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com>
Co-authored-by: onebeastchris <github@onechris.mozmail.com>
Co-authored-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com>

bootstrap/mod/fabric/build.gradle.kts

@@ -0,0 +1,49 @@
+plugins {
+    application
+}
+
+architectury {
+    platformSetupLoomIde()
+    fabric()
+}
+
+dependencies {
+    modImplementation(libs.fabric.loader)
+    modApi(libs.fabric.api)
+
+    api(project(":mod", configuration = "namedElements"))
+    shadow(project(path = ":mod", configuration = "transformProductionFabric")) {
+        isTransitive = false
+    }
+    shadow(projects.core) {
+        exclude(group = "com.google.guava", module = "guava")
+        exclude(group = "com.google.code.gson", module = "gson")
+        exclude(group = "org.slf4j")
+        exclude(group = "com.nukkitx.fastutil")
+        exclude(group = "io.netty.incubator")
+    }
+
+    modImplementation(libs.fabric.permissions)
+    include(libs.fabric.permissions)
+}
+
+application {
+    mainClass.set("org.geysermc.geyser.platform.fabric.GeyserFabricMain")
+}
+
+tasks {
+    remapJar {
+        archiveBaseName.set("Geyser-Fabric")
+    }
+
+    remapModrinthJar {
+        archiveBaseName.set("geyser-fabric")
+    }
+}
+
+modrinth {
+    loaders.add("fabric")
+    dependencies {
+        required.project("fabric-api")
+    }
+}

bootstrap/mod/fabric/gradle.properties

@@ -0,0 +1 @@
+loom.platform=fabric

bootstrap/mod/fabric/src/main/java/org/geysermc/geyser/platform/fabric/GeyserFabricBootstrap.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.platform.fabric;
+
+import me.lucko.fabric.api.permissions.v0.Permissions;
+import net.fabricmc.api.EnvType;
+import net.fabricmc.api.ModInitializer;
+import net.fabricmc.fabric.api.event.lifecycle.v1.ServerLifecycleEvents;
+import net.fabricmc.fabric.api.networking.v1.ServerPlayConnectionEvents;
+import net.fabricmc.loader.api.FabricLoader;
+import net.minecraft.commands.CommandSourceStack;
+import net.minecraft.world.entity.player.Player;
+import org.geysermc.geyser.platform.mod.GeyserModBootstrap;
+import org.geysermc.geyser.platform.mod.GeyserModUpdateListener;
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+public class GeyserFabricBootstrap extends GeyserModBootstrap implements ModInitializer {
+
+    public GeyserFabricBootstrap() {
+        super(new GeyserFabricPlatform());
+    }
+
+    @Override
+    public void onInitialize() {
+        if (FabricLoader.getInstance().getEnvironmentType() == EnvType.SERVER) {
+            // Set as an event, so we can get the proper IP and port if needed
+            ServerLifecycleEvents.SERVER_STARTED.register((server) -> {
+                this.setServer(server);
+                onGeyserEnable();
+            });
+        }
+
+        // These are only registered once
+        ServerLifecycleEvents.SERVER_STOPPING.register((server) -> onGeyserShutdown());
+        ServerPlayConnectionEvents.JOIN.register((handler, $, $$) -> GeyserModUpdateListener.onPlayReady(handler.getPlayer()));
+
+        this.onGeyserInitialize();
+    }
+
+    @Override
+    public boolean hasPermission(@NonNull Player source, @NonNull String permissionNode) {
+        return Permissions.check(source, permissionNode);
+    }
+
+    @Override
+    public boolean hasPermission(@NonNull CommandSourceStack source, @NonNull String permissionNode, int permissionLevel) {
+        return Permissions.check(source, permissionNode, permissionLevel);
+    }
+}

bootstrap/mod/fabric/src/main/java/org/geysermc/geyser/platform/fabric/GeyserFabricDumpInfo.java

@@ -0,0 +1,88 @@
+/*
+ * Copyright (c) 2019-2022 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.platform.fabric;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import net.fabricmc.api.EnvType;
+import net.fabricmc.loader.api.FabricLoader;
+import net.fabricmc.loader.api.ModContainer;
+import net.fabricmc.loader.api.metadata.ModMetadata;
+import net.fabricmc.loader.api.metadata.Person;
+import net.minecraft.server.MinecraftServer;
+import org.geysermc.geyser.dump.BootstrapDumpInfo;
+import org.geysermc.geyser.text.AsteriskSerializer;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Collectors;
+
+@Getter
+public class GeyserFabricDumpInfo extends BootstrapDumpInfo {
+
+    private final String platformName;
+    private String platformVersion;
+    private final String minecraftVersion;
+    private final EnvType environmentType;
+
+    @AsteriskSerializer.Asterisk(isIp = true)
+    private final String serverIP;
+    private final int serverPort;
+    private final boolean onlineMode;
+    private final List<ModInfo> mods;
+
+    public GeyserFabricDumpInfo(MinecraftServer server) {
+        this.platformName = server.getServerModName();
+        FabricLoader.getInstance().getModContainer("fabricloader").ifPresent(mod ->
+            this.platformVersion = mod.getMetadata().getVersion().getFriendlyString());
+
+        this.minecraftVersion = server.getServerVersion();
+        this.environmentType = FabricLoader.getInstance().getEnvironmentType();
+        this.serverIP = server.getLocalIp() == null ? "unknown" : server.getLocalIp();
+        this.serverPort = server.getPort();
+        this.onlineMode = server.usesAuthentication();
+        this.mods = new ArrayList<>();
+
+        for (ModContainer mod : FabricLoader.getInstance().getAllMods()) {
+            ModMetadata meta = mod.getMetadata();
+            this.mods.add(new ModInfo(
+                FabricLoader.getInstance().isModLoaded(meta.getId()),
+                meta.getId(),
+                meta.getVersion().getFriendlyString(),
+                meta.getAuthors().stream().map(Person::getName).collect(Collectors.toList()))
+            );
+        }
+    }
+
+    @Getter
+    @AllArgsConstructor
+    public static class ModInfo {
+        public boolean enabled;
+        public String name;
+        public String version;
+        public List<String> authors;
+    }
+}

bootstrap/mod/fabric/src/main/java/org/geysermc/geyser/platform/fabric/GeyserFabricMain.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2019-2022 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.platform.fabric;
+
+import org.geysermc.geyser.GeyserMain;
+
+public class GeyserFabricMain extends GeyserMain {
+
+    public static void main(String[] args) {
+        new GeyserFabricMain().displayMessage();
+    }
+
+    @Override
+    public String getPluginType() {
+        return "Fabric";
+    }
+
+    @Override
+    public String getPluginFolder() {
+        return "mods";
+    }
+}

bootstrap/mod/fabric/src/main/java/org/geysermc/geyser/platform/fabric/GeyserFabricPlatform.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2019-2023 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.platform.fabric;
+
+import net.fabricmc.loader.api.FabricLoader;
+import net.fabricmc.loader.api.ModContainer;
+import net.minecraft.server.MinecraftServer;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.geysermc.geyser.api.util.PlatformType;
+import org.geysermc.geyser.dump.BootstrapDumpInfo;
+import org.geysermc.geyser.platform.mod.GeyserModBootstrap;
+import org.geysermc.geyser.platform.mod.platform.GeyserModPlatform;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Path;
+import java.util.Optional;
+
+public class GeyserFabricPlatform implements GeyserModPlatform {
+    
+    private final ModContainer mod;
+
+    public GeyserFabricPlatform() {
+        this.mod = FabricLoader.getInstance().getModContainer("geyser-fabric").orElseThrow();
+    }
+
+    @Override
+    public @NonNull PlatformType platformType() {
+        return PlatformType.FABRIC;
+    }
+
+    @Override
+    public @NonNull String configPath() {
+        return "Geyser-Fabric";
+    }
+
+    @Override
+    public @NonNull Path dataFolder(@NonNull String modId) {
+        return FabricLoader.getInstance().getConfigDir().resolve(modId);
+    }
+
+    @Override
+    public @NonNull BootstrapDumpInfo dumpInfo(@NonNull MinecraftServer server) {
+        return new GeyserFabricDumpInfo(server);
+    }
+
+    @Override
+    public boolean testFloodgatePluginPresent(@NonNull GeyserModBootstrap bootstrap) {
+        Optional<ModContainer> floodgate = FabricLoader.getInstance().getModContainer("floodgate");
+        if (floodgate.isPresent()) {
+            Path floodgateDataFolder = FabricLoader.getInstance().getConfigDir().resolve("floodgate");
+            bootstrap.getGeyserConfig().loadFloodgate(bootstrap, floodgateDataFolder);
+            return true;
+        }
+
+        return false;
+    }
+
+    @Override
+    public @Nullable InputStream resolveResource(@NonNull String resource) {
+        // We need to handle this differently, because Fabric shares the classloader across multiple mods
+        Path path = this.mod.findPath(resource).orElse(null);
+        if (path == null) {
+            return null;
+        }
+
+        try {
+            return path.getFileSystem()
+                    .provider()
+                    .newInputStream(path);
+        } catch (IOException e) {
+            return null;
+        }
+    }
+}

bootstrap/mod/fabric/src/main/resources/fabric.mod.json

@@ -0,0 +1,31 @@
+{
+  "schemaVersion": 1,
+  "id": "${id}-fabric",
+  "version": "${version}",
+  "name": "${name}-Fabric",
+  "description": "A bridge/proxy allowing you to connect to Minecraft: Java Edition servers with Minecraft: Bedrock Edition. ",
+  "authors": [
+    "${author}"
+  ],
+  "contact": {
+    "website": "${url}",
+    "repo": "https://github.com/GeyserMC/Geyser"
+  },
+  "license": "MIT",
+  "icon": "assets/geyser/icon.png",
+  "environment": "*",
+  "entrypoints": {
+    "main": [
+        "org.geysermc.geyser.platform.fabric.GeyserFabricBootstrap"
+    ]
+  },
+  "mixins": [
+    "geyser.mixins.json"
+  ],
+  "depends": {
+    "fabricloader": ">=0.15.2",
+    "fabric": "*",
+    "minecraft": ">=1.20.4",
+    "fabric-permissions-api-v0": "*"
+  }
+}