Merge pull request #116 from DockyardMC/feature/list-command

LukynkaCZE · web-flow · commit 2ac460fbce19 · 2025-03-17T19:52:00.000+01:00
Rewrite some commands to match vanilla and add /list
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -52,7 +52,7 @@ dependencies {
     // Minecraft
     api("io.github.jglrxavpok.hephaistos:common:2.2.0")
     api("io.github.jglrxavpok.hephaistos:gson:2.2.0")
-    api("io.github.dockyardmc:scroll:2.7")
+    api("io.github.dockyardmc:scroll:2.8")
     implementation("io.github.dockyardmc:wikivg-datagen:1.3")
 
     // Pathfinding
diff --git a/src/main/kotlin/io/github/dockyardmc/DockyardServer.kt b/src/main/kotlin/io/github/dockyardmc/DockyardServer.kt
@@ -8,7 +8,7 @@ import io.github.dockyardmc.events.Events
 import io.github.dockyardmc.events.ServerFinishLoadEvent
 import io.github.dockyardmc.events.WorldFinishLoadingEvent
 import io.github.dockyardmc.implementations.block.DefaultBlockHandlers
-import io.github.dockyardmc.implementations.commands.DockyardCommands
+import io.github.dockyardmc.implementations.commands.DefaultCommands
 import io.github.dockyardmc.npc.NpcCommand
 import io.github.dockyardmc.protocol.NetworkCompression
 import io.github.dockyardmc.protocol.packets.registry.ClientPacketRegistry
@@ -66,7 +66,7 @@ class DockyardServer(configBuilder: Config.() -> Unit) {
         RegistryManager.register(ItemTagRegistry)
         RegistryManager.register(BiomeTagRegistry)
 
-        if(ConfigManager.config.implementationConfig.defaultCommands) DockyardCommands()
+        if(ConfigManager.config.implementationConfig.defaultCommands) DefaultCommands().register()
         if(ConfigManager.config.implementationConfig.npcCommand) NpcCommand()
         if(ConfigManager.config.implementationConfig.spark) SparkDockyardIntegration().initialize()
         if(ConfigManager.config.implementationConfig.applyBlockPlacementRules) DefaultBlockHandlers().register()
diff --git a/src/main/kotlin/io/github/dockyardmc/commands/ArgumentTypes.kt b/src/main/kotlin/io/github/dockyardmc/commands/ArgumentTypes.kt
@@ -217,10 +217,6 @@ class EnumArgument(
     }
 }
 
-class ListArgument() {
-
-}
-
 
 class CommandArgumentData(
     val argument: CommandArgument,
diff --git a/src/main/kotlin/io/github/dockyardmc/commands/CommandHandler.kt b/src/main/kotlin/io/github/dockyardmc/commands/CommandHandler.kt
@@ -21,8 +21,6 @@ import java.util.*
 
 object CommandHandler {
 
-    val prefix get() = ConfigManager.config.implementationConfig.commandErrorPrefix
-
     fun handleCommandInput(inputCommand: String, executor: CommandExecutor, testEnv: Boolean = false) {
         DockyardServer.scheduler.run {
             val tokens = inputCommand.removePrefix("/").split(" ").toMutableList()
@@ -47,19 +45,16 @@ object CommandHandler {
             } catch (ex: Exception) {
                 if (testEnv) throw IllegalArgumentException(ex)
                 if (ex is CommandException) {
-                    val message = "$prefix${ex.message}"
+                    val message = "<red>${ex.message}"
                     executor.sendMessage(message)
                 } else {
                     log(ex)
-                    if (ConfigManager.config.implementationConfig.notifyUserOfExceptionDuringCommand) {
-                        executor.sendMessage("${prefix}A <orange>${ex::class.qualifiedName} <red>was thrown during execution of this command!")
-                    }
+                    executor.sendMessage("<dark_red>Error <dark_gray>| <red>A <orange><hover:show_text:'<dark_red>${ex.message}'>${ex::class.qualifiedName}</hover> <red>was thrown during execution of this command!")
                 }
             }
         }
     }
 
-
     fun handleCommand(
         command: Command,
         executor: CommandExecutor,
@@ -117,7 +112,7 @@ object CommandHandler {
                 Float::class -> value.toFloatOrNull() ?: throw CommandException("\"$value\" is not of type Float")
                 Long::class -> value.toLongOrNull() ?: throw CommandException("\"$value\" is not of type Long")
                 UUID::class -> UUID.fromString(value)
-                Item::class -> ItemRegistry.get(value) ?: throw CommandException("\"$value\" is not of type Item")
+                Item::class -> ItemRegistry.getOrNull(value) ?: ItemRegistry.getOrNull("minecraft:$value") ?: throw CommandException("\"$value\" is not of type Item")
                 RegistryBlock::class -> {
                     if (value.contains("[")) {
                         //block state
diff --git a/src/main/kotlin/io/github/dockyardmc/config/Config.kt b/src/main/kotlin/io/github/dockyardmc/config/Config.kt
@@ -47,8 +47,6 @@ class Config {
 
 class ImplementationConfig {
     var applyBlockPlacementRules: Boolean = true
-    var notifyUserOfExceptionDuringCommand: Boolean = true
-    var commandErrorPrefix: String = "<dark_red>Error <dark_gray>| <red>"
     var commandNoPermissionsMessage: String = "You do not have permissions to execute this command!"
     var defaultEntityViewDistanceBlocks: Int = 64
     var defaultCommands: Boolean = true
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/DefaultImplementationModule.kt b/src/main/kotlin/io/github/dockyardmc/implementations/DefaultImplementationModule.kt
@@ -0,0 +1,6 @@
+package io.github.dockyardmc.implementations
+
+interface DefaultImplementationModule {
+    fun register()
+}
+
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/block/DefaultBlockHandlers.kt b/src/main/kotlin/io/github/dockyardmc/implementations/block/DefaultBlockHandlers.kt
@@ -1,8 +1,9 @@
 package io.github.dockyardmc.implementations.block
 
+import io.github.dockyardmc.implementations.DefaultImplementationModule
 import io.github.dockyardmc.world.block.handlers.*
 
-class DefaultBlockHandlers {
+class DefaultBlockHandlers: DefaultImplementationModule {
 
     private val facingBlocks: List<String> = listOf(
         "minecraft:furnace",
@@ -19,7 +20,7 @@ class DefaultBlockHandlers {
         "minecraft:bookshelf",
     )
 
-    fun register() {
+    override fun register() {
         BlockHandlerManager.register(BlockHandlerManager.Type.TAG, "minecraft:slabs", SlabBlockHandler())
         BlockHandlerManager.register(BlockHandlerManager.Type.BLOCK, "minecraft:barrel", BarrelBlockHandler())
         BlockHandlerManager.register(BlockHandlerManager.Type.TAG, "minecraft:buttons", ButtonBlockHandler())
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/ClearCommand.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/ClearCommand.kt
@@ -1,15 +1,18 @@
 package io.github.dockyardmc.implementations.commands
 
 import io.github.dockyardmc.commands.Commands
+import io.github.dockyardmc.commands.PlayerArgument
+import io.github.dockyardmc.player.Player
 
 class ClearCommand {
 
     init {
         Commands.add("/clear") {
             withPermission("dockyard.commands.clear")
             withDescription("Clears your inventory")
-            execute {
-                val player = it.getPlayerOrThrow()
+            addOptionalArgument("player", PlayerArgument())
+            execute { ctx ->
+                val player = getArgumentOrNull<Player>("player") ?: ctx.getPlayerOrThrow()
                 player.inventory.clear()
             }
         }
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/DebugCommand.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/DebugCommand.kt
@@ -14,7 +14,7 @@ class DebugCommand {
 
             addSubcommand("world") {
                 addArgument("world", WorldArgument())
-                execute {
+                execute { ctx ->
                     val world = getArgument<World>("world")
                     val message = buildString {
                         append("\n")
@@ -25,12 +25,12 @@ class DebugCommand {
                         appendLine(" <gray>Scheduler running: ${(!world.scheduler.paused.value).toScrollText()}")
                         appendLine(" <gray>Scheduler tick rate: <lime>${world.scheduler.tickRate.value.inWholeMilliseconds}ms")
                     }
-                    it.sendMessage(message)
+                    ctx.sendMessage(message)
                 }
             }
             addSubcommand("events") {
-                execute {
-                    it.sendMessage(Events.debugTree())
+                execute { ctx ->
+                    ctx.sendMessage(Events.debugTree())
                 }
             }
         }
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/DefaultCommands.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/DefaultCommands.kt
@@ -1,19 +1,21 @@
 package io.github.dockyardmc.implementations.commands
 
 import io.github.dockyardmc.config.ConfigManager
+import io.github.dockyardmc.implementations.DefaultImplementationModule
 
-class DockyardCommands {
+class DefaultCommands: DefaultImplementationModule {
 
-    init {
+    override fun register() {
         GamemodeCommand()
         VersionAndHelpCommand()
         WorldCommand()
         SoundCommand()
         GiveCommand()
         TeleportCommand()
         TimeCommand()
-        TickRateCommand()
+        SchedulerCommand()
         ClearCommand()
+        ListCommand()
         if(ConfigManager.config.debug) {
             DebugCommand()
         }
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/GamemodeCommand.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/GamemodeCommand.kt
@@ -38,24 +38,24 @@ class GamemodeCommand {
 
             addOptionalArgument("player", PlayerArgument())
 
-            execute {
+            execute { ctx ->
                 val map = mapOf(
                     "gmc" to GameMode.CREATIVE,
                     "gms" to GameMode.SURVIVAL,
                     "gmsp" to GameMode.SPECTATOR,
                     "gma" to GameMode.ADVENTURE
                 )
 
-                val command = it.command.removePrefix("/")
+                val command = ctx.command.removePrefix("/")
                 val gamemode: GameMode = map[command]!!
-                val player: Player = getArgumentOrNull<Player>("player") ?: it.getPlayerOrThrow()
+                val player: Player = getArgumentOrNull<Player>("player") ?: ctx.getPlayerOrThrow()
 
                 val name = gamemode.name.properStrictCase()
 
-                if(player == it.player) {
+                if(player == ctx.player) {
                     player.sendMessage("<gray>Set your own gamemode to <white>$name")
                 } else {
-                    it.sendMessage("<gray>Set gamemode of <white>$player <gray>to <white>$name")
+                    ctx.sendMessage("<gray>Set gamemode of <white>$player <gray>to <white>$name")
                     player.sendMessage("<gray>Your gamemode has been updated to <white>$name")
                 }
 
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/ListCommand.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/ListCommand.kt
@@ -0,0 +1,36 @@
+package io.github.dockyardmc.implementations.commands
+
+import io.github.dockyardmc.commands.Commands
+import io.github.dockyardmc.player.PlayerManager
+
+class ListCommand {
+
+    init {
+        Commands.add("/list") {
+            execute { ctx ->
+                val size = PlayerManager.players.size
+                if(size == 0) {
+                    ctx.sendMessage(" ")
+                    ctx.sendMessage("<gray>There are <red>no players<gray> online")
+                    ctx.sendMessage(" ")
+                    return@execute
+                }
+
+                val message = buildString {
+                    val playerWord = if(size == 1) "player" else "players"
+                    val isAreWord = if(size == 1) "is" else "are"
+                    appendLine(" ")
+                    appendLine("<gray>There $isAreWord <lime>${PlayerManager.players.size}<gray> $playerWord online:")
+                    PlayerManager.players.forEachIndexed { index, player ->
+                        if(index % 5 == 0 && index != 0) append("\n")
+                        append("<yellow>${player.username}<gray>")
+                        if(index != (size - 1)) append(", ")
+                    }
+                    appendLine(" ")
+                }
+
+                ctx.sendMessage(message)
+            }
+        }
+    }
+}
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/SchedulerCommand.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/SchedulerCommand.kt
@@ -7,11 +7,11 @@ import io.github.dockyardmc.extentions.toScrollText
 import io.github.dockyardmc.world.World
 import kotlin.time.Duration.Companion.milliseconds
 
-class TickRateCommand {
+class SchedulerCommand {
 
     init {
-        Commands.add("/tickrate") {
-            withPermission("dockyard.commands.tickrate")
+        Commands.add("/scheduler") {
+            withPermission("dockyard.commands.scheduler")
             withDescription("Lets you change tickrate/pause/resume scheduler of a world")
 
             addSubcommand("set") {
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/SoundCommand.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/SoundCommand.kt
@@ -11,21 +11,20 @@ class SoundCommand {
     init {
         Commands.add("/playsound") {
             withPermission("dockyard.commands.playsound")
-            withDescription("Plays sounds")
+            withDescription("Plays a sound to player")
 
-            addArgument("player", PlayerArgument())
             addArgument("sound", SoundArgument())
-            addOptionalArgument("volume", FloatArgument())
+            addArgument("category", EnumArgument(SoundCategory::class))
+            addArgument("player", PlayerArgument())
             addOptionalArgument("volume", FloatArgument())
             addOptionalArgument("pitch", FloatArgument())
-            addOptionalArgument("category", EnumArgument(SoundCategory::class))
 
             execute {
                 val player = getArgument<Player>("player")
                 val sound = getArgument<Sound>("sound")
-                val volume = getArgumentOrNull<Float>("volume") ?: 0.5f
+                val volume = getArgumentOrNull<Float>("volume") ?: 1f
                 val pitch = getArgumentOrNull<Float>("pitch") ?: 1f
-                val category = getEnumArgumentOrNull<SoundCategory>("category") ?: SoundCategory.MASTER
+                val category = getEnumArgument<SoundCategory>("category")
 
                 sound.category = category
                 sound.pitch = pitch
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/TimeCommand.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/TimeCommand.kt
@@ -6,19 +6,40 @@ import io.github.dockyardmc.player.Player
 
 class TimeCommand {
 
+    private companion object {
+        val TIMES_OF_DAY: Map<String, Long> = mapOf(
+            "day" to 1000,
+            "midnight" to 18000,
+            "night" to 13000,
+            "noon" to 6000
+        )
+
+        fun suggestTime(player: Player): List<String> {
+            return TIMES_OF_DAY.keys.toList()
+        }
+    }
+
     init {
         Commands.add("/time") {
             withDescription("Lets you change and freeze time of the world")
             withPermission("dockyard.commands.time")
 
             addSubcommand("set") {
-                addArgument("time", LongArgument(), simpleSuggestion("<time>"))
-                execute {
-                    val time = getArgument<Long>("time")
-                    val player = it.getPlayerOrThrow()
+                addArgument("time", StringArgument(), ::suggestTime)
+                execute { ctx ->
+                    val time = getArgument<String>("time")
+                    val player = ctx.getPlayerOrThrow()
+                    var newTime: Long? = null
+
+                    if (TIMES_OF_DAY.contains(time)) newTime = TIMES_OF_DAY[time]!!
+
+                    if (newTime == null) {
+                        val tryParse = time.toLongOrNull() ?: throw CommandException("$time is not of type Long, nor does it represent 'day', 'midnight', 'night', or 'noon'")
+                        newTime = tryParse
+                    }
 
-                    player.world.time.value = time
-                    player.sendMessage("<gray>Set time in world <white>${player.world.name}<gray> to <white>$time")
+                    player.world.time.value = newTime
+                    player.sendMessage("<gray>Set time in world <white>${player.world.name}<gray> to <white>$newTime")
                 }
             }
 
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/VersionAndHelpCommand.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/VersionAndHelpCommand.kt
@@ -2,7 +2,7 @@ package io.github.dockyardmc.implementations.commands
 
 import io.github.dockyardmc.DockyardServer
 import io.github.dockyardmc.commands.Commands
-import io.github.dockyardmc.utils.Branding
+import io.github.dockyardmc.utils.DockyardBranding
 
 class VersionAndHelpCommand {
 
@@ -12,16 +12,16 @@ class VersionAndHelpCommand {
             withAliases("ver", "info", "server", "dockyard")
             execute {
                 it.sendMessage("")
-                it.sendMessage("<gray>This server is running <${Branding.COLOR}>DockyardMC ${DockyardServer.versionInfo.dockyardVersion}<gray>. A custom Minecraft server implementation in Kotlin. <yellow><hover:show_text:'<yellow>https://github.com/DockyardMC/Dockyard'><click:open_url:https://github.com/DockyardMC/Dockyard>[Github]<reset>")
+                it.sendMessage("<gray>This server is running <${DockyardBranding.COLOR}>DockyardMC ${DockyardServer.versionInfo.dockyardVersion}<gray>. A custom Minecraft server implementation in Kotlin. <yellow><hover:show_text:'<yellow>https://github.com/DockyardMC/Dockyard'><click:open_url:https://github.com/DockyardMC/Dockyard>[Github]<reset>")
                 it.sendMessage("")
             }
         }
 
         Commands.add("/help") {
             withDescription("Shows list of commands")
             withAliases("commands")
-            execute {
-                val accessibleCommands = Commands.commands.filter { command -> !command.value.isAlias && it.hasPermission(command.value.permission) }
+            execute { ctx ->
+                val accessibleCommands = Commands.commands.filter { command -> !command.value.isAlias && ctx.hasPermission(command.value.permission) }
 
                 val message = buildString {
                     val commandSize = when (accessibleCommands.size) {
@@ -38,7 +38,7 @@ class VersionAndHelpCommand {
                         appendLine("<gray>  - <yellow>/${command.key} <gray> - <gray>$description")
                     }
                 }
-                it.sendMessage(message)
+                ctx.sendMessage(message)
             }
         }
     }
diff --git a/src/main/kotlin/io/github/dockyardmc/implementations/commands/WorldCommand.kt b/src/main/kotlin/io/github/dockyardmc/implementations/commands/WorldCommand.kt
diff --git a/src/main/kotlin/io/github/dockyardmc/motd/ServerStatus.kt b/src/main/kotlin/io/github/dockyardmc/motd/ServerStatus.kt
diff --git a/src/main/kotlin/io/github/dockyardmc/utils/DockyardBranding.kt b/src/main/kotlin/io/github/dockyardmc/utils/DockyardBranding.kt

Original file line number	Diff line number	Diff line change
`@@ -217,10 +217,6 @@ class EnumArgument(`
`217`	`217`	`}`
`218`	`218`	`}`
`219`	`219`
`220`		`-class ListArgument() {`
`221`		`-`
`222`		`-}`
`223`		`-`
`224`	`220`
`225`	`221`	`class CommandArgumentData(`
`226`	`222`	`val argument: CommandArgument,`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ class DebugCommand {`
`14`	`14`
`15`	`15`	`addSubcommand("world") {`
`16`	`16`	`addArgument("world", WorldArgument())`
`17`		`- execute {`
	`17`	`+ execute { ctx ->`
`18`	`18`	`val world = getArgument<World>("world")`
`19`	`19`	`val message = buildString {`
`20`	`20`	`append("\n")`
`@@ -25,12 +25,12 @@ class DebugCommand {`
`25`	`25`	`appendLine(" <gray>Scheduler running: ${(!world.scheduler.paused.value).toScrollText()}")`
`26`	`26`	`appendLine(" <gray>Scheduler tick rate: <lime>${world.scheduler.tickRate.value.inWholeMilliseconds}ms")`
`27`	`27`	`}`
`28`		`- it.sendMessage(message)`
	`28`	`+ ctx.sendMessage(message)`
`29`	`29`	`}`
`30`	`30`	`}`
`31`	`31`	`addSubcommand("events") {`
`32`		`- execute {`
`33`		`- it.sendMessage(Events.debugTree())`
	`32`	`+ execute { ctx ->`
	`33`	`+ ctx.sendMessage(Events.debugTree())`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`	`}`