Skip to content

建立你的第一個指令 ​

在 Pumpkin 中使用 Go 註冊指令遵循標準的 Go 慣例,並透過 TinyGo 編譯為 WASM。


1. 快速範例 ​

下面是一個完整的 Go 插件檔案(main.go),它會註冊一個帶權限檢查的 /hello 指令,並向玩家傳送回應。

go
package main

import (
	"github.com/Pumpkin-MC/pumpkin-api-go/api"
	"github.com/Pumpkin-MC/pumpkin-api-go/pkg/pumpkin_plugin_command"
	"github.com/Pumpkin-MC/pumpkin-api-go/pkg/pumpkin_plugin_context"
	"github.com/Pumpkin-MC/pumpkin-api-go/pkg/pumpkin_plugin_permission"
	_ "github.com/Pumpkin-MC/pumpkin-api-go/pkg/wit_exports"
)

type MyPlugin struct {
	api.DefaultPlugin
}

func (p *MyPlugin) Metadata() api.Metadata {
	return api.Metadata{
		Name:        "my_go_plugin",
		Version:     "0.1.0",
		Authors:     []string{"Developer"},
		Description: "My first Pumpkin Go plugin",
	}
}

func (p *MyPlugin) OnLoad(ctx *pumpkin_plugin_context.Context) {
	// 1. 註冊權限節點
	ctx.RegisterPermission(pumpkin_plugin_permission.Permission{
		Node:        "my_go_plugin:hello",
		Description: "Allows executing the /hello command",
		Default:     pumpkin_plugin_permission.PermissionDefaultAllow(),
	})

	// 2. 建構並註冊指令樹
	cmd := pumpkin_plugin_command.New([]string{"hello", "hi"}, "Greets the player")
	ctx.RegisterCommand(cmd, "my_go_plugin:hello")
}

func (p *MyPlugin) HandleCommand(cmdID uint32, sender pumpkin_plugin_command.CommandSender) int32 {
	sender.SendMessage("Hello from Go Plugin!")
	return 1
}

func init() {
	api.RegisterPlugin(&MyPlugin{})
}

func main() {}

2. 遊戲內預覽 ​

指令註冊後,Minecraft 客戶端會自動為其提供自動自動完成、語法驗證和顏色高亮:

遊戲內指令自動自動完成預覽

3. 工作原理 ​

分步解析

步驟 1:註冊權限 ​

在 OnLoad 中調用 ctx.RegisterPermission:

go
ctx.RegisterPermission(pumpkin_plugin_permission.Permission{
    Node:        "my_go_plugin:hello",
    Description: "Allows executing the /hello command",
    Default:     pumpkin_plugin_permission.PermissionDefaultAllow(),
})

步驟 2:構建指令樹 ​

使用 pumpkin_plugin_command.New 實例化指令樹:

go
cmd := pumpkin_plugin_command.New([]string{"hello", "hi"}, "Greets the player")

步驟 3:註冊並執行 ​

使用 ctx.RegisterCommand 註冊指令,並在 HandleCommand 中處理執行:

go
ctx.RegisterCommand(cmd, "my_go_plugin:hello")

後續步驟 ​

基於 MIT 授權條款發布。