Preferences system and api

api/src/main/java/org/geysermc/geyser/api/connection/GeyserConnection.java

@@ -33,7 +33,10 @@
 import org.geysermc.geyser.api.command.CommandSource;
 import org.geysermc.geyser.api.entity.type.GeyserEntity;
 import org.geysermc.geyser.api.entity.type.player.GeyserPlayerEntity;
+import org.geysermc.geyser.api.preference.Preference;
+import org.geysermc.geyser.api.preference.PreferenceKey;
 
+import java.util.Optional;
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 
@@ -95,4 +98,12 @@ public interface GeyserConnection extends Connection, CommandSource {
      */
     @NonNull
     Set<String> fogEffects();
+
+    <T> void storePreference(@NonNull PreferenceKey<T> key, @NonNull Preference<T> preference);
+
+    @NonNull
+    <T> Preference<T> requirePreference(@NonNull PreferenceKey<T> key) throws IllegalArgumentException;
+
+    @NonNull
+    <T> Optional<Preference<T>> getPreference(@NonNull PreferenceKey<T> key);
 }

api/src/main/java/org/geysermc/geyser/api/preference/BooleanPreference.java

@@ -0,0 +1,43 @@
+/*
+ * 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.preference;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+public abstract class BooleanPreference extends Preference<Boolean> {
+
+    public BooleanPreference(@NonNull Boolean initialValue) {
+        super(initialValue);
+    }
+
+    @Override
+    public void onFormResponse(@NonNull Object response) {
+        if (response instanceof Boolean booleanValue) {
+            update(booleanValue);
+        }
+        throw new IllegalArgumentException(response + " is not a boolean");
+    }
+}

api/src/main/java/org/geysermc/geyser/api/preference/FloatPreference.java

@@ -0,0 +1,43 @@
+/*
+ * 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.preference;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+public abstract class FloatPreference extends Preference<Float> {
+
+    public FloatPreference(@NonNull Float initialValue) {
+        super(initialValue);
+    }
+
+    @Override
+    public void onFormResponse(@NonNull Object response) throws IllegalArgumentException {
+        if (response instanceof Float floatValue) {
+            update(floatValue);
+        }
+        throw new IllegalArgumentException(response + " is not a float");
+    }
+}

api/src/main/java/org/geysermc/geyser/api/preference/IntegerPreference.java

@@ -0,0 +1,43 @@
+/*
+ * 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.preference;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+public abstract class IntegerPreference extends Preference<Integer> {
+
+    public IntegerPreference(@NonNull Integer initialValue) {
+        super(initialValue);
+    }
+
+    @Override
+    public void onFormResponse(@NonNull Object response) throws IllegalArgumentException {
+        if (response instanceof Integer integerValue) {
+            update(integerValue);
+        }
+        throw new IllegalArgumentException(response + " is not an integer");
+    }
+}

api/src/main/java/org/geysermc/geyser/api/preference/Preference.java

@@ -0,0 +1,61 @@
+/*
+ * 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.preference;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.geysermc.cumulus.component.Component;
+import org.geysermc.geyser.api.connection.GeyserConnection;
+
+import java.util.Objects;
+
+public abstract class Preference<T> {
+
+    @NonNull
+    private T value;
+
+    public Preference(@NonNull T initialValue) {
+        this.value = Objects.requireNonNull(initialValue, "initialValue");
+    }
+
+    @NonNull
+    public final T value() {
+        return value;
+    }
+
+    public final void update(@NonNull T newValue) {
+        this.value = Objects.requireNonNull(newValue, "newValue");
+    }
+
+    public abstract boolean isModifiable(GeyserConnection connection);
+
+    public abstract Component component(GeyserConnection connection);
+
+    public abstract void onFormResponse(@NonNull Object response) throws IllegalArgumentException;
+
+    public void onUpdate(GeyserConnection connection) {
+        // no-op by default
+    }
+}

api/src/main/java/org/geysermc/geyser/api/preference/PreferenceKey.java

@@ -0,0 +1,29 @@
+/*
+ * 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.preference;
+
+public record PreferenceKey<T>(String key) {
+}

api/src/main/java/org/geysermc/geyser/api/preference/StringPreference.java

@@ -0,0 +1,43 @@
+/*
+ * 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.preference;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+
+public abstract class StringPreference extends Preference<String> {
+
+    public StringPreference(@NonNull String initialValue) {
+        super(initialValue);
+    }
+
+    @Override
+    public void onFormResponse(@NonNull Object response) throws IllegalArgumentException {
+        if (response instanceof String stringValue) {
+            update(stringValue);
+        }
+        throw new IllegalArgumentException(response + " is not a string");
+    }
+}

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

@@ -0,0 +1,74 @@
+/*
+ * 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.configuration;
+
+import com.fasterxml.jackson.core.JacksonException;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+import java.io.IOException;
+
+@Getter
+@AllArgsConstructor
+public enum CooldownType {
+    TITLE("options.attack.crosshair"),
+    ACTIONBAR("options.attack.hotbar"),
+    DISABLED("options.off");
+
+    public static final String OPTION_DESCRIPTION = "options.attackIndicator";
+    public static final CooldownType[] VALUES = values();
+
+    private final String translation;
+
+    /**
+     * Convert the CooldownType string (from config) to the enum, DISABLED on fail
+     *
+     * @param name CooldownType string
+     * @return The converted CooldownType
+     */
+    public static CooldownType getByName(String name) {
+        if (name.equalsIgnoreCase("true")) { // Backwards config compatibility
+            return CooldownType.TITLE;
+        }
+
+        for (CooldownType type : VALUES) {
+            if (type.name().equalsIgnoreCase(name)) {
+                return type;
+            }
+        }
+        return DISABLED;
+    }
+
+    public static class Deserializer extends JsonDeserializer<CooldownType> {
+        @Override
+        public CooldownType deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JacksonException {
+            return CooldownType.getByName(p.getValueAsString());
+        }
+    }
+}

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

@@ -82,7 +82,7 @@ public interface GeyserConfiguration {
 
     boolean isAllowThirdPartyEars();
 
-    String getShowCooldown();
+    CooldownType getShowCooldown();
 
     boolean isShowCoordinates();
 

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

@@ -99,8 +99,9 @@ public abstract class GeyserJacksonConfiguration implements GeyserConfiguration
     @JsonProperty("allow-third-party-capes")
     private boolean allowThirdPartyCapes = true;
 
+    @JsonDeserialize(using = CooldownType.Deserializer.class)
     @JsonProperty("show-cooldown")
-    private String showCooldown = "title";
+    private CooldownType showCooldown = CooldownType.TITLE;
 
     @JsonProperty("show-coordinates")
     private boolean showCoordinates = true;