Implement sending remote resource packs to Bedrock clients

api/src/main/java/org/geysermc/geyser/api/event/bedrock/SessionLoadResourcePacksEvent.java

@@ -30,6 +30,7 @@
 import org.geysermc.geyser.api.event.connection.ConnectionEvent;
 import org.geysermc.geyser.api.pack.ResourcePack;
 
+import java.util.Collection;
 import java.util.List;
 import java.util.UUID;
 
@@ -42,7 +43,7 @@ public SessionLoadResourcePacksEvent(@NonNull GeyserConnection connection) {
     }
 
     /**
-     * Gets an unmodifiable list of {@link ResourcePack}s that will be sent to the client.
+     * Gets an unmodifiable list of {@link ResourcePack}'s that will be sent to the client.
      *
      * @return an unmodifiable list of resource packs that will be sent to the client.
      */
@@ -58,10 +59,17 @@ public SessionLoadResourcePacksEvent(@NonNull GeyserConnection connection) {
     public abstract boolean register(@NonNull ResourcePack resourcePack);
 
     /**
-     * Unregisters a resource pack from being sent to the client.
+     * Registers a collection of {@link ResourcePack}'s to be sent to clients.
      *
-     * @param uuid the UUID of the resource pack
-     * @return true whether the resource pack was removed from the list of resource packs.
+     * @param resourcePacks collection of resource pack's that will be sent to clients
+     */
+    public abstract void registerAll(@NonNull Collection<ResourcePack> resourcePacks);
+
+    /**
+     * Unregisters a {@link ResourcePack} from being sent to the client.
+     *
+     * @param uuid the UUID of the resource pack to remove.
+     * @return true whether the resource pack was removed successfully.
      */
     public abstract boolean unregister(@NonNull UUID uuid);
 }

api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserDefineResourcePacksEvent.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.api.event.lifecycle;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.geysermc.event.Event;
+import org.geysermc.geyser.api.pack.ResourcePack;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.UUID;
+
+/**
+ * Called when {@link ResourcePack}'s are loaded within Geyser.
+ */
+public abstract class GeyserDefineResourcePacksEvent implements Event {
+
+    /**
+     * Gets an unmodifiable list of {@link ResourcePack}'s that will be sent to clients.
+     *
+     * @return an unmodifiable list of resource packs that will be sent to clients.
+     */
+    public abstract @NonNull List<ResourcePack> resourcePacks();
+
+    /**
+     * Registers a {@link ResourcePack} to be sent to clients.
+     *
+     * @param resourcePack a resource pack that will be sent to clients.
+     * @return true if the resource pack was added successfully,
+     *         or false if already present
+     */
+    public abstract boolean register(@NonNull ResourcePack resourcePack);
+
+    /**
+     * Registers a collection of {@link ResourcePack}'s to be sent to clients.
+     *
+     * @param resourcePacks a collection of resource pack's that will be sent to clients.
+     */
+    public abstract void registerAll(@NonNull Collection<ResourcePack> resourcePacks);
+
+
+    /**
+     * Unregisters a {@link ResourcePack} from being sent to clients.
+     *
+     * @param uuid the UUID of the resource pack to remove.
+     * @return true whether the resource pack was removed successfully.
+     */
+    public abstract boolean unregister(@NonNull UUID uuid);
+}

api/src/main/java/org/geysermc/geyser/api/event/lifecycle/GeyserLoadResourcePacksEvent.java

@@ -33,8 +33,11 @@
 
 /**
  * Called when resource packs are loaded within Geyser.
+ * @deprecated Use {@link GeyserDefineResourcePacksEvent} instead.
  *
  * @param resourcePacks a mutable list of the currently listed resource packs
  */
+
+@Deprecated
 public record GeyserLoadResourcePacksEvent(@NonNull List<Path> resourcePacks) implements Event {
 }

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

@@ -26,6 +26,7 @@
 package org.geysermc.geyser.api.pack;
 
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.geysermc.geyser.api.GeyserApi;
 
 import java.io.IOException;
@@ -79,4 +80,27 @@ public abstract class PackCodec {
     public static PackCodec path(@NonNull Path path) {
         return GeyserApi.api().provider(PathPackCodec.class, path);
     }
+
+    /**
+     * Creates a new pack provider from the given url with no content key.
+     *
+     * @param url the url to create the pack provider from
+     * @return the new pack provider
+     */
+    @NonNull
+    public static PackCodec url(@NonNull String url) {
+        return url(url, null);
+    }
+
+    /**
+     * Creates a new pack provider from the given url and content key.
+     *
+     * @param url the url to create the pack provider from
+     * @param contentKey the content key, leave empty or null if pack is not encrypted
+     * @return the new pack provider
+     */
+    @NonNull
+    public static PackCodec url(@NonNull String url, @Nullable String contentKey) {
+        return GeyserApi.api().provider(UrlPackCodec.class, url, contentKey);
+    }
 }

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

@@ -0,0 +1,58 @@
+/*
+ * 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.api.pack;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+/**
+ * Represents a pack codec that creates a resource
+ * pack from a URL.
+ * <p>
+ * Due to Bedrock limitations, the URL must:
+ * <ul>
+ *     <li>be a direct download link to a .zip or .mcpack resource pack</li>
+ *     <li>use the application type `application/zip` and set a correct content length</li>
+ * </ul>
+ */
+public abstract class UrlPackCodec extends PackCodec {
+
+    /**
+     * Gets the URL to the resource pack location.
+     *
+     * @return the URL of the resource pack
+     */
+    @NonNull
+    public abstract String url();
+
+    /**
+     * If the remote pack has an encryption key, it must be specified here.
+     * This will return empty if none is specified.
+     *
+     * @return the encryption key of the resource pack
+     */
+    @NonNull
+    public abstract String contentKey();
+}

core/src/main/java/org/geysermc/geyser/GeyserImpl.java

@@ -73,6 +73,7 @@
 import org.geysermc.geyser.network.netty.GeyserServer;
 import org.geysermc.geyser.registry.BlockRegistries;
 import org.geysermc.geyser.registry.Registries;
+import org.geysermc.geyser.registry.loader.ResourcePackLoader;
 import org.geysermc.geyser.registry.provider.ProviderSupplier;
 import org.geysermc.geyser.scoreboard.ScoreboardUpdater;
 import org.geysermc.geyser.session.GeyserSession;
@@ -656,7 +657,7 @@ public void disable() {
             this.erosionUnixListener.close();
         }
 
-        Registries.RESOURCE_PACKS.get().clear();
+        ResourcePackLoader.clear();
 
         this.setEnabled(false);
     }

core/src/main/java/org/geysermc/geyser/configuration/GeyserConfiguration.java

@@ -96,6 +96,8 @@ public interface GeyserConfiguration {
 
     boolean isForceResourcePacks();
 
+    List<String> getResourcePackUrls();
+
     @SuppressWarnings("BooleanMethodIsAlwaysInverted")
     boolean isXboxAchievementsEnabled();
 

core/src/main/java/org/geysermc/geyser/configuration/GeyserJacksonConfiguration.java

@@ -136,6 +136,9 @@ public abstract class GeyserJacksonConfiguration implements GeyserConfiguration
     @JsonProperty("force-resource-packs")
     private boolean forceResourcePacks = true;
 
+    @JsonProperty("resource-pack-urls")
+    private List<String> resourcePackUrls = new ArrayList<>();
+
     @JsonProperty("xbox-achievements-enabled")
     private boolean xboxAchievementsEnabled = false;
 

core/src/main/java/org/geysermc/geyser/event/type/GeyserDefineResourcePacksEventImpl.java

@@ -0,0 +1,71 @@
+/*
+ * 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.event.type;
+
+import lombok.Getter;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.geysermc.geyser.api.event.lifecycle.GeyserDefineResourcePacksEvent;
+import org.geysermc.geyser.api.pack.ResourcePack;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
+
+@Getter
+public class GeyserDefineResourcePacksEventImpl extends GeyserDefineResourcePacksEvent {
+
+    private final Map<String, ResourcePack> packs;
+
+    public GeyserDefineResourcePacksEventImpl(Map<String, ResourcePack> packMap) {
+        this.packs = packMap;
+    }
+
+    @Override
+    public @NonNull List<ResourcePack> resourcePacks() {
+        return List.copyOf(packs.values());
+    }
+
+    @Override
+    public boolean register(@NonNull ResourcePack resourcePack) {
+        String packID = resourcePack.manifest().header().uuid().toString();
+        if (packs.containsValue(resourcePack) || packs.containsKey(packID)) {
+            return false;
+        }
+        packs.put(resourcePack.manifest().header().uuid().toString(), resourcePack);
+        return true;
+    }
+
+    @Override
+    public void registerAll(@NonNull Collection<ResourcePack> resourcePacks) {
+        resourcePacks.forEach(this::register);
+    }
+
+    @Override
+    public boolean unregister(@NonNull UUID uuid) {
+        return packs.remove(uuid.toString()) != null;
+    }
+}

core/src/main/java/org/geysermc/geyser/event/type/SessionLoadResourcePacksEventImpl.java

@@ -25,28 +25,26 @@
 
 package org.geysermc.geyser.event.type;
 
+import lombok.Getter;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.geysermc.geyser.api.event.bedrock.SessionLoadResourcePacksEvent;
 import org.geysermc.geyser.api.pack.ResourcePack;
 import org.geysermc.geyser.session.GeyserSession;
 
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
 public class SessionLoadResourcePacksEventImpl extends SessionLoadResourcePacksEvent {
 
+    @Getter
     private final Map<String, ResourcePack> packs;
 
     public SessionLoadResourcePacksEventImpl(GeyserSession session, Map<String, ResourcePack> packMap) {
         super(session);
         this.packs = packMap;
     }
-
-    public @NonNull Map<String, ResourcePack> getPacks() {
-        return packs;
-    }
-
     @Override
     public @NonNull List<ResourcePack> resourcePacks() {
         return List.copyOf(packs.values());
@@ -62,6 +60,11 @@ public boolean register(@NonNull ResourcePack resourcePack) {
         return true;
     }
 
+    @Override
+    public void registerAll(@NonNull Collection<ResourcePack> resourcePacks) {
+        resourcePacks.forEach(this::register);
+    }
+
     @Override
     public boolean unregister(@NonNull UUID uuid) {
         return packs.remove(uuid.toString()) != null;