Port to 1.21.1 neoforge

Author: TexBlock

CHANGELOG.md

@@ -1,3 +1,3 @@
 ### Maintenance Update
 
-- **Use** fully semantic versioning.
+- **Port** to 1.21.1 neoforge

README.md

@@ -2,41 +2,6 @@
 
 ![Banner](https://github.com/KessokuTeaTime/Splasher/blob/artwork/banner.png)
 
-**Customize Minecraft's Splash Texts at Your Will!**
-
-## Contributing a Translation
-
-Splasher turns Minecraft `splashes.txt` into `.json` files, and supports multi languages.
-
-You will find `en_us.json` under `assets/splasher/lang/` and feel free translate it into your favorite language.
-
-After translation, rename it to `xx_xx.json` (e.g., `zh_cn.json`), and enjoy! You can also create a pull request to contribute.
-
-## Adding a Customization
-
-Splasher supports custom splash texts to append, or replace the original ones.
-
-Custom splash texts are `.txt` files stored under `.minecraft/config/splasher/` and should be named the same as your target language (`en_us.txt` etc.).
-
-In these files, every single splash takes a single line, and `§ Formatting Code` is under supported, the same as the Minecraft `splashes.txt` under directory `.minecraft/assets/minecraft/texts/`.
+### Splasher for NeoForge `1.21.1`
 
-## Configuring Splasher
-
-Splasher is using **[Cloth Config API](https://modrinth.com/mod/cloth-config)** and is fully configurable, you can find the config file under `.minecraft/config/splasher.toml`.
-
-Every option is well documented, and you can achieve different effects by changing the values, for example:
-
-- Disabling all splashes
-- Only enabling custom splashes
-- Enabling both original and custom splashes, and not following the client language
-- And more...
-
-## License
-
-**Splasher** is licensed under the **[GNU General Public License v3.](LICENSE)**
-
-## Screenshots
-
-> ![Custom Splash Text](https://github.com/KessokuTeaTime/Splasher/blob/artwork/content/splash.png)
->
-> Splasher displaying custom splash text `Splasher!`
+**Customize Minecraft's Splash Texts at Your Will!**

build.gradle.kts

@@ -3,8 +3,8 @@ plugins {
 	java
 	idea
 	`maven-publish`
-	alias(libs.plugins.fabric.loom)
-	alias(libs.plugins.modpublisher)
+    alias(libs.plugins.architectury.loom)
+    alias(libs.plugins.modpublisher)
 }
 
 val display = libs.versions.display
@@ -21,15 +21,17 @@ repositories {
 	maven { url = uri("https://jitpack.io") }
 	maven { url = uri("https://api.modrinth.com/maven") }
 	maven { url = uri("https://maven.shedaniel.me/") } // Cloth Config
-	maven { url = uri("https://maven.terraformersmc.com/releases/") } // Mod Menu
+    maven { url = uri("https://maven.neoforged.net/releases/") }
 }
 
 dependencies {
 	minecraft(libs.minecraft)
-	mappings(libs.yarn) { artifact { classifier = "v2" } }
-	modImplementation(libs.bundles.fabric)
+    mappings(loom.layered {
+        mappings(variantOf(libs.yarn) { classifier("v2") })
+        mappings(libs.yarn.patch)
+    })
+    neoForge(libs.neoforge)
 
-	modApi(libs.modmenu)
 	modApi(libs.night.auto.config)
 
 	modCompileOnly(libs.bounced)
@@ -44,7 +46,7 @@ java {
 
 tasks {
 	processResources {
-		filesMatching("fabric.mod.json") {
+		filesMatching("META-INF/neoforge.mods.toml") {
 			expand(mapOf(
 					"version" to libs.versions.mod.get(),
 					"display" to display

gradle.properties

@@ -0,0 +1,4 @@
+org.gradle.jvmargs=-Xmx4G
+org.gradle.parallel=true
+
+loom.platform=neoforge

gradle/libs.versions.toml

@@ -2,41 +2,36 @@
 maven-group = "band.kessokuteatime"
 archives-name = "splasher"
 mod = "6.2.3"
-loader = "fabric"
+loader = "neoforge"
 
-minecraft = "1.21"
-yarn = "1.21+build.1"
-fabric-loader = "0.15.11"
-fabric-api = "0.100.6+1.21"
-fabric-loom = "1.6-SNAPSHOT"
-modpublisher = "2.1.0"
+minecraft = "1.21.1"
+yarn = "1.21.1+build.1"
+yarn-patch = "1.21+build.6"
+neoforge = "21.1.213"
+architectury-loom = "1.10-SNAPSHOT"
+modpublisher = "2.+"
 
-modmenu = "11.0.1"
-night-auto-config = "1.0.6-fabric.1.21"
-bounced = "4.1.3-fabric.1.21"
+night-auto-config = "1.1.0-alpha.4-neoforge.1.21.1"
+bounced = "4.1.0-neoforge.1.21.1"
 
 # id
 id-modrinth = "4yIZUuyx"
 id-curseforge = "844451"
 
 # display
 display-name = "Splasher!"
-display-loader = "Fabric"
+display-loader = "NeoForge"
 display-version = "1.21+"
 
 [libraries]
 minecraft = { group = "com.mojang", name = "minecraft", version.ref = "minecraft" }
 yarn = { group = "net.fabricmc", name = "yarn", version.ref = "yarn" }
-fabric-loader = { group = "net.fabricmc", name = "fabric-loader", version.ref = "fabric-loader" }
-fabric-api = { group = "net.fabricmc.fabric-api", name = "fabric-api", version.ref = "fabric-api" }
+yarn-patch = { group = "dev.architectury", name = "yarn-mappings-patch-neoforge", version.ref = "yarn-patch"}
+neoforge = { group = "net.neoforged", name = "neoforge", version.ref = "neoforge" }
 
-modmenu = { group = "com.terraformersmc", name = "modmenu", version.ref = "modmenu" }
 night-auto-config = { group = "com.github.KessokuTeaTime", name = "Night-Auto-Config", version.ref = "night-auto-config" }
 bounced = { group = "maven.modrinth", name = "bounced", version.ref = "bounced" }
 
 [plugins]
-fabric-loom = { id = "fabric-loom", version.ref = "fabric-loom" }
+architectury-loom = { id = "dev.architectury.loom", version.ref = "architectury-loom" }
 modpublisher = { id = "com.hypherionmc.modutils.modpublisher", version.ref = "modpublisher" }
-
-[bundles]
-fabric = ["fabric-loader", "fabric-api"]

settings.gradle.kts

@@ -4,6 +4,8 @@ pluginManagement {
             name = "Fabric"
             url = uri("https://maven.fabricmc.net/")
         }
+        maven { url = uri("https://maven.architectury.dev/") }
+        maven { url = uri("https://maven.neoforged.net/releases/") }
         maven { url = uri("https://maven.firstdark.dev/releases") } // modpublisher
         mavenCentral()
         gradlePluginPortal()

src/main/java/band/kessokuteatime/splasher/Splasher.java

@@ -4,26 +4,30 @@
 import band.kessokuteatime.nightautoconfig.config.base.ConfigType;
 import me.shedaniel.autoconfig.AutoConfig;
 import me.shedaniel.autoconfig.ConfigHolder;
-import net.fabricmc.api.ClientModInitializer;
-import net.fabricmc.fabric.api.client.screen.v1.ScreenEvents;
-import net.fabricmc.fabric.api.client.screen.v1.ScreenMouseEvents;
-import net.fabricmc.loader.api.FabricLoader;
 import band.kessokuteatime.splasher.config.SplasherConfig;
 import net.minecraft.client.MinecraftClient;
+import net.minecraft.client.gui.screen.Screen;
 import net.minecraft.client.gui.screen.TitleScreen;
 import net.minecraft.client.sound.PositionedSoundInstance;
 import net.minecraft.sound.SoundEvents;
 import net.minecraft.text.MutableText;
 import net.minecraft.text.Text;
 import net.minecraft.util.Formatting;
+import net.neoforged.fml.ModList;
+import net.neoforged.fml.ModLoadingContext;
+import net.neoforged.fml.common.Mod;
+import net.neoforged.neoforge.client.event.ScreenEvent;
+import net.neoforged.neoforge.client.gui.IConfigScreenFactory;
+import net.neoforged.neoforge.common.NeoForge;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.util.ArrayList;
 import java.util.Objects;
 import java.util.concurrent.atomic.AtomicBoolean;
 
-public class Splasher implements ClientModInitializer {
+@Mod(Splasher.ID)
+public class Splasher {
 	public static final String NAME = "Splasher", ID = "splasher";
 	public static final Logger LOGGER = LoggerFactory.getLogger(ID);
 	public static final ConfigHolder<SplasherConfig> CONFIG;
@@ -79,25 +83,33 @@ public static boolean shouldSplash() {
 	private static float height = 0, width = 0;
 	public static boolean initialized = false;
 
-	@Override
-	public void onInitializeClient() {
-		boolean isBouncedLoaded = FabricLoader.getInstance().isModLoaded("bounced");
-
-		ScreenEvents.BEFORE_INIT.register((client, screen, scaledWidth, scaledHeight) -> {
-			if (screen instanceof TitleScreen) {
-				ScreenMouseEvents.beforeMouseClick(screen)
-						.register((currentScreen, mouseX, mouseY, button) -> {
-							// Linkage with Bounced
-							if (isBouncedLoaded)
-								mouseY -= Bounced.primaryPos();
-
-							if (isMouseHovering(scaledWidth, mouseX, mouseY) && CONFIG.get().texts.randomRate.onClick()) {
-								push();
-								playClickingSound();
-							}
-						});
-			}
-		});
+	public Splasher() {
+        ModLoadingContext.get().registerExtensionPoint(IConfigScreenFactory.class, () -> (modContainer, screen) -> {
+            CONFIG.load();
+            return AutoConfig.getConfigScreen(SplasherConfig.class, screen).get();
+        });
+
+		boolean isBouncedLoaded = ModList.get().isLoaded("bounced");
+
+        NeoForge.EVENT_BUS.addListener(ScreenEvent.Init.Post.class, screenInitEvent -> {
+            Screen screen = screenInitEvent.getScreen();
+            if (screen instanceof TitleScreen) {
+                NeoForge.EVENT_BUS.addListener(ScreenEvent.MouseButtonPressed.Post.class, screenMousePressedEvent -> {
+                    double mouseX = screenMousePressedEvent.getMouseX();
+                    double mouseY = screenMousePressedEvent.getMouseY();
+                    double scaledWidth = screen.width;
+
+                    // Linkage with Bounced
+                    if (isBouncedLoaded)
+                        mouseY -= Bounced.primaryPos();
+
+                    if (isMouseHovering(scaledWidth, mouseX, mouseY) && CONFIG.get().texts.randomRate.onClick()) {
+                        push();
+                        playClickingSound();
+                    }
+                });
+            }
+        });
 	}
 
 	public static void playClickingSound() {

src/main/java/band/kessokuteatime/splasher/config/modmenu/SplasherModMenuIntegration.java

@@ -2,11 +2,11 @@
 
 import band.kessokuteatime.splasher.Splasher;
 import band.kessokuteatime.splasher.base.FormattingType;
-import net.fabricmc.loader.api.FabricLoader;
 import band.kessokuteatime.splasher.loader.SplashTextLoader;
 import net.minecraft.client.MinecraftClient;
 import net.minecraft.client.session.Session;
 import net.minecraft.text.Text;
+import net.neoforged.fml.loading.FMLPaths;
 import org.apache.commons.compress.utils.Lists;
 import org.jetbrains.annotations.Nullable;
 
@@ -17,7 +17,7 @@ public class SplashTextSupplier {
 	private static int lastRandomIndex = -1;
 
 	@Nullable public static String getSplashes(Session session, List<String> splashTexts) {
-		Path path = FabricLoader.getInstance().getConfigDir().resolve(Splasher.ID);
+		Path path = FMLPaths.CONFIGDIR.get().resolve(Splasher.ID);
 
 		String language = !Splasher.CONFIG.get().followsClientLanguage ? "en_us" : MinecraftClient.getInstance().getLanguageManager().getLanguage();
 		List<String> customSplashTexts = Lists.newArrayList();

src/main/java/band/kessokuteatime/splasher/supplier/SplashTextSupplier.java

@@ -0,0 +1,31 @@
+modLoader = "javafml"
+loaderVersion = "[1,)"
+license = "GPL-3.0"
+
+[[mods]]
+modId = "splasher"
+version = "${version}"
+displayName = "${display.name.get()}"
+displayURL = "https://github.com/KessokuTeaTime/Splasher"
+authors = "Kessoku Tea Time"
+description = '''
+Why don't splash? Splasher is a mod which makes splash texts fully customizable.
+'''
+logoFile = "assets/splasher/icon.png"
+
+[[mixins]]
+config = "splasher.mixins.json"
+
+[[dependencies.splasher]]
+modId = "neoforge"
+type = "required"
+versionRange = "[21.0,)"
+ordering = "NONE"
+side = "BOTH"
+
+[[dependencies.splasher]]
+modId = "minecraft"
+type = "required"
+versionRange = "[1.21,)"
+ordering = "NONE"
+side = "BOTH"