Implement sending remote resource packs to Bedrock clients

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

@@ -29,6 +29,7 @@
 import org.geysermc.geyser.api.connection.GeyserConnection;
 import org.geysermc.geyser.api.event.connection.ConnectionEvent;
 import org.geysermc.geyser.api.pack.ResourcePack;
+import org.geysermc.geyser.api.pack.ResourcePackCDNEntry;
 
 import java.util.List;
 import java.util.UUID;
@@ -48,6 +49,13 @@ public SessionLoadResourcePacksEvent(@NonNull GeyserConnection connection) {
      */
     public abstract @NonNull List<ResourcePack> resourcePacks();
 
+    /**
+     * Gets an unmodifiable list of {@link ResourcePackCDNEntry}s that will be sent to the client.
+     *
+     * @return an unmodifiable list of resource pack CDN entries that will be sent to the client.
+     */
+    public abstract @NonNull List<ResourcePackCDNEntry> cdnEntries();
+
     /**
      * Registers a {@link ResourcePack} to be sent to the client.
      *
@@ -58,10 +66,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 {@link ResourcePackCDNEntry} to be sent to the client.
+     *
+     * @param entry CDN entry that will be sent to the client to download a resource pack from.
+     */
+    public abstract boolean register(@NonNull ResourcePackCDNEntry entry);
+
+    /**
+     * Unregisters a {@link ResourcePack} or {@link ResourcePackCDNEntry} from being sent to the client.
      *
-     * @param uuid the UUID of the resource pack
-     * @return true whether the resource pack was removed from the list of resource packs.
+     * @param uuid the UUID of the resource pack/CDN entry to remove.
+     * @return true whether the resource pack/CDN entry 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,79 @@
+/*
+ * 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 org.geysermc.geyser.api.pack.ResourcePackCDNEntry;
+
+import java.util.List;
+import java.util.UUID;
+
+/**
+ * Called when {@link ResourcePack}'s and {@link ResourcePackCDNEntry}'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();
+
+    /**
+     * Gets an unmodifiable list of {@link ResourcePackCDNEntry}s that will be sent to clients.
+     *
+     * @return an unmodifiable list of resource pack CDN entries that will be sent to clients.
+     */
+    public abstract @NonNull List<ResourcePackCDNEntry> cdnEntries();
+
+    /**
+     * 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 {@link ResourcePackCDNEntry} to be sent to clients.
+     *
+     * @param entry CDN entry that will be sent to the client to download a resource pack from.
+     */
+    public abstract boolean register(@NonNull ResourcePackCDNEntry entry);
+
+    /**
+     * Unregisters a {@link ResourcePack} or {@link ResourcePackCDNEntry} from being sent to clients.
+     *
+     * @param uuid the UUID of the resource pack/CDN entry to remove.
+     * @return true whether the resource pack/CDN entry 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
  */
-public record GeyserLoadResourcePacksEvent(@NonNull List<Path> resourcePacks) implements Event {
+
+@Deprecated
+public record GeyserLoadResourcePacksEvent(@Deprecated @NonNull List<Path> resourcePacks) implements Event {
 }

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

@@ -0,0 +1,40 @@
+/*
+ * 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 java.util.UUID;
+
+/**
+ * Represents a CDN entry for a resource pack.
+ * The URL must be a direct download link to a Bedrock edition resource pack.
+ * The UUID must be the UUID of the resource pack.
+ *
+ * @param url URL from which the pack should be downloaded
+ * @param uuid UUID of the pack
+ */
+public record ResourcePackCDNEntry(String url, UUID uuid) {
+}
+

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

@@ -96,6 +96,8 @@ public interface GeyserConfiguration {
 
     boolean isForceResourcePacks();
 
+    List<String> getCdnResourcePacks();
+
     boolean isXboxAchievementsEnabled();
 
     int getCacheImages();

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

@@ -42,6 +42,7 @@
 
 import java.io.IOException;
 import java.nio.file.Path;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.UUID;
@@ -136,6 +137,9 @@ public abstract class GeyserJacksonConfiguration implements GeyserConfiguration
     @JsonProperty("force-resource-packs")
     private boolean forceResourcePacks = true;
 
+    @JsonProperty("cdn-resource-packs")
+    private List<String> cdnResourcePacks = new ArrayList<>();
+
     @JsonProperty("xbox-achievements-enabled")
     private boolean xboxAchievementsEnabled = false;
 

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

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

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

@@ -28,19 +28,24 @@
 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.api.pack.ResourcePackCDNEntry;
 import org.geysermc.geyser.session.GeyserSession;
 
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
 public class SessionLoadResourcePacksEventImpl extends SessionLoadResourcePacksEvent {
 
     private final Map<String, ResourcePack> packs;
+    private final Map<String, ResourcePackCDNEntry> cdnEntries;
 
-    public SessionLoadResourcePacksEventImpl(GeyserSession session, Map<String, ResourcePack> packMap) {
+    public SessionLoadResourcePacksEventImpl(GeyserSession session, Map<String, ResourcePack> packMap, List<ResourcePackCDNEntry> cdnEntries) {
         super(session);
         this.packs = packMap;
+        this.cdnEntries = new HashMap<>();
+        cdnEntries.forEach(entry -> this.cdnEntries.put(entry.uuid().toString(), entry));
     }
 
     public @NonNull Map<String, ResourcePack> getPacks() {
@@ -52,18 +57,39 @@ public SessionLoadResourcePacksEventImpl(GeyserSession session, Map<String, Reso
         return List.copyOf(packs.values());
     }
 
+    @Override
+    public @NonNull List<ResourcePackCDNEntry> cdnEntries() {
+        return List.copyOf(cdnEntries.values());
+    }
+
     @Override
     public boolean register(@NonNull ResourcePack resourcePack) {
         String packID = resourcePack.manifest().header().uuid().toString();
-        if (packs.containsValue(resourcePack) || packs.containsKey(packID)) {
+        if (packs.containsValue(resourcePack) || packs.containsKey(packID) || cdnEntries.containsKey(packID)) {
             return false;
         }
         packs.put(resourcePack.manifest().header().uuid().toString(), resourcePack);
         return true;
     }
 
+    @Override
+    public boolean register(@NonNull ResourcePackCDNEntry entry) {
+        String packID = entry.uuid().toString();
+        if (packs.containsKey(packID) || cdnEntries.containsKey(packID) || cdnEntries.containsValue(entry)) {
+            return false;
+        }
+        cdnEntries.put(packID, entry);
+        return true;
+    }
+
     @Override
     public boolean unregister(@NonNull UUID uuid) {
-        return packs.remove(uuid.toString()) != null;
+        if (packs.containsKey(uuid.toString())) {
+            return packs.remove(uuid.toString()) != null;
+        } else if (cdnEntries.containsKey(uuid.toString())) {
+            return cdnEntries.remove(uuid.toString()) != null;
+        } else {
+            return false;
+        }
     }
 }

core/src/main/java/org/geysermc/geyser/network/GameProtocol.java

@@ -93,6 +93,10 @@ public static boolean isPre1_20_10(GeyserSession session) {
         return session.getUpstream().getProtocolVersion() < Bedrock_v594.CODEC.getProtocolVersion();
     }
 
+    public static boolean isPre1_20_30(GeyserSession session) {
+        return session.getUpstream().getProtocolVersion() < Bedrock_v618.CODEC.getProtocolVersion();
+    }
+
     /**
      * Gets the {@link PacketCodec} for Minecraft: Java Edition.
      *