Merge branch 'master' into feature/combat

Author: Avanatiker

.github/CONTRIBUTING.md

@@ -103,18 +103,7 @@ First of all, make sure to read or simply check the [Official Kotlin Coding Conv
 
 This is required for pull requests to be accepted, or even reviewed.
 
-You will need the following before contributing:
-- GitHub CLI / Desktop
-- IntelliJ IDEA
-- Java 17 SDK
-- [Minecraft Development Plugin](https://plugins.jetbrains.com/plugin/8327-minecraft-development)
-
-After you have everything you can do the following:
-- Clone the repository `git clone https://github.com/lambda-client/lambda`
-- Open the project, **inside the project folder**, in IntelliJ IDEA
-- Set the java runtime in `File > Project Structure > SDK > JDK 17`
-- Wait for Gradle to resolve dependencies and to set up the project.
-- And you should now be able to run the project using the [run configurations](https://www.jetbrains.com/help/idea/run-debug-configuration.html)
+After this, you can read the [getting started](https://github.com/lambda-client/wiki/Getting-Started) section in the wiki
 
 ### Improving The Documentation
 If you believe that some documentation can be improved or added, please discuss with us on our [Discord](https://discord.gg/QjfBxJzE5x)

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,22 +1,35 @@
 # Pull Request Guidelines
+
 ### This is a template, modify before submitting your PR
 
 Please ensure that your PR title follows this format:
-- `[Minecraft Version] [Mod loader] Feat, Fix, Ref, Docs, ..., : Description`
+- `[Minecraft Version] <Mod loader> Feat, Fix, Ref, Docs, ..., : Description`
 
 **Examples:**
-- `[1.20.x] [Forge] Feat: Add new block types`
-- `[1.19.x] [All] Fix: Crash on startup`
-- `[1.20.x] [Fabric] Refactor: Optimize rendering engine`
+- `[1.20.4] Feat: Add new block types`
+- `[1.21.4] [All] Fix: Crash on startup`
+- `[1.21.3] [Forge] Fix: GUI does not render`
+- `[1.20.1] Ref: Optimize rendering engine`
 
-# Issue Link
-Please create an issue if there are none applicable before submitting this pull request. 
+### Issue Link
+If your PR addresses one or more issues, be sure to link them. Use appropriate keywords like `closes`, `fixes`, or `resolves` to automatically close the linked issues when the PR is merged.
 
-Then link the issue as follows:`Closes #123`
+#### **Examples:**
+- `This PR fixes a memory leak in foo() and closes #4. It also resolves #5, which is a duplicate issue.`
+- `Closes #1, resolves #2, and fixes #3`
+- `Fixes #1`
 
-# Description
+### Description
+Provide a concise yet detailed summary of the changes introduced in this PR. Include the purpose of the changes and any relevant context.
 
-Provide a brief description of the changes made in this PR:
+#### **Examples:**
+- `This pull request improves compatibility with version 1.21.4 by addressing rendering issues and adding support for new block types.`
+- `Refactors the rendering engine to enhance performance and reduce memory usage.`
+- `Adds a new feature for biome-specific block spawning to align with gameplay mechanics introduced in version 1.20.4.`
 
-- **What does this PR do?**
-- **Why is this change needed?**
+### Checklist Before Submitting
+To ensure the quality and maintainability of your PR, confirm the following before submission:
+1. Code adheres to the project's style guide and conventions.
+2. All tests pass, including newly added tests.
+3. Documentation has been updated to reflect any new features or changes.
+4. Your PR is limited to a single purpose, avoiding unrelated changes.

common/src/main/kotlin/com/lambda/config/AbstractSetting.kt

@@ -127,4 +127,7 @@ abstract class AbstractSetting<T : Any>(
     class ValueListener<T>(val requiresValueChange: Boolean, val execute: (from: T, to: T) -> Unit)
 
     override fun toString() = "Setting $name: $value of type ${type.typeName}"
+
+    override fun equals(other: Any?) = other is AbstractSetting<*> && name == other.name
+    override fun hashCode() = name.hashCode()
 }

common/src/main/kotlin/com/lambda/config/Configurable.kt

@@ -55,10 +55,15 @@ abstract class Configurable(
     val settings = mutableSetOf<AbstractSetting<*>>()
 
     init {
-        register()
+        registerConfigurable()
     }
 
-    private fun register() = configuration.configurables.add(this)
+    private fun registerConfigurable() = configuration.configurables.add(this)
+
+    inline fun <reified T : AbstractSetting<*>> T.register(): T {
+        check(settings.add(this)) { "Setting with name $name already exists for configurable: ${this@Configurable.name}" }
+        return this
+    }
 
     override fun toJson() =
         JsonObject().apply {
@@ -99,9 +104,7 @@ abstract class Configurable(
         defaultValue: Boolean,
         description: String = "",
         visibility: () -> Boolean = { true },
-    ) = BooleanSetting(name, defaultValue, description, visibility).also {
-        settings.add(it)
-    }
+    ) = BooleanSetting(name, defaultValue, description, visibility).register()
 
     /**
      * Creates an [EnumSetting] with the provided parameters and adds it to the [settings].
@@ -124,9 +127,7 @@ abstract class Configurable(
         defaultValue: T,
         description: String = "",
         noinline visibility: () -> Boolean = { true },
-    ) = EnumSetting(name, defaultValue, description, visibility).also {
-        settings.add(it)
-    }
+    ) = EnumSetting(name, defaultValue, description, visibility).register()
 
     /**
      * Creates a [CharSetting] with the provided parameters and adds it to the [settings].
@@ -143,9 +144,7 @@ abstract class Configurable(
         defaultValue: Char,
         description: String = "",
         visibility: () -> Boolean = { true },
-    ) = CharSetting(name, defaultValue, description, visibility).also {
-        settings.add(it)
-    }
+    ) = CharSetting(name, defaultValue, description, visibility).register()
 
     /**
      * Creates a [StringSetting] with the provided parameters and adds it to the [settings].
@@ -166,9 +165,7 @@ abstract class Configurable(
         defaultValue: String,
         description: String = "",
         visibility: () -> Boolean = { true },
-    ) = StringSetting(name, defaultValue, description, visibility).also {
-        settings.add(it)
-    }
+    ) = StringSetting(name, defaultValue, description, visibility).register()
 
     /**
      * Constructs a [ListSetting] instance with the specified parameters and appends it to the [settings] collection.
@@ -193,17 +190,13 @@ abstract class Configurable(
         defaultValue: List<T>,
         description: String = "",
         noinline visibility: () -> Boolean = { true },
-        hackDelegates: Boolean = false,
     ) = ListSetting(
         name,
         defaultValue.toMutableList(),
         TypeToken.getParameterized(MutableList::class.java, T::class.java).type,
         description,
-        hackDelegates,
         visibility,
-    ).also {
-        settings.add(it)
-    }
+    ).register()
 
     /**
      * Constructs a [MapSetting] instance with the specified parameters and appends it to the [settings] collection.
@@ -227,18 +220,14 @@ abstract class Configurable(
         name: String,
         defaultValue: Map<K, V>,
         description: String = "",
-        hackDelegates: Boolean,
         noinline visibility: () -> Boolean = { true },
     ) = MapSetting(
         name,
         defaultValue.toMutableMap(),
         TypeToken.getParameterized(MutableMap::class.java, K::class.java, V::class.java).type,
         description,
-        hackDelegates,
         visibility
-    ).also {
-        settings.add(it)
-    }
+    ).register()
 
     /**
      * Constructs a [SetSetting] instance with the specified parameters and appends it to the [settings] collection.
@@ -268,36 +257,7 @@ abstract class Configurable(
         TypeToken.getParameterized(MutableSet::class.java, T::class.java).type,
         description,
         visibility,
-    ).also {
-        settings.add(it)
-    }
-
-    /**
-     * Creates a [ByteSetting] with the provided parameters and adds it to the [settings].
-     *
-     * The value of the setting is coerced into the specified [range] and rounded to the nearest [step].
-     *
-     * @param name The unique identifier for the setting.
-     * @param defaultValue The default [Byte] value of the setting.
-     * @param range The range within which the setting's value must fall.
-     * @param step The step to which the setting's value is rounded.
-     * @param description A brief explanation of the setting's purpose and behavior.
-     * @param visibility A lambda expression that determines the visibility status of the setting.
-     * @param unit The unit of the setting. E.g. "°C", "m/s", "ms", "ticks", etc.
-     *
-     * @return The created [ByteSetting].
-     */
-    fun setting(
-        name: String,
-        defaultValue: Byte,
-        range: ClosedRange<Byte>,
-        step: Byte = 1,
-        description: String = "",
-        unit: String = "",
-        visibility: () -> Boolean = { true },
-    ) = ByteSetting(name, defaultValue, range, step, description, visibility, unit).also {
-        settings.add(it)
-    }
+    ).register()
 
     /**
      * Creates a [DoubleSetting] with the provided parameters and adds it to the [settings].
@@ -322,9 +282,7 @@ abstract class Configurable(
         description: String = "",
         unit: String = "",
         visibility: () -> Boolean = { true },
-    ) = DoubleSetting(name, defaultValue, range, step, description, visibility, unit).also {
-        settings.add(it)
-    }
+    ) = DoubleSetting(name, defaultValue, range, step, description, visibility, unit).register()
 
     /**
      * Creates a [FloatSetting] with the provided parameters and adds it to the [settings].
@@ -349,9 +307,7 @@ abstract class Configurable(
         description: String = "",
         unit: String = "",
         visibility: () -> Boolean = { true },
-    ) = FloatSetting(name, defaultValue, range, step, description, visibility, unit).also {
-        settings.add(it)
-    }
+    ) = FloatSetting(name, defaultValue, range, step, description, visibility, unit).register()
 
     /**
      * Creates an [IntegerSetting] with the provided parameters and adds it to the [settings].
@@ -376,9 +332,7 @@ abstract class Configurable(
         description: String = "",
         unit: String = "",
         visibility: () -> Boolean = { true },
-    ) = IntegerSetting(name, defaultValue, range, step, description, visibility, unit).also {
-        settings.add(it)
-    }
+    ) = IntegerSetting(name, defaultValue, range, step, description, visibility, unit).register()
 
     /**
      * Creates a [LongSetting] with the provided parameters and adds it to the [settings].
@@ -403,36 +357,7 @@ abstract class Configurable(
         description: String = "",
         unit: String = "",
         visibility: () -> Boolean = { true },
-    ) = LongSetting(name, defaultValue, range, step, description, visibility, unit).also {
-        settings.add(it)
-    }
-
-    /**
-     * Creates a [ShortSetting] with the provided parameters and adds it to the [settings].
-     *
-     * The value of the setting is coerced into the specified [range] and rounded to the nearest [step].
-     *
-     * @param name The unique identifier for the setting.
-     * @param defaultValue The default [Short] value of the setting.
-     * @param range The range within which the setting's value must fall.
-     * @param step The step to which the setting's value is rounded.
-     * @param description A brief explanation of the setting's purpose and behavior.
-     * @param visibility A lambda expression that determines the visibility status of the setting.
-     * @param unit The unit of the setting. E.g. "°C", "m/s", "ms", "ticks", etc.
-     *
-     * @return The created [ShortSetting].
-     */
-    fun setting(
-        name: String,
-        defaultValue: Short,
-        range: ClosedRange<Short>,
-        step: Short = 1,
-        description: String = "",
-        unit: String = "",
-        visibility: () -> Boolean = { true },
-    ) = ShortSetting(name, defaultValue, range, step, description, visibility, unit).also {
-        settings.add(it)
-    }
+    ) = LongSetting(name, defaultValue, range, step, description, visibility, unit).register()
 
     /**
      * Creates a [KeyBindSetting] with the provided parameters and adds it to the [settings].
@@ -449,9 +374,7 @@ abstract class Configurable(
         defaultValue: KeyCode,
         description: String = "",
         visibility: () -> Boolean = { true },
-    ) = KeyBindSetting(name, defaultValue, description, visibility).also {
-        settings.add(it)
-    }
+    ) = KeyBindSetting(name, defaultValue, description, visibility).register()
 
     /**
      * Creates a [ColorSetting] with the provided parameters and adds it to the [settings].
@@ -468,9 +391,7 @@ abstract class Configurable(
         defaultValue: Color,
         description: String = "",
         visibility: () -> Boolean = { true },
-    ) = ColorSetting(name, defaultValue, description, visibility).also {
-        settings.add(it)
-    }
+    ) = ColorSetting(name, defaultValue, description, visibility).register()
 
     /**
      * Creates a [BlockPosSetting] with the provided parameters and adds it to the [settings].
@@ -487,9 +408,7 @@ abstract class Configurable(
         defaultValue: BlockPos,
         description: String = "",
         visibility: () -> Boolean = { true },
-    ) = BlockPosSetting(name, defaultValue, description, visibility).also {
-        settings.add(it)
-    }
+    ) = BlockPosSetting(name, defaultValue, description, visibility).register()
 
     /**
      * Creates a [BlockSetting] with the provided parameters and adds it to the [settings].
@@ -506,7 +425,5 @@ abstract class Configurable(
         defaultValue: Block,
         description: String = "",
         visibility: () -> Boolean = { true },
-    ) = BlockSetting(name, defaultValue, description, visibility).also {
-        settings.add(it)
-    }
+    ) = BlockSetting(name, defaultValue, description, visibility).register()
 }

common/src/main/kotlin/com/lambda/config/settings/collections/ListSetting.kt

@@ -17,8 +17,6 @@
 
 package com.lambda.config.settings.collections
 
-import com.google.gson.JsonElement
-import com.lambda.Lambda.gson
 import com.lambda.config.AbstractSetting
 import java.lang.reflect.Type
 
@@ -27,26 +25,13 @@ import java.lang.reflect.Type
  */
 class ListSetting<T : Any>(
     override val name: String,
-    private val defaultValue: MutableList<T>,
+    defaultValue: MutableList<T>,
     type: Type,
     description: String,
-    private val hackDelegates: Boolean,
     visibility: () -> Boolean,
 ) : AbstractSetting<MutableList<T>>(
     defaultValue,
     type,
     description,
     visibility
-) {
-    override fun toJson(): JsonElement {
-        return if (hackDelegates) gson.toJsonTree(defaultValue, type)
-        else super.toJson()
-    }
-
-    override fun loadFromJson(serialized: JsonElement) {
-        if (hackDelegates) {
-            defaultValue.addAll(gson.fromJson(serialized, type))
-            setValue(this, ::value, defaultValue.distinct().toMutableList())
-        } else super.loadFromJson(serialized)
-    }
-}
+)