RCON

This feature is exclusive to Java Edition.

 

It is dangerous to expose RCON ports to the internet. RCON is not encrypted and can be a subject to on-path attacks.

Remote console (RCON) is a TCP/IP-based protocol that allows server administrators to remotely execute commands. Introduced in Java Edition Beta 1.9 Prerelease 4, it's an implementation of the Source RCON protocol for Minecraft.

server.properties

To enable RCON, you need to edit your server.properties file:

enable-rcon=true
rcon.password=<your password>
rcon.port=<1-65535>
broadcast-rcon-to-ops=false

The default port is 25575.

Packet format

Integers are little-endian, in contrast with the Java Edition protocol.

Responses are sent back with the same Request ID that you send. In the event of an auth failure (i.e. your login is incorrect, or you're trying to send commands without first logging in), request ID will be set to -1.

Note on ASCII text: Some servers reply with color codes prefixed by a section sign in their replies (for example Craftbukkit for Minecraft 1.4.7).

The section sign is sent by those servers as byte 0xA7 or 167. This is not part of the US-ASCII charset and will cause errors for clients that strictly use the US-ASCII charset.

Using the ISO-LATIN-1/ISO-8859_1 charset instead of the US-ASCII charset yields much better results for those servers.

Alternatively removing byte 167 and one subsequent byte from the payload will remove all color tokens making the text more human readable for clients that do not subsequently colorize those tokens.

Packets

3: Login

Outgoing payload: password.

If the server returns a packet with the same request ID, auth was successful (note: packet type is 2, not 3). If you get a request ID of -1, auth failed (wrong password).

2: Command

Outgoing payload should be the command to run, e.g. time set 0

0: Command response

Incoming payload is the output of the command, though many commands return nothing, and there's no way of detecting unknown commands.

The output of the command may be split over multiple packets, each containing 4096 bytes (less for the last packet). Each packet contains part of the payload (and the two-byte padding). The last packet sent is the end of the output.

Fragmentation

Maximum C->S packet payload length: 1446 (total: 1460) - outdated?

Maximum S->C packet payload length: 4096 (total: 4110)

The Minecraft server can fragment responses across multiple packets. There's no simple way to know when the last response packet has been received; approaches include:

1. Wait until we receive a packet with a payload length < 4096 (not 100% reliable!)
2. Wait for n seconds
3. Send two command packets; the second command triggers a response from the server with the same Request ID, and from this we know that we've already received the full response to the first command.
   • The second packet should use a command that will not produce fragmented output
   • An alternative is for the second C->S packet to use an invalid type (say, 200); the server will respond with a 'Command response' packet with its payload set to 'Unknown request c8'. (200 in hexadecimal)

Example implementations

C

• https://github.com/tiiffi/mcrcon (synchronous, Zlib license)

C#

• https://github.com/willroberts/minecraft-client-csharp (synchronous, GPL 3.0 license)

Dart

• https://github.com/aidanlok/mc_rcon (client, asynchronous, BSD 3-Clause license)

Go

• https://github.com/micvbang/pocketmine-rcon (synchronous, MIT license)
• https://github.com/willroberts/minecraft-client (asynchronous, GPL 3.0 license)
• https://godoc.org/github.com/Tnze/go-mc/net#RCONConn (client and server, synchronous, MIT license)

Java

• https://github.com/jobfeikens/rcon (synchronous, GPL 3.0 license)
• https://github.com/CatCoderr/JRcon (asynchronous, AGPL-3.0 license)

JavaScript

• https://github.com/tehbeard/node-rcon (Node.js, asynchronous, MIT license)
• https://github.com/MinecraftJS/rcon (Node.js, asynchronous, MIT license)
• https://github.com/EnriqCG/rcon-srcds (Node.js, asynchronous, MIT license)
• https://github.com/willroberts/minecraft-client-ts (Node.js, asynchronous, GPL 3.0 license)
• https://github.com/janispritzkau/rcon-client (Node.js, asynchronous, no license)

Kotlin

• https://github.com/willroberts/minecraft-client-kotlin (synchronous, GPL 3.0 license)

PHP

• https://gist.github.com/1292348 (synchronous, no license)

Python 3

• https://github.com/Iapetus-11/aio-mc-rcon (asynchronous, MIT license)
• https://github.com/MrReacher/async-mcrcon (asynchronous, MIT license)
• https://github.com/barneygale/MCRcon (synchronous, MIT license)
• https://github.com/coNQP/mcipc (synchronous, GPL 3.0 license)

Rust

• https://github.com/willroberts/minecraft-client-rs (synchronous, GPL 3.0 license)

Scala

• https://github.com/A2PLab/minelib (connection-per-request, no license)
• https://github.com/willroberts/minecraft-client-scala (synchronous, GPL 3.0 license)

Navigation

This article is licensed under a Creative Commons Attribution-ShareAlike 3.0 license.

 

This article has been imported from wiki.vg or is a derivative of such a page. Thus, the wiki's usual license does not apply.
Derivative works must be licensed using the same or a compatible license.