MCTOOLBOX
MC ToolboxMC TOOLBOX
Protocole de serveur Java Edition

Explorateur d'API de Gestion de Serveur Minecraft

Parcourez les méthodes JSON-RPC vanilla, construisez des paramètres positionnels, inspectez les schémas de réponse et préparez une connexion WebSocket sécurisée sans exposer un véritable secret de serveur.

68
Méthodes
17
Notifications
15
Schémas
3.0
Protocole en 26.2
Méthode appelableLecture seule1.21.9+
minecraft:server/status

Lire l'état de démarrage, les joueurs en ligne et la version de Minecraft en cours d'exécution.

Paramètres

Cette méthode ne prend aucun paramètre.

Résultat

Type de résultat
Server State
Requête JSON-RPC
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "minecraft:server/status"
}
Exemple de réponse
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "started": true,
    "players": [
      {
        "id": "853c80ef-3c37-49fd-aa49-938b674adae6",
        "name": "jeb_"
      }
    ],
    "version": {
      "name": "26.2",
      "protocol": 774
    }
  }
}

Générateur de connexion et server.properties

Utilisez un port fixe pour les outils et laissez le secret vide une fois pour que Minecraft génère une valeur valide de 40 caractères.

Note de sécurité : Ne jamais coller un véritable secret de gestion sur un site web public. Liez à localhost ou à un réseau privé, utilisez un pare-feu et utilisez TLS sur des réseaux non fiables.
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
Connexion terminal
wscat -c wss://localhost:25585 -s minecraft-v1 -H "Authorization: Bearer YOUR_40_CHARACTER_SECRET"
Exemple WebSocket navigateur
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));
});
Guide du protocole

Qu'est-ce que le protocole de gestion de serveur Minecraft ?

Le protocole de gestion de serveur est une API de serveur dédié Java Edition introduite en 1.21.9. Il transporte des messages JSON-RPC 2.0 via WebSocket, permettant aux tableaux de bord et à l'automatisation de travailler avec des joueurs typés, des bannissements, des paramètres, des game rules et l'état du serveur au lieu d'analyser du texte de console.

Minecraft 26.2 utilise la version 3.0 du protocole et peut exposer rpc.discover avant que le serveur de jeu n'ait complètement démarré. La découverte est le moyen le plus sûr pour un client d'apprendre les méthodes et notifications prises en charge par le serveur exact qu'il a atteint.

Cet explorateur est une référence et un constructeur de charge utile, pas un panneau de contrôle à distance. Il utilise intentionnellement un secret de substitution et effectue toutes les modifications localement dans votre navigateur.

Conseils opérationnels

API de gestion versus RCON

RCON envoie des commandes de console et renvoie du texte non structuré. L'API de gestion renvoie du JSON typé et peut pousser des événements de connexion, de déconnexion, de sauvegarde, de gamerule et de statut, ce qui la rend plus adaptée aux panneaux de contrôle, à la surveillance et aux bots.

L'API est uniquement pour Java Edition et est désactivée par défaut. Un client de production doit valider les schémas découverts, gérer les objets d'erreur JSON-RPC standard, se reconnecter avec un délai d'attente et traiter les écritures stop, clear, set, ban, kick et operator comme des actions privilégiées.

Le port 0 demande à Minecraft de choisir un port aléatoire ; il ne désactive pas le service. TLS est activé par défaut, et les clients de navigateur ont également besoin d'une Origin autorisée ainsi que du sous-protocole WebSocket minecraft-v1.

Questions fréquemment posées

Cette page peut-elle se connecter à mon serveur Minecraft en direct ?

Non. Il construit des exemples localement et ne demande jamais votre véritable secret. Utilisez l'extrait généré dans un outil local de confiance, ou utilisez une bibliothèque cliente maintenue.

Pourquoi les paramètres sont-ils affichés sous forme de tableau JSON ?

Les méthodes de l'API Minecraft utilisent des paramètres JSON-RPC positionnels. Même une méthode avec un seul argument logique envoie cette valeur à l'intérieur du tableau de paramètres.

Le protocole fonctionne-t-il sur Bedrock Edition ?

Non. Le protocole de gestion de serveur Minecraft est actuellement une fonctionnalité de serveur dédié Java Edition.

Devrais-je coder en dur la liste des méthodes dans un panneau de serveur ?

Utilisez rpc.discover à l'exécution lorsque cela est possible. Le protocole a déjà changé entre les versions 1.21.9, 1.21.11 et 26.2.