PrioPacks is a thing

Author: onebeastchris

.github/workflows/gradle.yml

@@ -0,0 +1,41 @@
+name: Build and Release
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    container:
+      image: gradle:8-jdk17
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up JDK
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+          cache: 'gradle'
+
+      - name: Gradle Build
+        run: gradle build
+
+      - name: Release
+        uses: GeyserMC/actions/release@master
+        with:
+          files: |
+            build/libs/PrioPacks-*.jar
+          appID: ${{ secrets.RELEASE_APP_ID }}
+          appPrivateKey: ${{ secrets.RELEASE_APP_PK }}
+          saveMetadata: true
+          releaseEnabled: true
+          discordWebhook: ${{ secrets.DISCORD_WEBHOOK }}
+          ghReleaseNotes: true
+          releaseName: Build ${tagBase}
+          tagPrefix: release
+          tagIncrement: true
+          preRelease: false

README.md

@@ -1,34 +1,35 @@
-# Geyser Extension Template
-A Geyser Extension template for creating Geyser Extensions. 
+# PrioPacks
 
-## What are Geyser extensions?
-Geyser Extensions are the equivalent of “plugins”, but specifically for the Geyser platform. This brings the advantage of them being platform-agnostic, meaning that you won’t have to worry about supporting all platforms individually. Additionally, they will be, by design, only applied for Bedrock players joining via Geyser.
+A small Geyser extension that allows defining the order of resource pack registration. PrioPacks does not add any resource packs by itself,
+but it can set the pack stack order for any resource packs added by Geyser's pack folder, other extensions, and so forth.
 
-## What can extensions do?
-- Register [custom items](https://wiki.geysermc.org/geyser/custom-items/), [custom blocks](https://wiki.geysermc.org/geyser/custom-blocks/#geyser-extensions) and more in code!
-- Listen and toggle various Bedrock features (i.e. commands)
-- Send forms to Bedrock players using [Cumulus](https://github.com/GeyserMC/Cumulus)
-- Listen and interact with [Events](https://wiki.geysermc.org/geyser/events/)
+## Installing
+Download the PrioPacks.jar from the releases tab, and put it inside of Geyser's `extensions` folder. Then, restart Geyser, and you're done!
 
-## Using this Template
-Click "Use this template" on the top right, and create your own repo. 
-Then, see the [usage guide](./USAGE.md) for instructions on how to use this template.
+## Configuration
 
-## Documentation
-Our [wiki](https://geysermc.org/wiki/) has helpful articles. The following are recommended:
-- Geyser Event System documentation: https://geysermc.org/wiki/geyser/events
-- Geyser Forms / Cumulus documentation: https://geysermc.org/wiki/geyser/forms
-- Brief overview on the Geyser API: https://geysermc.org/wiki/geyser/api
-- Extension docs: https://geysermc.org/wiki/geyser/extensions
+```yml
+# PrioPacks Configuration
+# 
+# Source: https://github.com/onebeastchris/PrioPacks/
 
-## Existing Extensions
-See our list [here](https://github.com/GeyserMC/GeyserExtensionList).
+# The below list represents the resource pack stack. Each entry is a uuid of a loaded resource pack.
+# PrioPacks will then set priorities for each pack to ensure the order represented here!
+# Resource Packs higher in the stack will be applied first on the Bedrock client (e.g. overriding a texture change).
+# If this list contains uuids of resource packs that are not actually present, PrioPacks will gracefully skip over them.
+pack-stack:
+    - e5f5c938-a701-11eb-b2a3-047d7bb283ba
+    - d9ee1211-b03e-43ec-b7f6-b7bcc7cf3fa4
 
-## Suggestions?
-Reach out on our [Discord](https://discord.gg/geysermc)!
+# The highest priority that PrioPacks will assign to the top resource pack in the stack above.
+highest-priority: 100
 
-## Important Notes
-- `extension.yml` is required for Geyser to load the extension. It must be in the `resources` folder.
-- Geyser Extensions: https://github.com/GeyserMC/Geyser/blob/master/api/src/main/java/org/geysermc/geyser/api/extension/Extension.java
-- Geyser API javadocs: https://repo.opencollab.dev/javadoc/maven-snapshots/org/geysermc/geyser/api/latest
+# The lowest priority that PrioPacks will assign to the bottom resource pack in the stack.
+lowest-priority: -100
 
+# The config version. DO NOT CHANGE!
+version: 1
+```
+
+After making the changes, you can apply these using `/priopacks reload`. To see all Bedrock resource packs that a Bedrock client got when connecting,
+use `/priopacks debug` - this will print all resource packs of the first Bedrock client that joined after PrioPacks was started / reloaded.

USAGE.md

@@ -1,10 +1,12 @@
 plugins {
     java
+    id("io.freefair.lombok") version "8.14"
+    id("com.gradleup.shadow") version "8.3.3"
 }
 
 val id = project.property("id") as String
 val extensionName = project.property("name") as String
-val geyserApiVersion = "2.6.1"
+val geyserApiVersion = "2.6.2"
 
 repositories {
     // Repo for the Geyser API artifact
@@ -19,6 +21,7 @@ dependencies {
     compileOnly("org.geysermc.geyser:api:$geyserApiVersion-SNAPSHOT")
 
     // Include other dependencies here - e.g. configuration libraries.
+    implementation("org.spongepowered:configurate-yaml:4.2.0-GeyserMC-SNAPSHOT")
 }
 
 // Java currently requires Java 17 or higher, so extensions should also target it
@@ -53,4 +56,21 @@ tasks {
             )
         }
     }
+
+    build {
+        dependsOn(shadowJar)
+    }
+
+    jar {
+        archiveBaseName.set("DEV-PrioPacks")
+        archiveClassifier.set("unshaded")
+    }
+
+    shadowJar {
+        archiveClassifier.set("")
+        archiveVersion.set(version.toString())
+        relocate("org.spongepowered.configurate", "dev.onechris.extension.priopacks.relocate.configurate")
+        relocate("io.leangen.geantyref", "dev.onechris.extension.priopacks.relocate.geantyref")
+        relocate("com.typesafe.config", "dev.onechris.extension.priopacks.relocate.typesafe")
+    }
 }

build.gradle.kts

@@ -1,4 +1,4 @@
 version=1.0.0
-id=exampleid
-name=SomeExtension
-author=ExampleAuthor
+id=priopacks
+name=PrioPacks
+author=onechris

gradle.properties

@@ -0,0 +1,41 @@
+package dev.onechris.extension.priopacks;
+
+import lombok.Getter;
+import lombok.experimental.Accessors;
+import org.spongepowered.configurate.objectmapping.ConfigSerializable;
+import org.spongepowered.configurate.objectmapping.meta.Comment;
+
+import java.util.List;
+import java.util.UUID;
+
+@Getter
+@Accessors(fluent = true)
+@ConfigSerializable
+public class Config {
+
+    @Comment("""
+            The below list represents the resource pack stack. Each entry is a uuid of a loaded resource pack.
+            PrioPacks will then set priorities for each pack to ensure the order represented here!
+            Resource Packs higher in the stack will be applied first on the Bedrock client (e.g. overriding a texture change).
+            If this list contains uuids of resource packs that are not actually present, PrioPacks will gracefully skip over them.
+            """)
+    private List<UUID> packStack = List.of(
+            UUID.fromString("e5f5c938-a701-11eb-b2a3-047d7bb283ba"),
+            UUID.fromString("d9ee1211-b03e-43ec-b7f6-b7bcc7cf3fa4")
+    );
+
+    @Comment("""
+            The highest priority that PrioPacks will assign to the top resource pack in the stack above.
+            """)
+    private int highestPriority = 100;
+
+    @Comment("""
+            The lowest priority that PrioPacks will assign to the bottom resource pack in the stack.
+            """)
+    private int lowestPriority = -100;
+
+    @Comment("""
+            The config version. DO NOT CHANGE!
+            """)
+    private int version = 1;
+}

src/main/java/dev/onechris/extension/priopacks/Config.java

@@ -0,0 +1,55 @@
+package dev.onechris.extension.priopacks;
+
+import org.geysermc.geyser.api.extension.Extension;
+import org.spongepowered.configurate.CommentedConfigurationNode;
+import org.spongepowered.configurate.yaml.NodeStyle;
+import org.spongepowered.configurate.yaml.YamlConfigurationLoader;
+
+import java.io.IOException;
+import java.nio.file.Files;
+
+public class ConfigLoader {
+
+    private static final String HEADER = """
+        PrioPacks Configuration
+        
+        Source: https://github.com/onebeastchris/PrioPacks/
+        """;
+
+    public static Config loadConfig(Extension extension) throws IOException {
+        Files.createDirectories(extension.dataFolder());
+
+        final YamlConfigurationLoader loader = YamlConfigurationLoader.builder()
+                .path(extension.dataFolder().resolve("config.yml"))
+                .nodeStyle(NodeStyle.BLOCK)
+                .defaultOptions(configurationOptions -> configurationOptions.header(HEADER))
+                .build();
+
+        final CommentedConfigurationNode node = loader.load();
+
+        // Load the config with old values if available
+        Config config = node.get(Config.class);
+        if (config == null) {
+            throw new IllegalStateException("config is null!");
+        }
+
+        // Some validation
+        if (config.highestPriority() > 100) {
+            throw new IllegalStateException("Highest possible pack priority is 100!");
+        }
+
+        if (config.lowestPriority() < -100) {
+            throw new IllegalStateException("Lowest possible pack priority is 0!");
+        }
+
+        if (config.highestPriority() <= config.lowestPriority()) {
+            throw new IllegalStateException("Highest possible priority must be greater than lowest priority!");
+        }
+
+        CommentedConfigurationNode newNode = CommentedConfigurationNode.root(loader.defaultOptions());
+        newNode.set(Config.class, config);
+
+        loader.save(newNode);
+        return config;
+    }
+}

src/main/java/dev/onechris/extension/priopacks/ConfigLoader.java

@@ -0,0 +1,105 @@
+package dev.onechris.extension.priopacks;
+
+import org.geysermc.event.PostOrder;
+import org.geysermc.event.subscribe.Subscribe;
+import org.geysermc.geyser.api.command.Command;
+import org.geysermc.geyser.api.command.CommandSource;
+import org.geysermc.geyser.api.event.bedrock.SessionLoadResourcePacksEvent;
+import org.geysermc.geyser.api.event.lifecycle.GeyserDefineCommandsEvent;
+import org.geysermc.geyser.api.event.lifecycle.GeyserPreInitializeEvent;
+import org.geysermc.geyser.api.extension.Extension;
+import org.geysermc.geyser.api.pack.ResourcePack;
+import org.geysermc.geyser.api.pack.ResourcePackManifest;
+import org.geysermc.geyser.api.pack.exception.ResourcePackException;
+import org.geysermc.geyser.api.pack.option.PriorityOption;
+
+import java.util.List;
+import java.util.UUID;
+
+public class PrioPacks implements Extension {
+
+    private Config config;
+    private int step;
+    private List<ResourcePackManifest> manifests;
+
+    @Subscribe
+    public void onGeyserInit(GeyserPreInitializeEvent event) {
+        logger().info("Initializing PrioPacks...");
+        loadPacks();
+    }
+
+    @Subscribe
+    public void onRegisterCommands(GeyserDefineCommandsEvent event) {
+        event.register(Command.builder(this)
+                .name("reload")
+                .description("Reloads the PrioPacks config")
+                .permission("priopacks.reload")
+                .source(CommandSource.class)
+                .executor((source, command, args) -> {
+                    loadPacks();
+                    source.sendMessage("Finished reloading PrioPacks!");
+                })
+                .build());
+
+        event.register(Command.builder(this)
+                .name("debug")
+                .description("Lists the last loaded packs; making it easier to obtain pack uuid's")
+                .permission("priopacks.debug")
+                .source(CommandSource.class)
+                .executor((source, command, args) -> debug(source))
+                .build());
+    }
+
+    @Subscribe(postOrder = PostOrder.LATE)
+    public void onSessionLoadPacks(SessionLoadResourcePacksEvent event) {
+        List<UUID> order = config.packStack();
+
+        int currentPrio = config.highestPriority();
+        for (UUID uuid : order) {
+            try {
+                event.registerOptions(uuid, PriorityOption.priority(ensureInBounds(currentPrio)));
+                currentPrio = -step;
+            } catch (ResourcePackException e) {
+                logger().warning("Could not set priority for resource pack with uuid %s: Got error %s".formatted(uuid, e.getMessage()));
+            }
+        }
+
+        // For debug purposes
+        if (manifests == null) {
+            manifests = event.resourcePacks().stream().map(ResourcePack::manifest).toList();
+        }
+    }
+
+    private int ensureInBounds(int input) {
+        return Math.min(Math.max(-100, input), 100);
+    }
+
+    public void debug(CommandSource source) {
+        if (manifests == null) {
+            source.sendMessage("Cannot dump resource pack manifests as no Bedrock player joined yet!");
+            return;
+        }
+        source.sendMessage("Here are all the resource packs sent to the last Bedrock connection:");
+        for (ResourcePackManifest manifest : manifests) {
+            source.sendMessage(manifest.toString());
+        }
+    }
+
+    private void loadPacks() {
+        logger().info("Loading PrioPacks config!");
+        try {
+            config = ConfigLoader.loadConfig(this);
+        } catch (Exception e) {
+            logger().warning("Failed to load config! Error: " + e.getMessage());
+            this.disable();
+        }
+
+        manifests = null;
+        if (config.packStack().isEmpty()) {
+            step = 0;
+        } else {
+            step = (config.highestPriority() - config.lowestPriority()) / config.packStack().size();
+        }
+        logger().info("Enabled PrioPacks.");
+    }
+}