快速入門
本指南將幫助你開始使用 Python 編寫 Pumpkin 伺服器插件。
安裝
首先,你需要安裝 pumpkin-api-py 庫:
bash
pip install pumpkin-api-py建立你的第一個插件
建立一個名為 main.py 的檔案,並新增以下內容:
python
from pumpkin_api import (
Plugin, PluginMetadata, register_plugin,
server, event, command, text, context
)
class MyPlugin(Plugin):
def metadata(self) -> PluginMetadata:
return PluginMetadata(
name="my-plugin",
version="0.1.0",
authors=["you"],
description="An example plugin."
)
def on_load(self, ctx: context.Context) -> None:
print("Python plugin loaded!")
# 註冊事件處理器
self.register_event(ctx, event.EventType.PLAYER_JOIN_EVENT, self.on_player_join)
def on_player_join(self, srv: server.Server, evt: event.PlayerJoinEventData) -> event.PlayerJoinEventData:
print(f"Player {evt.player.get_name()} joined!")
return evt
register_plugin(MyPlugin)構建插件
使用提供的構建工具將插件構建為 WebAssembly 元件:
bash
pumpkin-plugin-build main -o my_plugin.wasm這將生成一個 my_plugin.wasm 檔案,你可以將其放入 Pumpkin 伺服器的 plugins 資料夾中。