MCTOOLBOX
MC ToolboxMC TOOLBOX
Protokol serveru Java Edition

Průzkumník API pro správu serveru Minecraft

Procházejte vanilla JSON-RPC metody, sestavujte poziční parametry, kontrolujte schémata odpovědí a připravte zabezpečené WebSocket připojení bez odhalení skutečného serverového tajemství.

68
Metody
17
Oznámení
15
Schémata
3.0
Protokol v 26.2
Volatelná metodaPouze pro čtení1.21.9+
minecraft:server/status

Přečtěte si stav spuštění, online hráče a běžící verzi Minecraftu.

Parametry

Tato metoda nepřijímá žádné parametry.

Výsledek

Typ výsledku
Server State
JSON-RPC požadavek
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "minecraft:server/status"
}
Příklad odpovědi
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "started": true,
    "players": [
      {
        "id": "853c80ef-3c37-49fd-aa49-938b674adae6",
        "name": "jeb_"
      }
    ],
    "version": {
      "name": "26.2",
      "protocol": 774
    }
  }
}

Tvůrce připojení a server.properties

Použijte pevný port pro nástroje a nechte tajemství jednou prázdné, aby Minecraft vygeneroval platnou 40znakovou hodnotu.

Bezpečnostní poznámka: Nikdy nevkládejte skutečné tajemství správy na veřejné webové stránky. Vážte se na localhost nebo soukromou síť, použijte firewall a používejte TLS přes nedůvěryhodné sítě.
server.properties
management-server-enabled=true
management-server-host=localhost
management-server-port=25585
management-server-secret=
management-server-tls-enabled=true
management-server-tls-keystore=management-server.p12
management-server-allowed-origins=http://localhost:3000
Terminálové připojení
wscat -c wss://localhost:25585 -s minecraft-v1 -H "Authorization: Bearer YOUR_40_CHARACTER_SECRET"
Příklad prohlížeče WebSocket
const socket = new WebSocket('wss://localhost:25585', [
  'minecraft-v1',
  'YOUR_40_CHARACTER_SECRET'
]);

socket.addEventListener('open', () => {
  socket.send("{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"minecraft:server/status\"}");
});

socket.addEventListener('message', ({ data }) => {
  console.log(JSON.parse(data));
});
Průvodce protokolem

Co je protokol pro správu serveru Minecraft?

Protokol pro správu serveru je API dedikovaného serveru Java Edition, představené ve verzi 1.21.9. Přenáší zprávy JSON-RPC 2.0 přes WebSocket, takže dashboardy a automatizace mohou pracovat s typovanými hráči, bany, nastaveními, game rules a stavem serveru namísto parsování textu konzole.

Minecraft 26.2 používá verzi protokolu 3.0 a může vystavit rpc.discover předtím, než se herní server plně spustí. Objevování je nejbezpečnější způsob, jak se klient může dozvědět metody a oznámení podporované přesným serverem, ke kterému se připojil.

Tento průzkumník je referenční a tvůrce datových částí, nikoli vzdálený ovládací panel. Záměrně používá zástupný tajný klíč a provádí veškeré úpravy lokálně ve vašem prohlížeči.

Provozní pokyny

API pro správu versus RCON

RCON odesílá konzolové příkazy a vrací nestrukturovaný text. API pro správu vrací typovaný JSON a může odesílat události připojení, odpojení, uložení, game rule a stavu, což z něj činí vhodnější nástroj pro ovládací panely, monitorování a boty.

API je pouze pro Java Edition a je ve výchozím nastavení zakázáno. Produkční klient by měl ověřovat objevená schémata, zpracovávat standardní chybové objekty JSON-RPC, znovu se připojovat s exponenciálním zpožděním a považovat zápisy stop, clear, set, ban, kick a operator za privilegované akce.

Port 0 požádá Minecraft o výběr náhodného portu; službu nevypíná. TLS je ve výchozím nastavení povoleno a klienti prohlížeče také potřebují povolený Origin a subprotokol WebSocket minecraft-v1.

Často kladené otázky

Může se tato stránka připojit k mému živému serveru Minecraft?

Ne. Vytváří příklady lokálně a nikdy se neptá na vaše skutečné tajemství. Použijte vygenerovaný úryvek v důvěryhodném lokálním nástroji nebo použijte udržovanou klientskou knihovnu.

Proč jsou parametry zobrazeny jako JSON pole?

Metody Minecraft API používají poziční parametry JSON-RPC. I metoda s jedním logickým argumentem odesílá tuto hodnotu uvnitř pole params.

Funguje protokol na Bedrock Edition?

Ne. Protokol pro správu serveru Minecraft je v současné době funkcí dedikovaného serveru Java Edition.

Měl bych pevně zakódovat seznam metod v panelu serveru?

Použijte rpc.discover za běhu, pokud je to možné. Protokol se již změnil napříč verzemi 1.21.9, 1.21.11 a 26.2.