Compare commits

..
6 Commits
Author SHA1 Message Date
Hare 3835c9b9e2 feat: greedyString 2025-12-07 06:54:05 +09:00
Hare 25b40427ed docs: マイグレーションガイド 2025-12-07 06:29:11 +09:00
Hare aab2b1169c feat: Brigadier対応 2025-12-07 06:03:18 +09:00
Hare e0613cd052 feat: bootの対応 2025-12-07 04:20:43 +09:00
Hare 3671948bfe chore: ignore追加 2025-12-07 04:04:44 +09:00
Hare 9af293122b feat: 構文ヒント 2025-12-07 03:16:54 +09:00
12 changed files with 444 additions and 448 deletions
+1
View File
@@ -2,3 +2,4 @@
.kotlin
.gradle
build
bin
+118
View File
@@ -0,0 +1,118 @@
# kommand-lib マイグレーションガイド
旧バージョンから最新の Brigadier ネイティブ対応バージョンへの移行方法。
---
## 変更の概要
### 主な変更点
1. **`coordinates()` の型変更** (破壊的変更)
- `Coordinates3``io.papermc.paper.math.Position`
- `coords.resolve(base)``position.toLocation(world)`
2. **内部処理の改善**
- Player/Entity セレクターの安定性向上
- Bukkit CommandMap → Brigadier Lifecycle API
---
## マイグレーション手順
### 1. 依存関係の確認
Paper API 1.21 以降が必要です。
```kotlin
dependencies {
compileOnly("io.papermc.paper:paper-api:1.21.10-R0.1-SNAPSHOT")
}
```
### 2. coordinates の修正
#### Before
```kotlin
coordinates("point") {
executes {
val coords = argument<Coordinates3>("point")
val location = coords.resolve(player.location)
}
}
```
#### After
```kotlin
import io.papermc.paper.math.Position
coordinates("point") {
executes {
val position = argument<Position>("point")
val location = position.toLocation(player.world)
}
}
```
### 3. ビルド確認
```bash
./gradlew build
```
---
## Position API
```kotlin
val position = argument<Position>("pos")
// 座標取得
val x = position.x()
val y = position.y()
val z = position.z()
// Location 変換
val location = position.toLocation(world)
```
---
## トラブルシューティング
### `Coordinates3` が見つからない
`Coordinates3` は存在しません。`Position` を使用してください。
```kotlin
// ❌ 間違い
argument<Coordinates3>("pos")
// ✅ 正しい
argument<Position>("pos")
```
### `resolve()` メソッドが見つからない
`Position` には `resolve()` はありません。`toLocation(world)` を使用してください。
```kotlin
// ❌ 間違い
position.resolve(baseLocation)
// ✅ 正しい
position.toLocation(world)
```
---
## FAQ
**Q: 相対座標 (`~`) は使えますか?**
A: はい、`Position` は相対座標を完全にサポートしています。
**Q: 旧バージョンとの互換性は?**
A: `coordinates()` の型が変更されているため互換性はありません。他の引数(`player()`, `players()` など)は互換性があります。
**Q: 段階的な移行は可能?**
A: `coordinates()` を使用している場合は一度にすべて移行する必要があります。
+39 -9
View File
@@ -9,8 +9,22 @@ Paper/Bukkit サーバー向けのコマンド定義を DSL で記述するた
- 1 つの定義から実行とタブ補完の両方を生成
- パーミッションや条件をノード単位で宣言し、子ノードへ自動伝播
- `suggests {}` で引数ごとの補完候補を柔軟に制御
- Brigadier (Paper 1.21 Lifecycle API) 対応により、クライアント側で `<speed> <count>` のような構文ヒントや、数値範囲の検証エラー(赤文字)が表示されます
- `permits-lib` との連携により、コマンドツリーから Bukkit パーミッションを自動生成し、`compileOnly` 依存として参照可能
## バージョン情報
**現在のバージョン**: 1.1 (Brigadier ネイティブ対応)
### 🔄 旧バージョンからの移行
旧バージョン (Brigadier 対応前) から移行する場合は、[マイグレーションガイド](./MIGRATION_GUIDE.md) を参照してください。
**主な変更点**:
- `coordinates()` の返り値が `Coordinates3` から `io.papermc.paper.math.Position` に変更
- `position.toLocation(world)``Location` に変換する方式に変更
- Player/Entity セレクターの内部処理が改善され、より安定した動作を実現
## 依存関係
`build.gradle.kts` では Paper API と Kotlin 標準ライブラリのみを `compileOnly` に追加しています。Paper 1.21.10 対応の API を利用しています。
@@ -76,11 +90,11 @@ class EconomyPlugin : JavaPlugin() {
literal("setspawn") {
coordinates("point") { // "~ ~1 ~-2" のような入力を受け付ける
executes {
val base = (sender as? Player)?.location ?: return@executes
val coords = argument<Coordinates3>("point")
val target = coords.resolve(base)
plugin.server.worlds.first().setSpawnLocation(target)
sender.sendMessage("Spawn set to ${target.x}, ${target.y}, ${target.z}")
val player = sender as? Player ?: return@executes
val position = argument<io.papermc.paper.math.Position>("point")
val location = position.toLocation(player.world)
player.world.setSpawnLocation(location)
sender.sendMessage("Spawn set to ${location.x}, ${location.y}, ${location.z}")
}
}
}
@@ -109,7 +123,7 @@ class EconomyPlugin : JavaPlugin() {
- `string("name")``integer("value", min = 0)` は値をパースし、成功すると `KommandContext` に記憶されます。取得時は `argument<String>("name")``argument<Int>("value")` を呼び出してください。
- `float("speed")``player("target")`/`players("targets")`/`selector("entities")` は Minecraft の標準セレクター (`@p`, `@a`, `@s` など) やプレイヤー名を型付きで扱えます。実行時は `argument<Double>("speed")``argument<Player>("target")``argument<List<Player>>("targets")` のように取得できます。
- `suggests { prefix -> ... }` を指定すると、タブ補完時に任意の候補リストを返せます。
- `coordinates("pos")``x y z` をまとめて 1 つの引数として受け取り、`argument<Coordinates3>("pos").resolve(player.location)` で現在位置を基準に解決できます (`~` を使用した相対座標に対応)。
- `coordinates("pos")``x y z` をまとめて 1 つの引数として受け取り、`argument<io.papermc.paper.math.Position>("pos")` で取得できます。`position.toLocation(world)``Location` に変換できます (`~` を使用した相対座標に対応)。
- `command` や各ノードの `condition { sender -> ... }` で実行条件 (例: コンソール禁止) を追加できます。
- ルートレベルで `executes { ... }` を指定すると、引数なしで `/eco` を実行した場合に呼び出されます。
@@ -157,10 +171,18 @@ commands = kommand(this) {
| `float("speed", min, max)` | `Double` | 小数/指数表記に対応 |
| `player("target", allowSelectors = true)` | `Player` | `@p` などのセレクターまたはプレイヤー名を 1 人に解決 |
| `players("targets")` | `List<Player>` | `@a`/`@r` など複数指定、プレイヤー名入力も可 |
| `selector("entities")` | `List<Entity>` | Bukkit の `Bukkit.selectEntities` をそのまま利用 |
| `coordinates("pos")` | `Coordinates3` | `~` 相対座標を含む 3 軸をまとめて扱う |
| `selector("entities")` | `List<Entity>` | エンティティセレクター (`@e` など) |
| `coordinates("pos")` | `io.papermc.paper.math.Position` | `~` 相対座標を含む 3 軸をまとめて扱う |
`Coordinates3``coordinates("pos") { ... }` 直後のコンテキストで `argument<Coordinates3>("pos")` として取得でき、`resolve(baseLocation)` で基準座標に対して実座標を求められます。
`Position``coordinates("pos") { ... }` 直後のコンテキストで `argument<io.papermc.paper.math.Position>("pos")` として取得でき、`position.toLocation(world)``Location` に変換できます。
## クライアント側構文ヒント (Brigadier)
Paper 1.21 以降の環境では、`LifecycleEventManager` を通じてコマンドが登録されるため、クライアントにコマンドの構造が送信されます。これにより以下のメリットがあります:
- **構文の可視化**: 入力中に `<speed> <amount>` のような引数名が表示されます。
- **クライアント側検証**: `integer("val", min=1, max=10)` などの範囲指定がクライアント側でも判定され、範囲外の値を入力すると赤字になります。
- **互換性**: 内部的には `Brigadier` のノードに変換されますが、実際のコマンド実行は `kommand-lib` の既存ロジック(`KommandContext`)を使用するため、古いコードの修正は不要です。
## ビルドとテスト
@@ -169,3 +191,11 @@ commands = kommand(this) {
```
ShadowJar タスクが実行され、`build/libs` に出力されます。Paper サーバーに配置して動作確認してください。
## ドキュメント
- **[MIGRATION_GUIDE](./MIGRATION_GUIDE.md)** - 旧バージョンからの移行方法
## ライセンス
このプロジェクトは MIT ライセンスの下で公開されています。
@@ -1,18 +1,12 @@
package net.hareworks.kommand_lib
import net.hareworks.kommand_lib.context.KommandContext
import net.hareworks.kommand_lib.execution.CommandTree
import net.hareworks.kommand_lib.execution.ParseMode
import net.hareworks.kommand_lib.dsl.KommandRegistry
import net.hareworks.kommand_lib.permissions.PermissionOptions
import net.hareworks.kommand_lib.permissions.PermissionRuntime
import org.bukkit.Bukkit
import org.bukkit.command.CommandMap
import org.bukkit.command.CommandSender
import org.bukkit.command.PluginCommand
import org.bukkit.command.TabCompleter
import org.bukkit.plugin.Plugin
import org.bukkit.plugin.java.JavaPlugin
import org.bukkit.plugin.Plugin
fun kommand(plugin: JavaPlugin, block: KommandRegistry.() -> Unit): KommandLib {
val registry = KommandRegistry(plugin)
@@ -28,51 +22,31 @@ class KommandLib internal constructor(
private val definitions: List<CommandDefinition>,
private val permissionRuntime: PermissionRuntime?
) {
private val commandMap: CommandMap by lazy {
val field = Bukkit.getServer().javaClass.getDeclaredField("commandMap")
field.isAccessible = true
field.get(Bukkit.getServer()) as CommandMap
}
private val registered = mutableListOf<PluginCommand>()
init {
registerAll()
permissionRuntime?.let {
if (it.config.autoApply) it.apply()
}
}
private fun registerAll() {
for (definition in definitions) {
commandMap.getCommand(definition.name)?.unregister(commandMap)
val command = newPluginCommand(definition.name)
if (definition.aliases.isNotEmpty()) command.aliases = definition.aliases
definition.description?.let { command.description = it }
definition.usage?.let { command.usage = it }
definition.permission?.let { command.permission = it }
command.setExecutor { sender, _, alias, args ->
definition.execute(plugin, sender, alias, args)
val manager = plugin.lifecycleManager
@Suppress("UnstableApiUsage")
manager.registerEventHandler(io.papermc.paper.plugin.lifecycle.event.types.LifecycleEvents.COMMANDS) { event ->
val registrar = event.registrar()
for (definition in definitions) {
// Compile the definition to a Brigadier LiteralArgumentBuilder
val node = TreeCompiler.compile(plugin, definition)
registrar.register(node.build(), definition.description, definition.aliases)
}
command.tabCompleter = TabCompleter { sender, _, alias, args ->
definition.tabComplete(plugin, sender, alias, args)
}
commandMap.register(plugin.name.lowercase(), command)
registered += command
}
}
fun unregister() {
registered.forEach { it.unregister(commandMap) }
registered.clear()
// Lifecycle API handles unregistration automatically on disable usually?
// Or we might need to verify if manual unregistration is needed.
// For now, clearing local state.
// Note: Paper Lifecycle API doesn't expose easy unregister for static commands registered in 'COMMANDS' event usually,
// it rebuilds the dispatcher on reload.
permissionRuntime?.clear()
}
private fun newPluginCommand(name: String): PluginCommand {
val constructor = PluginCommand::class.java.getDeclaredConstructor(String::class.java, Plugin::class.java)
constructor.isAccessible = true
return constructor.newInstance(name, plugin)
}
}
internal data class CommandDefinition(
@@ -85,30 +59,4 @@ internal data class CommandDefinition(
val rootExecutor: (KommandContext.() -> Unit)?,
val nodes: List<net.hareworks.kommand_lib.nodes.KommandNode>,
val permissionOptions: PermissionOptions
) {
private val tree = CommandTree(nodes)
fun execute(plugin: JavaPlugin, sender: CommandSender, alias: String, args: Array<String>): Boolean {
if (!rootCondition(sender)) return false
val context = KommandContext(plugin, sender, alias, args, ParseMode.EXECUTE)
if (args.isEmpty()) {
val executor = rootExecutor ?: return false
executor.invoke(context)
return true
}
return tree.execute(context)
}
fun tabComplete(plugin: JavaPlugin, sender: CommandSender, alias: String, args: Array<String>): List<String> {
if (!rootCondition(sender)) return emptyList()
if (nodes.isEmpty()) return emptyList()
val context = KommandContext(plugin, sender, alias, args, ParseMode.SUGGEST)
if (args.isEmpty()) {
return nodes
.filter { it.isVisible(sender) }
.flatMap { it.suggestions("", context) }
.distinct()
}
return tree.tabComplete(context)
}
}
)
@@ -0,0 +1,88 @@
package net.hareworks.kommand_lib
import com.mojang.brigadier.builder.ArgumentBuilder
import com.mojang.brigadier.builder.LiteralArgumentBuilder
import com.mojang.brigadier.builder.RequiredArgumentBuilder
import com.mojang.brigadier.context.CommandContext
import com.mojang.brigadier.suggestion.SuggestionsBuilder
import com.mojang.brigadier.tree.CommandNode
import io.papermc.paper.command.brigadier.CommandSourceStack
import io.papermc.paper.command.brigadier.Commands
import net.hareworks.kommand_lib.context.KommandContext
import net.hareworks.kommand_lib.nodes.KommandNode
import net.hareworks.kommand_lib.nodes.LiteralNode
import net.hareworks.kommand_lib.nodes.ValueNode
import org.bukkit.plugin.java.JavaPlugin
@Suppress("UnstableApiUsage")
internal object TreeCompiler {
fun compile(
plugin: JavaPlugin,
definition: CommandDefinition
): LiteralArgumentBuilder<CommandSourceStack> {
val root = Commands.literal(definition.name)
.requires { source -> definition.rootCondition(source.sender) }
// Root execution
definition.rootExecutor?.let { executor ->
root.executes { ctx ->
val context = KommandContext(plugin, ctx)
executor(context)
1
}
}
// Children
definition.nodes.forEach { child ->
compileNode(plugin, child)?.let { root.then(it) }
}
return root
}
private fun compileNode(
plugin: JavaPlugin,
node: KommandNode
): ArgumentBuilder<CommandSourceStack, *>? {
val builder = when (node) {
is LiteralNode -> {
Commands.literal(node.literal)
}
is ValueNode<*> -> {
val argType = node.argument.build()
Commands.argument(node.name, argType)
}
else -> return null
}
builder.requires { source -> node.isVisible(source.sender) }
// Execution
node.executor?.let { executor ->
builder.executes { ctx ->
val context = KommandContext(plugin, ctx)
executor(context)
1
}
}
// Custom Suggestions (if any)
if (node is ValueNode<*> && node.suggestionProvider != null && builder is RequiredArgumentBuilder<*, *>) {
@Suppress("UNCHECKED_CAST")
(builder as RequiredArgumentBuilder<CommandSourceStack, Any>).suggests { ctx: CommandContext<CommandSourceStack>, suggestionsBuilder: SuggestionsBuilder ->
val context = KommandContext(plugin, ctx)
val suggestions = node.suggestionProvider!!.invoke(context, suggestionsBuilder.remaining)
suggestions.forEach { suggestionsBuilder.suggest(it) }
suggestionsBuilder.buildFuture()
}
}
// Recursion
node.children.forEach { child ->
compileNode(plugin, child)?.let { builder.then(it) }
}
return builder
}
}
@@ -1,197 +1,86 @@
package net.hareworks.kommand_lib.arguments
import net.hareworks.kommand_lib.context.KommandContext
import org.bukkit.Bukkit
import org.bukkit.Location
import com.mojang.brigadier.arguments.ArgumentType
import com.mojang.brigadier.arguments.BoolArgumentType
import com.mojang.brigadier.arguments.DoubleArgumentType
import com.mojang.brigadier.arguments.IntegerArgumentType
import com.mojang.brigadier.arguments.StringArgumentType
import io.papermc.paper.command.brigadier.argument.ArgumentTypes
import io.papermc.paper.command.brigadier.argument.resolvers.selector.PlayerSelectorArgumentResolver
import io.papermc.paper.command.brigadier.argument.resolvers.selector.EntitySelectorArgumentResolver
import org.bukkit.entity.Entity
import org.bukkit.entity.Player
import org.bukkit.util.Vector
import org.bukkit.Location
import org.bukkit.command.CommandSender
sealed class ArgumentParseResult<out T> {
data class Success<T>(val value: T) : ArgumentParseResult<T>()
data class Failure(val reason: String) : ArgumentParseResult<Nothing>()
/**
* A holder for the Brigadier ArgumentType and any metadata needed for the DSL.
*
* Note: T represents the final type that users will receive in KommandContext.argument<T>(),
* not necessarily the raw Brigadier return type. For example, PlayerArgument has T=Player,
* but Brigadier returns PlayerSelectorArgumentResolver which is resolved to Player by ArgumentResolver.
*/
interface KommandArgument<T> {
fun build(): ArgumentType<*>
}
interface KommandArgumentType<T> {
fun parse(input: String, context: KommandContext): ArgumentParseResult<T>
fun suggestions(context: KommandContext, prefix: String): List<String> = emptyList()
class WordArgument : KommandArgument<String> {
override fun build(): ArgumentType<String> = StringArgumentType.word()
}
object WordArgumentType : KommandArgumentType<String> {
override fun parse(input: String, context: KommandContext): ArgumentParseResult<String> {
if (input.isBlank()) return ArgumentParseResult.Failure("Value cannot be blank")
return ArgumentParseResult.Success(input)
}
class GreedyStringArgument : KommandArgument<String> {
override fun build(): ArgumentType<String> = StringArgumentType.greedyString()
}
class IntegerArgumentType(
private val min: Int? = null,
private val max: Int? = null
) : KommandArgumentType<Int> {
override fun parse(input: String, context: KommandContext): ArgumentParseResult<Int> {
val value = input.toIntOrNull()
?: return ArgumentParseResult.Failure("Expected integer but got '$input'")
if (min != null && value < min) {
return ArgumentParseResult.Failure("Value must be >= $min")
}
if (max != null && value > max) {
return ArgumentParseResult.Failure("Value must be <= $max")
}
return ArgumentParseResult.Success(value)
}
class IntegerArgument(
private val min: Int = Int.MIN_VALUE,
private val max: Int = Int.MAX_VALUE
) : KommandArgument<Int> {
override fun build(): ArgumentType<Int> = IntegerArgumentType.integer(min, max)
}
class FloatArgumentType(
private val min: Double? = null,
private val max: Double? = null
) : KommandArgumentType<Double> {
override fun parse(input: String, context: KommandContext): ArgumentParseResult<Double> {
val value = input.toDoubleOrNull()
?: return ArgumentParseResult.Failure("Expected decimal number but got '$input'")
if (min != null && value < min) {
return ArgumentParseResult.Failure("Value must be >= $min")
}
if (max != null && value > max) {
return ArgumentParseResult.Failure("Value must be <= $max")
}
return ArgumentParseResult.Success(value)
}
class FloatArgument(
private val min: Double = -Double.MAX_VALUE,
private val max: Double = Double.MAX_VALUE
) : KommandArgument<Double> {
override fun build(): ArgumentType<Double> = DoubleArgumentType.doubleArg(min, max)
}
class PlayerArgumentType(
private val allowSelectors: Boolean
) : KommandArgumentType<Player> {
override fun parse(input: String, context: KommandContext): ArgumentParseResult<Player> {
val trimmed = input.trim()
if (allowSelectors && trimmed.startsWith("@")) {
val entities = try {
Bukkit.selectEntities(context.sender, trimmed)
} catch (ex: IllegalArgumentException) {
return ArgumentParseResult.Failure(ex.message ?: "Invalid selector '$trimmed'")
}
val player = entities.firstOrNull { it is Player } as? Player
?: return ArgumentParseResult.Failure("Selector '$trimmed' did not match a player")
return ArgumentParseResult.Success(player)
}
val player = Bukkit.getPlayerExact(trimmed)
?: return ArgumentParseResult.Failure("Player '$trimmed' is not online")
return ArgumentParseResult.Success(player)
}
override fun suggestions(context: KommandContext, prefix: String): List<String> {
val names = Bukkit.getOnlinePlayers()
.map { it.name }
.filter { it.startsWith(prefix, ignoreCase = true) }
if (!allowSelectors) return names
val selectors = DEFAULT_SELECTOR_SUGGESTIONS.filter { it.startsWith(prefix) }
return (names + selectors).distinct()
}
class BooleanArgument : KommandArgument<Boolean> {
override fun build(): ArgumentType<Boolean> = BoolArgumentType.bool()
}
class PlayerSelectorArgumentType(
private val allowDirectNames: Boolean
) : KommandArgumentType<List<Player>> {
override fun parse(input: String, context: KommandContext): ArgumentParseResult<List<Player>> {
val trimmed = input.trim()
if (!trimmed.startsWith("@")) {
if (!allowDirectNames) {
return ArgumentParseResult.Failure("Selector expected but got '$trimmed'")
}
val player = Bukkit.getPlayerExact(trimmed)
?: return ArgumentParseResult.Failure("Player '$trimmed' is not online")
return ArgumentParseResult.Success(listOf(player))
}
val entities = try {
Bukkit.selectEntities(context.sender, trimmed)
} catch (ex: IllegalArgumentException) {
return ArgumentParseResult.Failure(ex.message ?: "Invalid selector '$trimmed'")
}
val players = entities.filterIsInstance<Player>()
if (players.isEmpty()) {
return ArgumentParseResult.Failure("Selector '$trimmed' did not match any players")
}
return ArgumentParseResult.Success(players)
}
override fun suggestions(context: KommandContext, prefix: String): List<String> {
val candidates = linkedSetOf<String>()
candidates += Bukkit.getOnlinePlayers()
.map { it.name }
.filter { it.startsWith(prefix, ignoreCase = true) }
candidates += DEFAULT_SELECTOR_SUGGESTIONS.filter { it.startsWith(prefix) }
return candidates.toList()
}
/**
* Single player argument. Returns a Player object after resolving the selector.
* Supports player names and selectors like @p, @s, @r[limit=1].
*/
class PlayerArgument : KommandArgument<Player> {
override fun build(): ArgumentType<PlayerSelectorArgumentResolver> = ArgumentTypes.player()
}
class EntitySelectorArgumentType(
private val requireMatch: Boolean
) : KommandArgumentType<List<Entity>> {
override fun parse(input: String, context: KommandContext): ArgumentParseResult<List<Entity>> {
val trimmed = input.trim()
if (!trimmed.startsWith("@")) {
val player = Bukkit.getPlayerExact(trimmed)
if (player != null) return ArgumentParseResult.Success(listOf(player))
return if (requireMatch) {
ArgumentParseResult.Failure("No entity matched '$trimmed'")
} else {
ArgumentParseResult.Success(emptyList())
}
}
val entities = try {
Bukkit.selectEntities(context.sender, trimmed)
} catch (ex: IllegalArgumentException) {
return ArgumentParseResult.Failure(ex.message ?: "Invalid selector '$trimmed'")
}
if (requireMatch && entities.isEmpty()) {
return ArgumentParseResult.Failure("Selector '$trimmed' did not match any entities")
}
return ArgumentParseResult.Success(entities)
}
override fun suggestions(context: KommandContext, prefix: String): List<String> {
return DEFAULT_SELECTOR_SUGGESTIONS.filter { it.startsWith(prefix) }
}
/**
* Multiple players argument. Returns a List<Player> after resolving the selector.
* Supports player names and selectors like @a, @r.
*/
class PlayersArgument : KommandArgument<List<Player>> {
override fun build(): ArgumentType<PlayerSelectorArgumentResolver> = ArgumentTypes.players()
}
class CoordinateComponentArgumentType(
private val allowRelative: Boolean
) : KommandArgumentType<CoordinateComponent> {
override fun parse(input: String, context: KommandContext): ArgumentParseResult<CoordinateComponent> {
val trimmed = input.trim()
if (allowRelative && trimmed.startsWith("~")) {
val remainder = trimmed.removePrefix("~")
val offset = if (remainder.isEmpty()) 0.0 else remainder.toDoubleOrNull()
?: return ArgumentParseResult.Failure("Invalid relative coordinate '$trimmed'")
return ArgumentParseResult.Success(CoordinateComponent(relative = true, value = offset))
}
val absolute = trimmed.toDoubleOrNull()
?: return ArgumentParseResult.Failure("Expected coordinate but got '$trimmed'")
return ArgumentParseResult.Success(CoordinateComponent(relative = false, value = absolute))
}
override fun suggestions(context: KommandContext, prefix: String): List<String> {
if (!allowRelative) return emptyList()
return if ("~".startsWith(prefix)) listOf("~") else emptyList()
}
/**
* Entity selector argument. Returns a List<Entity> after resolving the selector.
* Supports all entity selectors like @e, @e[type=minecraft:zombie].
*/
class EntityArgument : KommandArgument<List<Entity>> {
override fun build(): ArgumentType<EntitySelectorArgumentResolver> = ArgumentTypes.entities()
}
private val DEFAULT_SELECTOR_SUGGESTIONS = listOf("@p", "@a", "@s", "@r", "@e")
data class CoordinateComponent(val relative: Boolean, val value: Double) {
fun resolve(origin: Double): Double = if (relative) origin + value else value
}
data class Coordinates3(
val x: CoordinateComponent,
val y: CoordinateComponent,
val z: CoordinateComponent
) {
fun resolve(origin: Location): Location {
val clone = origin.clone()
clone.x = x.resolve(clone.x)
clone.y = y.resolve(clone.y)
clone.z = z.resolve(clone.z)
return clone
}
/**
* Fine position argument for coordinates with decimal precision.
* Supports relative coordinates like ~ ~1 ~-2.
* Returns a Position (io.papermc.paper.math.Position) after resolving.
*/
class CoordinatesArgument : KommandArgument<io.papermc.paper.math.Position> {
override fun build(): ArgumentType<*> = ArgumentTypes.finePosition()
}
@@ -0,0 +1,76 @@
package net.hareworks.kommand_lib.context
import com.mojang.brigadier.context.CommandContext
import io.papermc.paper.command.brigadier.CommandSourceStack
import io.papermc.paper.command.brigadier.argument.resolvers.selector.PlayerSelectorArgumentResolver
import io.papermc.paper.command.brigadier.argument.resolvers.selector.EntitySelectorArgumentResolver
import io.papermc.paper.command.brigadier.argument.resolvers.FinePositionResolver
import io.papermc.paper.command.brigadier.argument.resolvers.BlockPositionResolver
import io.papermc.paper.math.Position
import org.bukkit.entity.Entity
import org.bukkit.entity.Player
/**
* Internal helper to resolve Brigadier argument types to their actual values.
* This handles the conversion from Paper's resolver types to concrete Bukkit types.
*
* Note: This is public because it's called from inline functions in KommandContext,
* but it's not intended for direct use by library consumers.
*/
object ArgumentResolver {
/**
* Resolves an argument from the command context.
* Handles special cases for Paper's selector resolvers and position resolvers.
*/
inline fun <reified T> resolve(context: CommandContext<CommandSourceStack>, name: String): T {
val rawValue = context.getArgument(name, Any::class.java)
@Suppress("UNCHECKED_CAST")
return when {
// Single player selector
T::class.java == Player::class.java && rawValue is PlayerSelectorArgumentResolver -> {
rawValue.resolve(context.source).firstOrNull() as T
?: throw IllegalStateException("Player selector '$name' did not resolve to any player")
}
// Multiple players selector
T::class.java == List::class.java && rawValue is PlayerSelectorArgumentResolver -> {
rawValue.resolve(context.source) as T
}
// Entity selector
T::class.java == List::class.java && rawValue is EntitySelectorArgumentResolver -> {
rawValue.resolve(context.source) as T
}
// Fine position (coordinates with decimals)
rawValue is FinePositionResolver -> {
rawValue.resolve(context.source) as T
}
// Block position (integer coordinates)
rawValue is BlockPositionResolver -> {
rawValue.resolve(context.source) as T
}
// All other types (primitives, strings, etc.)
else -> {
context.getArgument(name, T::class.java)
}
}
}
/**
* Resolves an argument or returns null if not found.
*/
inline fun <reified T> resolveOrNull(context: CommandContext<CommandSourceStack>, name: String): T? {
return try {
resolve<T>(context, name)
} catch (e: IllegalArgumentException) {
null
} catch (e: IllegalStateException) {
null
}
}
}
@@ -1,33 +1,25 @@
package net.hareworks.kommand_lib.context
import com.mojang.brigadier.context.CommandContext
import io.papermc.paper.command.brigadier.CommandSourceStack
import org.bukkit.command.CommandSender
import org.bukkit.plugin.java.JavaPlugin
import net.hareworks.kommand_lib.execution.ParseMode
open class KommandContext internal constructor(
class KommandContext internal constructor(
val plugin: JavaPlugin,
val sender: CommandSender,
val alias: String,
val args: Array<String>,
val mode: ParseMode
val internal: CommandContext<CommandSourceStack>
) {
private val parsedArguments = linkedMapOf<String, Any?>()
val sender: CommandSender
get() = internal.source.sender
internal fun remember(name: String, value: Any?) {
parsedArguments[name] = value
val commandSource: CommandSourceStack
get() = internal.source
inline fun <reified T> argument(name: String): T {
return ArgumentResolver.resolve(internal, name)
}
internal fun drop(name: String) {
parsedArguments.remove(name)
inline fun <reified T> argumentOrNull(name: String): T? {
return ArgumentResolver.resolveOrNull(internal, name)
}
@Suppress("UNCHECKED_CAST")
fun <T> argument(name: String): T =
parsedArguments[name] as? T
?: error("Argument '$name' is not present in this context.")
@Suppress("UNCHECKED_CAST")
fun <T> argumentOrNull(name: String): T? = parsedArguments[name] as? T
fun arguments(): Map<String, Any?> = parsedArguments.toMap()
}
@@ -6,8 +6,6 @@ import net.hareworks.kommand_lib.permissions.PermissionConfigBuilder
import net.hareworks.kommand_lib.permissions.PermissionOptions
import net.hareworks.kommand_lib.permissions.PermissionPlanner
import net.hareworks.kommand_lib.permissions.PermissionRuntime
import net.hareworks.kommand_lib.nodes.Axis
import net.hareworks.kommand_lib.nodes.CoordinateAxisNode
import net.hareworks.kommand_lib.nodes.KommandNode
import net.hareworks.kommand_lib.nodes.LiteralNode
import net.hareworks.kommand_lib.nodes.ValueNode
@@ -21,9 +19,6 @@ class KommandRegistry internal constructor(private val plugin: JavaPlugin) {
private val definitions = mutableListOf<CommandDefinition>()
private var permissionConfigBuilder: PermissionConfigBuilder? = null
/**
* Declares a new command root.
*/
fun command(name: String, vararg aliases: String, block: CommandBuilder.() -> Unit) {
val builder = CommandBuilder(name, aliases.toList())
builder.block()
@@ -122,7 +117,7 @@ abstract class BranchScope internal constructor(
LiteralBuilder(node).apply(block)
}
fun <T> argument(name: String, type: KommandArgumentType<T>, block: ValueBuilder<T>.() -> Unit = {}) {
fun <T> argument(name: String, type: KommandArgument<T>, block: ValueBuilder<T>.() -> Unit = {}) {
val node = ValueNode(name, type)
node.permission = inheritedPermission
node.condition = inheritedCondition
@@ -131,61 +126,53 @@ abstract class BranchScope internal constructor(
ValueBuilder(node).apply(block)
}
fun string(name: String, block: ValueBuilder<String>.() -> Unit = {}) = argument(name, WordArgumentType, block)
fun string(name: String, block: ValueBuilder<String>.() -> Unit = {}) = argument(name, WordArgument(), block)
fun greedyString(name: String, block: ValueBuilder<String>.() -> Unit = {}) = argument(name, GreedyStringArgument(), block)
fun integer(
name: String,
min: Int? = null,
max: Int? = null,
min: Int = Int.MIN_VALUE,
max: Int = Int.MAX_VALUE,
block: ValueBuilder<Int>.() -> Unit = {}
) = argument(name, IntegerArgumentType(min, max), block)
) = argument(name, IntegerArgument(min, max), block)
fun float(
name: String,
min: Double? = null,
max: Double? = null,
min: Double = -Double.MAX_VALUE,
max: Double = Double.MAX_VALUE,
block: ValueBuilder<Double>.() -> Unit = {}
) = argument(name, FloatArgumentType(min, max), block)
) = argument(name, FloatArgument(min, max), block)
fun bool(
name: String,
block: ValueBuilder<Boolean>.() -> Unit = {}
) = argument(name, BooleanArgument(), block)
fun player(
name: String,
allowSelectors: Boolean = true,
allowSelectors: Boolean = true, // Ignored logic-wise if using native, assuming it handles selectors
block: ValueBuilder<Player>.() -> Unit = {}
) = argument(name, PlayerArgumentType(allowSelectors), block)
) = argument(name, PlayerArgument(), block)
fun players(
name: String,
allowDirectNames: Boolean = true,
block: ValueBuilder<List<Player>>.() -> Unit = {}
) = argument(name, PlayerSelectorArgumentType(allowDirectNames), block)
) = argument(name, PlayersArgument(), block)
fun selector(
name: String,
requireMatch: Boolean = true,
block: ValueBuilder<List<Entity>>.() -> Unit = {}
) = argument(name, EntitySelectorArgumentType(requireMatch), block)
) = argument(name, EntityArgument(), block)
fun coordinates(
name: String,
allowRelative: Boolean = true,
block: CoordinateNodeScope.() -> Unit = {}
) {
val xNode = CoordinateAxisNode(name, Axis.X, allowRelative)
val yNode = CoordinateAxisNode(name, Axis.Y, allowRelative)
val zNode = CoordinateAxisNode(name, Axis.Z, allowRelative)
val nodes = listOf(xNode, yNode, zNode)
nodes.forEach { node ->
node.permission = inheritedPermission
node.condition = inheritedCondition
}
xNode.permissionOptions.skipPermission()
yNode.permissionOptions.skipPermission()
zNode.permissionOptions.rename(name)
xNode.children += yNode
yNode.children += zNode
children += xNode
CoordinateNodeScope(zNode).apply(block)
}
block: ValueBuilder<io.papermc.paper.math.Position>.() -> Unit = {}
) = argument(name, CoordinatesArgument(), block)
}
@KommandDsl
@@ -222,23 +209,20 @@ abstract class NodeScope internal constructor(
@KommandDsl
class LiteralBuilder internal constructor(
node: LiteralNode
) : NodeScope(node)
private val literalNode: LiteralNode
) : NodeScope(literalNode)
@KommandDsl
class ValueBuilder<T> internal constructor(
private val valueNode: ValueNode<T>
) : NodeScope(valueNode) {
/**
* Overrides the default suggestion provider for this argument.
* Overrides the default suggestion provider (wrapper around Brigadier logic)
*/
fun suggests(block: net.hareworks.kommand_lib.context.KommandContext.(prefix: String) -> List<String>) {
valueNode.suggestionProvider = { ctx, prefix -> block(ctx, prefix) }
}
}
@KommandDsl
class CoordinateNodeScope internal constructor(node: KommandNode) : NodeScope(node)
@DslMarker
annotation class KommandDsl
@@ -1,59 +0,0 @@
package net.hareworks.kommand_lib.execution
import net.hareworks.kommand_lib.context.KommandContext
import net.hareworks.kommand_lib.nodes.KommandNode
internal class CommandTree(private val roots: List<KommandNode>) {
fun execute(context: KommandContext): Boolean {
if (context.args.isEmpty()) return false
val node = match(roots, context, 0) ?: return false
val executor = node.executor ?: return false
executor.invoke(context)
return true
}
fun tabComplete(context: KommandContext): List<String> {
if (context.args.isEmpty()) return emptyList()
return collect(roots, context, 0)
}
private fun match(nodes: List<KommandNode>, context: KommandContext, index: Int): KommandNode? {
if (index >= context.args.size) return null
val token = context.args[index]
for (node in nodes) {
if (!node.isVisible(context.sender)) continue
if (!node.consume(token, context, ParseMode.EXECUTE)) continue
if (index == context.args.lastIndex && node.executor != null) {
return node
}
val result = match(node.children, context, index + 1)
if (result != null) return result
node.undo(context)
}
return null
}
private fun collect(nodes: List<KommandNode>, context: KommandContext, index: Int): List<String> {
val token = context.args[index]
val last = index == context.args.lastIndex
val suggestions = linkedSetOf<String>()
for (node in nodes) {
if (!node.isVisible(context.sender)) continue
if (last) {
suggestions += node.suggestions(token, context)
}
if (node.consume(token, context, ParseMode.SUGGEST)) {
if (!last && node.children.isNotEmpty()) {
suggestions += collect(node.children, context, index + 1)
}
node.undo(context)
}
}
return suggestions.toList()
}
}
enum class ParseMode {
EXECUTE,
SUGGEST
}
@@ -1,10 +1,7 @@
package net.hareworks.kommand_lib.nodes
import net.hareworks.kommand_lib.arguments.CoordinateComponent
import net.hareworks.kommand_lib.arguments.Coordinates3
import net.hareworks.kommand_lib.arguments.KommandArgumentType
import net.hareworks.kommand_lib.arguments.KommandArgument
import net.hareworks.kommand_lib.context.KommandContext
import net.hareworks.kommand_lib.execution.ParseMode
import net.hareworks.kommand_lib.permissions.PermissionOptions
import org.bukkit.command.CommandSender
@@ -21,86 +18,18 @@ abstract class KommandNode internal constructor() {
return condition(sender)
}
abstract fun consume(token: String, context: KommandContext, mode: ParseMode): Boolean
open fun undo(context: KommandContext) {}
abstract fun suggestions(prefix: String, context: KommandContext): List<String>
open fun segment(): String? = null
}
class LiteralNode internal constructor(private val literal: String) : KommandNode() {
override fun consume(token: String, context: KommandContext, mode: ParseMode): Boolean {
return literal.equals(token, ignoreCase = true)
}
override fun suggestions(prefix: String, context: KommandContext): List<String> {
return if (literal.startsWith(prefix, ignoreCase = true)) listOf(literal) else emptyList()
}
class LiteralNode internal constructor(val literal: String) : KommandNode() {
override fun segment(): String = literal
}
open class ValueNode<T> internal constructor(
private val name: String,
private val type: KommandArgumentType<T>
class ValueNode<T> internal constructor(
val name: String,
val argument: KommandArgument<T>
) : KommandNode() {
var suggestionProvider: ((KommandContext, String) -> List<String>)? = null
override fun consume(token: String, context: KommandContext, mode: ParseMode): Boolean {
return when (val result = type.parse(token, context)) {
is net.hareworks.kommand_lib.arguments.ArgumentParseResult.Success -> {
context.remember(name, result.value)
true
}
is net.hareworks.kommand_lib.arguments.ArgumentParseResult.Failure -> {
if (mode == ParseMode.EXECUTE) {
context.sender.sendMessage(result.reason)
}
false
}
}
}
override fun undo(context: KommandContext) {
context.drop(name)
}
override fun suggestions(prefix: String, context: KommandContext): List<String> {
val custom = suggestionProvider?.invoke(context, prefix)
if (custom != null) return custom
return type.suggestions(context, prefix)
}
override fun segment(): String = name
}
private fun coordinateAxisKey(base: String, axis: Axis): String = "$base::__${axis.name.lowercase()}"
class CoordinateAxisNode(
private val aggregateName: String,
private val axis: Axis,
allowRelative: Boolean
) : ValueNode<CoordinateComponent>(coordinateAxisKey(aggregateName, axis),
net.hareworks.kommand_lib.arguments.CoordinateComponentArgumentType(allowRelative)) {
override fun consume(token: String, context: KommandContext, mode: ParseMode): Boolean {
val success = super.consume(token, context, mode)
if (success && axis == Axis.Z) {
val x = context.argumentOrNull<CoordinateComponent>(coordinateAxisKey(aggregateName, Axis.X))
val y = context.argumentOrNull<CoordinateComponent>(coordinateAxisKey(aggregateName, Axis.Y))
val z = context.argumentOrNull<CoordinateComponent>(coordinateAxisKey(aggregateName, Axis.Z))
if (x != null && y != null && z != null) {
context.remember(aggregateName, Coordinates3(x, y, z))
}
}
return success
}
override fun undo(context: KommandContext) {
if (axis == Axis.Z) {
context.drop(aggregateName)
}
super.undo(context)
}
}
enum class Axis { X, Y, Z }