Merge pull request #17 from eclipseisoffline/snapshots

Update to Minecraft 26.1

Author: eclipseisoffline

CHANGELOG.md

@@ -1 +1,5 @@
-- Update to 1.21.11.
+- Update to Minecraft 26.1.
+- Add `text_opacity` and `background_color` options for the `display_above_player` config option. Old config files are automatically updated to include them.
+- Port to NeoForge.
+
+**Please make sure to properly back up your world when updating! Minecraft 26.1 changes the structure of Minecraft worlds a lot, and while this mod has adjusted for that, I cannot guarantee that no data loss will happen!**

README.md

@@ -6,6 +6,8 @@
 [![Discord Badge](https://img.shields.io/badge/chat-discord-%235865f2)](https://discord.gg/CNNkyWRkqm)
 [![Github Badge](https://img.shields.io/badge/github-customname-white?logo=github)](https://github.com/eclipseisoffline/customname)
 ![GitHub License](https://img.shields.io/github/license/eclipseisoffline/customname)
+![Available for Fabric](https://img.shields.io/badge/available_for-fabric-_?color=%23dbd0b4)
+![Available for NeoForge](https://img.shields.io/badge/available_for-NeoForge-_?color=%23e58c53)
 
 This mod adds a `/name`, a `/itemname` and a `/itemlore` command to Minecraft, which players can use to set a prefix, suffix, or nickname,
 or give their items colourful names and lore. Mostly designed to be used in small, private servers, although through the
@@ -31,23 +33,26 @@ For support and/or any questions you may have, feel free to join [my discord](ht
 
 | Minecraft Version | Status       |
 |-------------------|--------------|
-| 1.21.11           | ✅ Current    |
+| 26.1              | ✅ Current    |
+| 1.21.11           | ✔️ Available |
 | 1.21.9+10         | ✔️ Available |
 | 1.21.6+7+8        | ✔️ Available |
 | 1.21.5            | ✔️ Available |
 | 1.21.4            | ✔️ Available |
 | 1.21.2+3          | ✔️ Available |
-| 1.21+1            | ✅ Current    |
+| 1.21+1            | ✔️ Available |
 | 1.20.5+6          | ✔️ Available |
 | 1.20.4            | ✔️ Available |
 | 1.20.1            | ✔️ Available |
 | 1.19.4            | ✔️ Available |
 | 1.19.2            | ✔️ Available |
 
-I try to keep support up for the latest major and latest minor release of Minecraft. Updates to newer Minecraft
+I try to keep support up for the latest drop of Minecraft. Updates to newer Minecraft
 versions may be delayed from time to time, as I do not always have the time to immediately update my mods.
 
-Unsupported versions are still available to download, but they won't receive new features or bugfixes.
+Unsupported versions are/ still available to download, but they won't receive new features or bugfixes.
+
+NeoForge ports are available for Minecraft 26.1 onwards.
 
 ## Usage
 
@@ -96,7 +101,11 @@ By default, the configuration file looks like this:
   "blacklisted_names": [],
   "max_name_length": 16,
   "operators_bypass_restrictions": false,
-  "display_above_player": false,
+  "display_above_player": {
+    "enabled": false,
+    "text_opacity": 255,
+    "background_color": "#40000000"
+  },
   "name_groups": {
     "prefix": {},
     "nickname": {},
@@ -110,7 +119,9 @@ By default, the configuration file looks like this:
 - `blacklisted_names` is a list of regexes that are blacklisted. When a prefix, suffix or nickname matches one of these regexes, they won't be able to be used.
 - `max_name_length` controls how long a player prefix/nickname/suffix can be, which can be 32 at most.
 - `operators_bypass_restrictions` can be used to disable name restrictions for operators. When this is enabled, operators and people with the permission `customname.bypass_restrictions` can use spaces in nicknames, bypass the max length restriction, and more.
-- `display_above_player` controls whether the player's custom name should display above their head in game. This is currently not compatible with hiding name tags using teams.
+- `display_above_player` controls whether the player's custom name should display above their head in game. This is currently not compatible with hiding name tags using teams. The appearance can be further configured using the following options:
+  - `text_opacity`: controls the opacity of the text. `255` is fully visible, `0` is transparent.
+  - `background_color`: the HEX-background colour of the name. This is in ARGB format, so the first 2 digits indicate the alpha value.
 - `name_groups` can be used to create name groups for each name type. Name groups consist of a list of names, which follow the same format used in name commands. You can assign players to one or more name groups by giving them permissions to the respective groups. They will then be able to use names listed in those groups.
 
 For example, consider this name groups config:
@@ -123,14 +134,14 @@ For example, consider this name groups config:
       "&f&l[&9VIP&f&l]",
       "&f&l[&aVIP&f&l]",
       "&f&l[&bVIP&f&l]",
-      "&f&l[&cVIP&f&l]",
+      "&f&l[&cVIP&f&l]"
     ],
     "legendary": [
       "&f&l[&7Legendary&f&l]",
       "&f&l[&9Legendary&f&l]",
       "&f&l[&aLegendary&f&l]",
       "&f&l[&bLegendary&f&l]",
-      "&f&l[&cLegendary&f&l]",
+      "&f&l[&cLegendary&f&l]"
     ]
   },
   "nickname": {},

build.gradle

@@ -0,0 +1,65 @@
+import me.modmuss50.mpp.ReleaseType
+
+plugins {
+    alias(libs.plugins.multimod)
+}
+
+group = properties["maven_group"] as String
+version = properties["version"] as String
+
+multimod {
+    id = properties["mod_id"] as String
+    name = properties["mod_name"] as String
+    description = properties["mod_description"] as String
+
+    archivesBaseName = properties["archives_base_name"] as String
+
+    settings {
+        repositories {
+            maven {
+                name = "eclipseisoffline"
+                url = uri("https://maven.eclipseisoffline.xyz/releases")
+            }
+        }
+    }
+
+    minecraft {
+        minecraft = libs.minecraft
+        supported(libs.versions.minecraft.release)
+    }
+
+    fabricApi = libs.fabric.api
+    neoForgeVersion = libs.versions.neoforge
+
+    sharedDependencies {
+        multiModInclude(multiModImplementation(libs.commonpermissionsapi))
+        multiModInclude(multiModImplementation(libs.filefixutils))
+    }
+
+    modPublishing {
+        base {
+            changelog = file("CHANGELOG.md").readText()
+            type = ReleaseType.of(properties["release_type"] as String)
+        }
+
+        modrinth {
+            accessToken = providers.gradleProperty("MODRINTH_API_TOKEN")
+            projectId = properties["modrinth_project_id"] as String
+            minecraftVersions.addAll(libs.versions.minecraft.release.get().split(","))
+        }
+
+        github {
+            accessToken = providers.gradleProperty("GITHUB_API_PUBLISH_TOKEN")
+            repository = properties["github_repository"] as String
+            commitish = properties["git_branch"] as String
+        }
+    }
+
+    publishing {
+        maven {
+            name = "eclipseisoffline"
+            url = uri("https://maven.eclipseisoffline.xyz/releases")
+            credentials(PasswordCredentials::class)
+        }
+    }
+}

build.gradle.kts

@@ -0,0 +1,9 @@
+plugins {
+    alias(libs.plugins.multimod)
+}
+
+dependencies {
+    compileOnlyApi(libs.luckperms)
+}
+
+multimod.common()

common/build.gradle.kts

@@ -0,0 +1,52 @@
+package xyz.eclipseisoffline.eclipsescustomname;
+
+import com.mojang.brigadier.CommandDispatcher;
+
+import net.minecraft.commands.CommandSourceStack;
+import net.minecraft.resources.Identifier;
+import org.jspecify.annotations.Nullable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.nio.file.Path;
+import java.util.function.Consumer;
+
+public abstract class CustomName {
+    public static final String MOD_ID = "eclipsescustomname";
+    public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID);
+
+    private static boolean initialized = false;
+    @Nullable
+    private static CustomNameConfig config = null;
+
+    public void initialize() {
+        if (initialized) {
+            throw new IllegalStateException("Tried to initialise Custom Names twice!");
+        }
+        initialized = true;
+
+        LOGGER.info("Custom Names {} initialising", getVersion());
+        CustomNamePermissions.bootstrap();
+        LOGGER.info("Reading config");
+        config = CustomNameConfig.readOrCreate(getConfigDir());
+
+        registerCommands(CustomNameCommands::register);
+    }
+
+    protected abstract String getVersion();
+
+    protected abstract Path getConfigDir();
+
+    protected abstract void registerCommands(Consumer<CommandDispatcher<CommandSourceStack>> registerer);
+
+    public static CustomNameConfig getConfig() {
+        if (config == null) {
+            throw new NullPointerException("CustomNameConfig was accessed before it was initialized!");
+        }
+        return config;
+    }
+
+    public static Identifier getModdedIdentifier(String path) {
+        return Identifier.fromNamespaceAndPath(CustomName.MOD_ID, path);
+    }
+}