feat: GUI management

build.gradle.kts

@@ -1,3 +1,4 @@
+import io.gitlab.arturbosch.detekt.Detekt
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
@@ -130,6 +131,16 @@ tasks {
         targetCompatibility = javaVersionString
     }
 
+    withType<Detekt>().configureEach {
+        reports {
+            html.required.set(true)
+            xml.required.set(true)
+            txt.required.set(false)
+            sarif.required.set(false)
+            md.required.set(false)
+        }
+    }
+
     test {
         useJUnitPlatform()
     }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.3-rc-1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/kotlin/com/github/rushyverse/api/APIPlugin.kt

@@ -2,6 +2,7 @@ package com.github.rushyverse.api
 
 import com.github.rushyverse.api.extension.registerListener
 import com.github.rushyverse.api.game.SharedGameData
+import com.github.rushyverse.api.gui.GUIManager
 import com.github.rushyverse.api.koin.CraftContext
 import com.github.rushyverse.api.koin.loadModule
 import com.github.rushyverse.api.listener.api.LanguageListener
@@ -37,6 +38,7 @@ public class APIPlugin : JavaPlugin() {
             single { ScoreboardManager() }
             single { LanguageManager() }
             single { SharedGameData() }
+            single { GUIManager() }
         }
 
         registerListener { LanguageListener() }

src/main/kotlin/com/github/rushyverse/api/Plugin.kt

@@ -7,6 +7,7 @@ import com.github.rushyverse.api.configuration.reader.IFileReader
 import com.github.rushyverse.api.configuration.reader.YamlFileReader
 import com.github.rushyverse.api.extension.asComponent
 import com.github.rushyverse.api.extension.registerListener
+import com.github.rushyverse.api.gui.GUIListener
 import com.github.rushyverse.api.koin.CraftContext
 import com.github.rushyverse.api.koin.inject
 import com.github.rushyverse.api.koin.loadModule
@@ -16,11 +17,21 @@ import com.github.rushyverse.api.player.Client
 import com.github.rushyverse.api.player.ClientManager
 import com.github.rushyverse.api.player.ClientManagerImpl
 import com.github.rushyverse.api.player.language.LanguageManager
-import com.github.rushyverse.api.serializer.*
+import com.github.rushyverse.api.serializer.ComponentSerializer
+import com.github.rushyverse.api.serializer.DyeColorSerializer
+import com.github.rushyverse.api.serializer.EnchantmentSerializer
+import com.github.rushyverse.api.serializer.ItemStackSerializer
+import com.github.rushyverse.api.serializer.LocationSerializer
+import com.github.rushyverse.api.serializer.MaterialSerializer
+import com.github.rushyverse.api.serializer.NamespacedSerializer
+import com.github.rushyverse.api.serializer.PatternSerializer
+import com.github.rushyverse.api.serializer.PatternTypeSerializer
+import com.github.rushyverse.api.serializer.RangeDoubleSerializer
 import com.github.rushyverse.api.translation.ResourceBundleTranslator
 import com.github.rushyverse.api.translation.Translator
 import com.github.rushyverse.api.translation.registerResourceBundleForSupportedLocales
 import com.github.shynixn.mccoroutine.bukkit.SuspendingJavaPlugin
+import java.util.*
 import kotlinx.serialization.modules.SerializersModule
 import kotlinx.serialization.modules.SerializersModuleBuilder
 import kotlinx.serialization.modules.contextual
@@ -29,7 +40,6 @@ import org.bukkit.entity.Player
 import org.jetbrains.annotations.Blocking
 import org.koin.core.module.Module
 import org.koin.dsl.bind
-import java.util.*
 
 /**
  * Represents the base functionality required to create a plugin.
@@ -70,6 +80,7 @@ public abstract class Plugin(
 
         registerListener { PlayerListener(this) }
         registerListener { VillagerListener(this) }
+        registerListener { GUIListener(this) }
     }
 
     /**

src/main/kotlin/com/github/rushyverse/api/extension/_String.kt

@@ -3,14 +3,14 @@
 
 package com.github.rushyverse.api.extension
 
+import java.math.BigInteger
+import java.util.*
 import net.kyori.adventure.text.Component
 import net.kyori.adventure.text.TextComponent
 import net.kyori.adventure.text.format.NamedTextColor
 import net.kyori.adventure.text.minimessage.MiniMessage
 import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver
 import net.kyori.adventure.text.minimessage.tag.standard.StandardTags
-import java.math.BigInteger
-import java.util.*
 
 /**
  * MiniMessage instance to deserialize components without strict mode.

src/main/kotlin/com/github/rushyverse/api/extension/event/_Event.kt

@@ -1,7 +1,16 @@
 package com.github.rushyverse.api.extension.event
 
+import com.github.shynixn.mccoroutine.bukkit.callSuspendingEvent
+import kotlinx.coroutines.joinAll
+import org.bukkit.Bukkit
+import org.bukkit.block.BlockFace
 import org.bukkit.entity.Damageable
+import org.bukkit.entity.Player
+import org.bukkit.event.block.Action
 import org.bukkit.event.entity.EntityDamageEvent
+import org.bukkit.event.player.PlayerInteractEvent
+import org.bukkit.inventory.ItemStack
+import org.bukkit.plugin.Plugin
 
 /**
  * Future life of the damaged entity.
@@ -15,3 +24,31 @@ public fun EntityDamageEvent.finalDamagedHealth(): Double? {
         null
     }
 }
+
+/**
+ * Create a [PlayerInteractEvent] to simulate a right click with an item for a player and call it.
+ * @param plugin Plugin to call the event.
+ * @param player Player who clicked.
+ * @param item Item that was clicked.
+ */
+public suspend fun callRightClickOnItemEvent(plugin: Plugin, player: Player, item: ItemStack) {
+    val rightClickWithItemEvent = createRightClickEventWithItem(player, item)
+    Bukkit.getPluginManager().callSuspendingEvent(rightClickWithItemEvent, plugin).joinAll()
+}
+
+/**
+ * Create a PlayerInteractEvent to simulate a right click with an item.
+ * @param player Player who clicked.
+ * @param item Item that was clicked.
+ * @return The new event.
+ */
+private fun createRightClickEventWithItem(
+    player: Player,
+    item: ItemStack
+) = PlayerInteractEvent(
+    player,
+    Action.RIGHT_CLICK_AIR,
+    item,
+    null,
+    BlockFace.NORTH // random value not null
+)

src/main/kotlin/com/github/rushyverse/api/game/GameData.kt

@@ -13,4 +13,5 @@ public data class GameData(
     val id: Int,
     var players: Int = 0,
     var state: GameState = GameState.WAITING,
+    val permanent: Boolean = false
 )

src/main/kotlin/com/github/rushyverse/api/game/GameState.kt

@@ -1,33 +1,40 @@
 package com.github.rushyverse.api.game
 
+import net.kyori.adventure.text.format.NamedTextColor
+
 /**
  * Represents the various states a game can be in at any given moment.
  * Each state corresponds to a different phase in the game's lifecycle.
  */
-public enum class GameState {
+public enum class GameState(
+    public val color: NamedTextColor,
+    public val miniColor: String,
+) {
+
+    NOT_STARTED(NamedTextColor.BLUE, "<blue>"),
 
     /**
      * Represents the state where the game is waiting for necessary conditions to start.
      * This could be waiting for more players to join, or waiting for some setup process to finish.
      */
-    WAITING,
+    WAITING(NamedTextColor.GOLD, "<gold>"),
 
     /**
      * Represents the state when the game is in the process of starting.
      * This is a transitional phase, initialization of game resources,
      * a countdown timer before the game starts, etc.
      */
-    STARTING,
+    STARTING(NamedTextColor.YELLOW, "<yellow>"),
 
     /**
      * Represents the state where the game has officially started.
      * Gameplay is active during this state.
      */
-    STARTED,
+    STARTED(NamedTextColor.GREEN, "<green>"),
 
     /**
      * Represents the state when the game is in the process of ending.
      * This is a transitional phase, where final scores might be calculated, game resources might be cleaned up, etc.
      */
-    ENDING;
+    ENDED(NamedTextColor.RED, "<red>");
 }