172 lines
5.2 KiB
Markdown
172 lines
5.2 KiB
Markdown
# Migrating Commands from Bukkit
|
|
|
|
In Bukkit, commands are defined in `plugin.yml` and handled through `CommandExecutor` classes or the Brigadier library.
|
|
|
|
In Pumpkin, commands are built using a **Brigadier-inspired command tree** and registered programmatically via `context.register_command`. No YAML configuration files are used.
|
|
|
|
---
|
|
|
|
## Key Differences
|
|
|
|
| Feature | Bukkit / Spigot | Pumpkin |
|
|
| :--- | :--- | :--- |
|
|
| **Declaration** | Declared in `plugin.yml` under `commands:` | Constructed in code using `Command::new(...)` |
|
|
| **Permissions** | Linked in `plugin.yml` or checked via `player.hasPermission()` | Explicit permission node bound during `register_command()` |
|
|
| **Tab Completion** | Manual string matching in `TabCompleter` | Automatic tree-based client-side tab completion |
|
|
| **Subcommands** | Manual `if (args[0].equalsIgnoreCase("..."))` | Nested `Command` tree nodes |
|
|
|
|
---
|
|
|
|
## Code Comparison: Simple Command
|
|
|
|
Compare registering a `/feed` command in Bukkit vs. Pumpkin:
|
|
|
|
### 1. Bukkit Implementation (Java)
|
|
|
|
```java [FeedCommand.java]
|
|
// 1. Registered in plugin.yml:
|
|
// commands:
|
|
// feed:
|
|
// description: Feeds the player
|
|
// permission: myplugin.feed
|
|
|
|
public class FeedCommand implements CommandExecutor {
|
|
@Override
|
|
public boolean onCommand(CommandSender sender, Command command, String label, String[] args) {
|
|
if (!(sender instanceof Player)) {
|
|
sender.sendMessage("Only players can execute this command!");
|
|
return true;
|
|
}
|
|
Player player = (Player) sender;
|
|
if (!player.hasPermission("myplugin.feed")) {
|
|
player.sendMessage("No permission!");
|
|
return true;
|
|
}
|
|
player.setFoodLevel(20);
|
|
player.sendMessage("Your hunger has been satisfied!");
|
|
return true;
|
|
}
|
|
}
|
|
```
|
|
|
|
### 2. Pumpkin Implementations
|
|
|
|
::: code-group
|
|
|
|
```rust [Rust]
|
|
use pumpkin_plugin_api::{
|
|
command::{CommandHandler, CommandSender, ConsumedArgs, CommandError, Command},
|
|
permission::{Permission, PermissionDefault},
|
|
Context, Plugin, PluginMetadata, Server,
|
|
};
|
|
|
|
struct FeedExecutor;
|
|
|
|
impl CommandHandler for FeedExecutor {
|
|
fn handle(&self, sender: CommandSender, _server: Server, _args: ConsumedArgs) -> Result<i32, CommandError> {
|
|
sender.send_message("Your hunger has been satisfied!");
|
|
Ok(1)
|
|
}
|
|
}
|
|
|
|
pub struct MyPlugin;
|
|
|
|
impl Plugin for MyPlugin {
|
|
fn new() -> Self { MyPlugin }
|
|
|
|
fn metadata(&self) -> PluginMetadata {
|
|
PluginMetadata {
|
|
name: "feed_plugin".into(),
|
|
version: "1.0.0".into(),
|
|
authors: vec!["Developer".into()],
|
|
description: "Feed command plugin".into(),
|
|
}
|
|
}
|
|
|
|
fn on_load(&mut self, context: Context) -> pumpkin_plugin_api::Result<()> {
|
|
// 1. Register permission node (Replaces plugin.yml permission)
|
|
context.register_permission(&Permission {
|
|
node: "feed_plugin:feed".to_string(),
|
|
description: "Allows executing /feed".to_string(),
|
|
default: PermissionDefault::Allow,
|
|
children: Vec::new(),
|
|
})?;
|
|
|
|
// 2. Build command tree
|
|
let command = Command::new(&["feed".to_string(), "eat".to_string()], "Feeds the player")
|
|
.execute(FeedExecutor);
|
|
|
|
// 3. Register with context
|
|
context.register_command(command, "feed_plugin:feed")?;
|
|
|
|
Ok(())
|
|
}
|
|
}
|
|
```
|
|
|
|
```python [Python]
|
|
from pumpkin_api import (
|
|
Plugin, PluginMetadata, register_plugin,
|
|
permission, command, context, server
|
|
)
|
|
|
|
class FeedExecutor:
|
|
def handle(self, sender: command.CommandSender, srv: server.Server, args: command.ConsumedArgs) -> int:
|
|
sender.send_message("Your hunger has been satisfied!")
|
|
return 1
|
|
|
|
class FeedPlugin(Plugin):
|
|
def metadata(self) -> PluginMetadata:
|
|
return PluginMetadata(name="feed_plugin", version="1.0.0", authors=["Dev"], description="Feed command")
|
|
|
|
def on_load(self, ctx: context.Context) -> None:
|
|
ctx.register_permission(permission.Permission(
|
|
node="feed_plugin:feed",
|
|
description="Allows executing /feed",
|
|
default=permission.PermissionDefault.ALLOW,
|
|
children=[]
|
|
))
|
|
|
|
cmd = command.Command(["feed", "eat"], "Feeds the player")
|
|
cmd.execute(FeedExecutor())
|
|
ctx.register_command(cmd, "feed_plugin:feed")
|
|
|
|
register_plugin(FeedPlugin)
|
|
```
|
|
|
|
```kotlin [Kotlin]
|
|
package plugin
|
|
|
|
import pumpkin.plugin.context.Context
|
|
import pumpkin.plugin.command.Command
|
|
import pumpkin.plugin.command.CommandSender
|
|
import pumpkin.plugin.permission.Permission
|
|
import pumpkin.plugin.permission.PermissionDefault
|
|
|
|
class FeedPlugin {
|
|
fun onLoad(ctx: Context) {
|
|
ctx.registerPermission(
|
|
Permission(
|
|
node = "feed_plugin:feed",
|
|
description = "Allows executing /feed",
|
|
default = PermissionDefault.ALLOW,
|
|
children = emptyList()
|
|
)
|
|
)
|
|
|
|
val cmd = Command(
|
|
names = listOf("feed", "eat"),
|
|
description = "Feeds the player"
|
|
)
|
|
ctx.registerCommand(cmd, "feed_plugin:feed")
|
|
}
|
|
|
|
fun handleCommand(sender: CommandSender): Int {
|
|
sender.sendMessage("Your hunger has been satisfied!")
|
|
return 1
|
|
}
|
|
}
|
|
```
|
|
|
|
:::
|