NeoForge Platform Support

.github/workflows/build.yml

@@ -47,7 +47,14 @@ jobs:
         if: success()
         with:
           name: Geyser Fabric
-          path: bootstrap/fabric/build/libs/Geyser-Fabric.jar
+          path: bootstrap/mod/fabric/build/libs/Geyser-Fabric.jar
+          if-no-files-found: error
+      - name: Archive artifacts (Geyser NeoForge)
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32
+        if: success()
+        with:
+          name: Geyser NeoForge
+          path: bootstrap/mod/neoforge/build/libs/Geyser-NeoForge.jar
           if-no-files-found: error
       - name: Archive artifacts (Geyser Standalone)
         uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32
@@ -118,15 +125,24 @@ jobs:
           echo "{\"project\": \"$project\", \"version\": \"$version\", \"id\": $GITHUB_RUN_NUMBER, \"commit\": \"$GITHUB_SHA\"}" > metadata.json
           rsync -P -e "ssh -o StrictHostKeyChecking=no -i id_ecdsa" metadata.json $DOWNLOADS_USERNAME@$DOWNLOADS_SERVER_IP:~/uploads/$project/$GITHUB_RUN_NUMBER/
 
-      - name: Publish to Modrinth
+      - name: Publish to Modrinth (Fabric)
         uses: gradle/gradle-build-action@3bfe3a46584a206fb8361cdedd0647b0c4204232
         if: ${{ success() && github.repository == 'GeyserMC/Geyser' && github.ref_name == 'master' }}
         env:
           MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }}
         with:
           arguments: fabric:modrinth
           gradle-home-cache-cleanup: true
-
+
+      - name: Publish to Modrinth (NeoForge)
+        uses: gradle/gradle-build-action@3bfe3a46584a206fb8361cdedd0647b0c4204232
+        if: ${{ success() && github.repository == 'GeyserMC/Geyser' && github.ref_name == 'master' }}
+        env:
+          MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }}
+        with:
+          arguments: neoforge:modrinth
+          gradle-home-cache-cleanup: true
+
       - name: Notify Discord
         if: ${{ (success() || failure()) && github.repository == 'GeyserMC/Geyser' }}
         # See https://github.com/Tim203/actions-git-discord-webhook/commits

.github/workflows/pullrequest.yml

@@ -57,7 +57,14 @@ jobs:
         if: success()
         with:
           name: Geyser Fabric
-          path: geyser/bootstrap/fabric/build/libs/Geyser-Fabric.jar
+          path: geyser/bootstrap/mod/fabric/build/libs/Geyser-Fabric.jar
+          if-no-files-found: error
+      - name: Archive artifacts (Geyser NeoForge)
+        uses: actions/upload-artifact@v3
+        if: success()
+        with:
+          name: Geyser NeoForge
+          path: geyser/bootstrap/mod/neoforge/build/libs/Geyser-NeoForge.jar
           if-no-files-found: error
       - name: Archive artifacts (Geyser Standalone)
         uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32

api/src/main/java/org/geysermc/geyser/api/pack/PathPackCodec.java

@@ -42,4 +42,4 @@ public abstract class PathPackCodec extends PackCodec {
      */
     @NonNull
     public abstract Path path();
-}
+}

api/src/main/java/org/geysermc/geyser/api/util/PlatformType.java

@@ -34,6 +34,7 @@ public record PlatformType(String platformName) {
     public static final PlatformType ANDROID = new PlatformType("Android");
     public static final PlatformType BUNGEECORD = new PlatformType("BungeeCord");
     public static final PlatformType FABRIC = new PlatformType("Fabric");
+    public static final PlatformType NEOFORGE = new PlatformType("NeoForge");
     public static final PlatformType SPIGOT = new PlatformType("Spigot");
 
     @Deprecated

bootstrap/mod/build.gradle.kts

@@ -0,0 +1,15 @@
+architectury {
+    common("neoforge", "fabric")
+}
+
+loom {
+    mixin.defaultRefmapName.set("geyser-refmap.json")
+}
+
+dependencies {
+    api(projects.core)
+    compileOnly(libs.mixin)
+
+    // Only here to suppress "unknown enum constant EnvType.CLIENT" warnings. DO NOT USE!
+    compileOnly(libs.fabric.loader)
+}

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")
+    }
+
+    // This should be in the libs TOML, but something about modImplementation AND include just doesn't work
+    include(modImplementation("me.lucko", "fabric-permissions-api", "0.2-SNAPSHOT"))
+}
+
+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/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/fabric/src/main/resources/fabric.mod.json → bootstrap/mod/fabric/src/main/resources/fabric.mod.json

@@ -9,18 +9,18 @@
   ],
   "contact": {
     "website": "${url}",
-    "repo": "https://github.com/GeyserMC/Geyser-Fabric"
+    "repo": "https://github.com/GeyserMC/Geyser"
   },
   "license": "MIT",
   "icon": "assets/geyser-fabric/icon.png",
   "environment": "*",
   "entrypoints": {
     "main": [
-        "org.geysermc.geyser.platform.fabric.GeyserFabricMod"
+        "org.geysermc.geyser.platform.fabric.GeyserFabricBootstrap"
     ]
   },
   "mixins": [
-    "geyser-fabric.mixins.json"
+    "geyser.mixins.json"
   ],
   "depends": {
     "fabricloader": ">=0.15.2",