Editing RCON

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
 
{{Documentation}}
 
{{Documentation}}
  
The '''Remote Console''' ('''RCON''') tools exist to help you administer your server without connecting as a player.
+
The '''Remote Console''' ('''Rcon''') tools exist to help you administer your server without connecting as a player.
  
There are two ways to invoke RCON: HTTP Requests, and the RCON Protocol.
+
There are two ways to invoke Rcon: HTTP Requests, and the Rcon Protocol.
  
 
== Setup ==
 
== Setup ==
  
 
''to-doc''
 
''to-doc''
The setup process is not finalized yet, as I want you to be able to assign RCON keys permissions and configure the port in the server config.
+
The setup process isn't finalized yet, as I want you to be able to assign Rcon keys permissions and configure the port in the server config.
  
 
== HTTP Requests ==
 
== HTTP Requests ==
Line 20: Line 20:
 
! Value
 
! Value
 
|-
 
|-
| Command || ID of a command as it would be used in chat, such as <code>teleport</code> or <code>tp</code>
+
| Command || Id of a command as would be used in chat, e.g. teleport or tp  
 
|-
 
|-
| Key || An authorized RCON key you have assigned permissions to run this command.
+
| Key || An authorized Rcon key you've assigned permissions to run this command.
 
|-
 
|-
| Arg || Key = Value pairs of arguments to the command.
+
| Arg || Key=Value pairs of arguments to the command.
 
|}
 
|}
  
Line 36: Line 36:
 
</pre>
 
</pre>
  
Whereas a failed response which did not execute a command will contain an error explanation:
+
Whereas a failed response which didn't execute a command will contain an error explanation:
  
 
<pre>
 
<pre>
Line 45: Line 45:
 
</pre>
 
</pre>
  
== RCON Protocol ==
+
== Rcon Protocol ==
  
 
Using the protocol is more complex than the HTTP requests, but has the advantage of streaming log data from the server.
 
Using the protocol is more complex than the HTTP requests, but has the advantage of streaming log data from the server.
  
To keep things simple it is implemented as null-terminated UTF8 messages over a TCP socket connection.
+
To keep things simple it's implemented as null-terminated UTF8 messages over a TCP socket connection.
  
All RCON messages start with "RCON" followed by the version number, the type of message and then any parameters.
+
All Rcon messages start with "RCON" followed by the version number, the type of message and then any parameters.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 86: Line 86:
 
==== Execute Command ====
 
==== Execute Command ====
  
Can be sent once you have authenticated to execute a command.
+
Can be sent once you've authenticated to execute a command.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 220: Line 220:
 
==== Ping ====
 
==== Ping ====
  
Sent by the server to check that you are still alive. You should send back a PONG or you will be disconnected.
+
Sent by the server to check that you're still alive. You should send back a PONG or you'll be disconnected.
  
 
{| class="wikitable"
 
{| class="wikitable"
Cancel Editing help (opens in new window)