Skip to content

Interface Status

The json format for Minecraft server handshake status query response

🏷️ Properties

description

ts
description: string | TextComponent

The motd of server, which might be the raw TextComponent string or structurelized TextComponent JSON

Defined in: packages/client/status.ts:68

favicon

ts
favicon: string

The base 64 favicon data

Defined in: packages/client/status.ts:72

modinfo optional

ts
modinfo: { modList: ForgeModIdentity[]; type: string }

Defined in: packages/client/status.ts:73

ping

ts
ping: number

The ping from server

Defined in: packages/client/status.ts:80

players

ts
players: { max: number; online: number; sample?: GameProfile[] }

The player info in server

Defined in: packages/client/status.ts:51

version

ts
version: { name: string; protocol: number }

The version info of the server

Defined in: packages/client/status.ts:37