Query

Cette fonctionnalité est exclusive à l'édition Java. 

Query (littéralement "requête") est un protocole UDP introduit dans l'édition Java Beta 1.9 Prerelease 4 pour récupérer des propriétés d'un serveur. Il est conçu pour être compatible avec le protocole Query UT3 (ou GameSpot).

Une alternative légèrement plus simple au protocole de requête consiste à se connecter au port TCP principal de Minecraft et à envoyer un paquet de "ping de la liste des serveurs", qui renvoie le MOTD, le nombre d'utilisateurs et le nombre d'emplacements.

Tous les types de données sont en big-endian, à l'exception du type short.

Pour activer la RCON, il faut modifier le fichier server.properties :

enable-query=true
query.port=<1-65535>

Le port par défaut est celui défini dans server-port.

L'ID de session est utilisé pour identifier les requêtes. Les exemples suivants utilisent l'ID de session = 1 (encodé comme 00 00 00 01 sur les vidages hexadécimaux).

Seuls les 4 bits inférieurs de chaque octet de l'ID de session doivent être utilisés, car Minecraft ne traite pas les 4 bits supérieurs de chaque octet. Pour convertir n'importe quel ID de session de 4 octets en un ID de session de Minecraft valide, il faut simplement masquer les bits avec sessionId & 0x0F0F0F0F.

Envoyez une requête avec une charge utile vide.

Vidage :

FE FD 09 00 00 00 01

La charge utile de la réponse sera un jeton de challenge encodé sous forme de chaîne de caractères terminée par un caractère nul. Vous devez le convertir en int32 et le stocker.

Dans cet exemple, après avoir analysé la chaîne de caractères "9513307\0" en tant qu'entier et l'avoir compressée en tant que int32 en big-endian, le résultat doit être 00 91 29 5B.

Vidage :

09 00 00 00 01 39 35 31 33 33 30 37 00 | .....9513307.         

Citation de la publication originale de Dinnerbone sur le protocole de requête de Minecraft :

Notez que le jeton de challenge est lié à votre IP et votre port (par opposition à l'[ID de session]) et dure jusqu'à 30 secondes. Vous avez bien lu, c'est à vous de décider ; ce n'est pas "votre jeton expirera après 30 secondes", c'est "chaque token" qui expire toutes les 30 secondes. Cela signifie qu'il est tout à fait possible que vous obteniez un jeton et que vous l'utilisiez dans la même seconde et qu'il expire.

De plus :

Vous devrez fournir votre jeton de challenge, sinon vous ne recevrez aucune réponse. Si vous fournissez un jeton et qu'il est invalide, vous ne recevrez toujours pas de réponse. Avec cela à l'esprit, si vous souhaitez stocker votre jeton de challenge et l'utiliser ultérieurement, vous souhaiterez peut-être appliquer un délai d'attente avant une réponse, au cas où le serveur redémarrerait et que votre jeton ne serait plus valide. Il est impossible de faire la différence entre un serveur hors ligne et un serveur qui a refusé votre challenge sans aucune requête supplémentaire, vous devrez donc essayer d'obtenir un autre jeton de challenge et, si cela est échoue, le signaler comme indisponible.

La charge utile doit être le jeton de challenge, compressé sous forme d'un int32.

Vidage :

FE FD 00 00 00 00 01 00 91 29 5B

Vidage :

00 00 00 00 01 41 20 4D 69 6E 65 63 72 61 66 74 | .....A Minecraft
20 53 65 72 76 65 72 00 53 4D 50 00 77 6F 72 6C |  Server.SMP.worl
64 00 32 00 32 30 00 DD 63 31 32 37 2E 30 2E 30 | d.2.20.##127.0.0
2E 31 00                                        | .1.

Cette méthode est mise en cache toutes les 5 secondes.

La requête est la même que pour les statistiques de base, sauf que la charge utile doit être remplie à 8 octets. L'envoi de 0x00 0x00 0x00 0x00 à la fin fonctionne.

Vidage :

FE FD 00 00 00 00 01 00 91 29 5B 00 00 00 00

La réponse est en deux parties. La première partie est une liste de chaînes de caractères terminées par un caractère nul, représentant (clé1, valeur1, clé2, valeur2...). La deuxième partie est une autre liste de chaînes de caractères terminées par un caractère nul, chacune représentant un joueur.

Une façon simple d'analyser la charge utile consiste à ignorer les 11 premiers octets, puis à diviser la réponse autour du jeton \x00\x01player_\x00\x00. À la toute fin, il y a un octet nul supplémentaire.

Vidage :

00 00 00 00 01 73 70 6C 69 74 6E 75 6D 00 80 00 | .....splitnum...
68 6F 73 74 6E 61 6D 65 00 41 20 4D 69 6E 65 63 | hostname.A minec
72 61 66 74 20 53 65 72 76 65 72 00 67 61 6D 65 | raft Server.game
74 79 70 65 00 53 4D 50 00 67 61 6D 65 5F 69 64 | type.SMP.game_id
00 4D 49 4E 45 43 52 41 46 54 00 76 65 72 73 69 | .MINECRAFT.versi
6F 6E 00 42 65 74 61 20 31 2E 39 20 50 72 65 72 | on.Beta 1.9 Prer
65 6C 65 61 73 65 20 34 00 70 6C 75 67 69 6E 73 | elease 4.plugins
00 00 6D 61 70 00 77 6F 72 6C 64 00 6E 75 6D 70 | ..map.world.nump
6C 61 79 65 72 73 00 32 00 6D 61 78 70 6C 61 79 | layers.2.maxplay
65 72 73 00 32 30 00 68 6F 73 74 70 6F 72 74 00 | ers.20.hostport.
32 35 35 36 35 00 68 6F 73 74 69 70 00 31 32 37 | 25565.hostip.127
2E 30 2E 30 2E 31 00 00 01 70 6C 61 79 65 72 5F | .0.0.1...player_
00 00 62 61 72 6E 65 79 67 61 6C 65 00 56 69 76 | ..barneygale.Viv
61 6C 61 68 65 6C 76 69 67 00 00                | alahelvig..

• https://github.com/Sch8ill/MCClient-lib (python)
• https://github.com/MaxLevs/McQueryLib.Net (C#, .Net 5.0)
• https://github.com/A2PLab/minelib (scala)
• https://github.com/Dinnerbone/mcstatus (python)
• https://github.com/Erikvv/Minecraft-Query-cpp (c++)
• https://github.com/barneygale/MCQuery (python)
• https://github.com/coNQP/mcipc (python 3.8+)
• https://github.com/kmpm/node-mcquery (node.js)
• https://github.com/py-mine/PyMine/blob/main/pymine/logic/query.py (python 3.7.9+)
• https://github.com/ryanshawty/MCJQuery (java)
• https://github.com/xPaw/PHP-Minecraft-Query (php)
• https://github.com/PassTheMayo/minecraft-server-util (node.js)
• https://github.com/dreamscached/minequery (go)
• https://github.com/mcstatus-io/mcutil (go)
• https://github.com/H4kt/minecraft-query-kt (kotlin)

Ce fichier est sous licence Creative Commons Attribution-ShareAlike 3.0. 

Cette page a été importée depuis wiki.vg ou est un dérivé d'une telle page. Ainsi, la licence habituelle du wiki ne s'applique pas.
Les œuvres dérivées doivent être concédées sous licence en utilisant la même licence ou une licence compatible.