5. API

API

Websocket Json 请求说明

{
  "api": "接口名称，例如：'broadcast'",
  "data": {
    "参数名": "参数值",
    "参数名2": "参数值"
  },
  "echo": "'回声', 如果指定了 echo 字段, 那么响应包也会同时包含一个 echo 字段, 它们会有相同的值"
}

某些通用常用对象

点击展开

message

字段名	数据类型	是否必填	默认值	说明
type	string	是	text	一般为 text 在 Minecraft 中没有其他用法
data	CommonTextComponent / array<CommonBaseComponent>	是	-	统一解析的消息内容

CommonTextComponent

字段名	数据类型	是否必填	默认值	说明
text	string	是	-	文本内容
color	string	否	white	文本颜色
font	string	否	null	文本字体
bold	boolean	否	false	是否粗体
italic	boolean	否	false	是否斜体
underlined	boolean	否	false	是否下划线
strikethrough	boolean	否	false	是否删除线
obfuscated	boolean	否	false	是否混淆
insertion	string	否	null	点击后插入文本
click_event	ClickEvent	否	null	点击事件
hover_event	HoverEvent	否	null	鼠标悬浮事件

ClickAction

键	值	说明
OPEN_URL	open_url	打开链接
OPEN_FILE	open_file	打开文件
RUN_COMMAND	run_command	运行命令
SUGGEST_COMMAND	suggest_command	提示命令
CHANGE_PAGE	change_page	翻页
COPY_TO_CLIPBOARD	copy_to_clipboard	复制到剪贴板

ClickEvent

Key	Value	说明
action	ClickAction	点击行为
value	string	执行的值

HoverAction

键	值	说明
SHOW_TEXT	show_text	显示文本
SHOW_ITEM	show_item	显示物品
SHOW_ENTITY	show_entity	显示实体

HoverItem

字段名	数据类型	是否必填	默认值	说明
id	string	否	-	物品 ID Spigot, Forge, Fabric
count	int	否	-	数量 Spigot, Forge, Fabric
tag	string	否	-	物品 tag Spigot
key	string	否	-	物品 key Velocity

HoverEntity

字段名	数据类型	是否必填	默认值	说明
id	string	否	-	显示的实体 ID Spigot
type	string	否	-	显示的实体类型 Spigot, Forge, Fabric
name	array<CommonBaseComponent>	否	-	显示的实体名称 Spigot, Forge, Fabric
key	string	否	-	显示的实体 key Velocity

HoverEvent

Key	Value
action	HoverAction
text	array<CommonBaseComponent>
item	HoverItem
entity	string

CommonBaseComponent

字段名	数据类型	是否必填	默认值	说明
text	string	是	-	文本内容
color	string	否	white	文本颜色
font	string	否	null	文本字体
bold	boolean	否	false	是否粗体
italic	boolean	否	false	是否斜体
underlined	boolean	否	false	是否下划线
strikethrough	boolean	否	false	是否删除线
obfuscated	boolean	否	false	是否混淆
insertion	string	否	null	点击后插入文本

Broadcast / Send Message

API：broadcast/send_msg

请求参数

字段名	数据类型	是否必填	默认值	说明
message	string / message	是	-	发送的消息

响应数据

Tip

该接口无返回数据

PrivateMessage

API：send_private_msg

请求参数

Warning

uuid 和 nickname 至少填写一个
如果都传递，则优先使用 uuid

字段名	数据类型	是否必填	默认值	说明
uuid	UUID/string	否	-	玩家 UUID
nickname	string	否	-	玩家昵称
message	string / message	是	-	发送的消息

响应数据

字段名	数据类型	说明
player	BasePlayer	目标玩家信息（玩家基类，具体类型因服务端而异）
message	string	消息内容（成功、失败、未找到玩家、玩家离线等）

Title

API：send_title

请求参数

字段名	数据类型	是否必填	默认值	说明
title	string / message	是	-	标题
subtitle	string / message	否	-	副标题
fadein	int	否	10	淡入时间
stay	int	否	70	持续时间
fadeout	int	否	20	淡出时间

响应数据

Tip

该接口无返回数据

Actionbar

API：send_actionbar

请求参数

字段名	数据类型	是否必填	默认值	说明
message	string / message	是	-	消息

响应数据

Tip

该接口无返回数据