Difference between revisions of "RCON"

From SDG Wiki
Jump to: navigation, search
m (MoltonMontro moved page Rcon to RCON without leaving a redirect)
(Some minor touch-ups)
Line 1: Line 1:
 
{{Ambox/Documentation}}
 
{{Ambox/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 isn't 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 is not 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 would be used in chat, e.g. teleport or tp  
+
| Command || ID of a command as it would be used in chat, such as <code>teleport</code> or <code>tp</code>
 
|-
 
|-
| Key || An authorized Rcon key you've assigned permissions to run this command.
+
| Key || An authorized RCON key you have 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 didn't execute a command will contain an error explanation:
+
Whereas a failed response which did not 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's implemented as null-terminated UTF8 messages over a TCP socket connection.
+
To keep things simple it is 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've authenticated to execute a command.
+
Can be sent once you have authenticated to execute a command.
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 220: Line 220:
 
==== Ping ====
 
==== Ping ====
  
Sent by the server to check that you're still alive. You should send back a PONG or you'll be disconnected.
+
Sent by the server to check that you are still alive. You should send back a PONG or you will be disconnected.
  
 
{| class="wikitable"
 
{| class="wikitable"

Revision as of 16:28, 2 July 2018

Template:Ambox/Documentation

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.

Setup

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.

HTTP Requests

Intended for web-based control panels to run commands on the server.

Requests can be sent to {Server}/rcon/{Command}?key={Key}&arg1=value1&arg2=value2.

Key Value
Command ID of a command as it would be used in chat, such as teleport or tp
Key An authorized RCON key you have assigned permissions to run this command.
Arg Key = Value pairs of arguments to the command.

Responses are returned in JSON. If a command was found and executed the response looks like:

{
    "Success": true,
    "Output": "{Logs}"
}

Whereas a failed response which did not execute a command will contain an error explanation:

{
    "Success": false,
    "Error": "{Explanation}"
}

RCON Protocol

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.

All RCON messages start with "RCON" followed by the version number, the type of message and then any parameters.

RCON Version Type Parameters

Client to Server Messages

Authentication

Should be the first packet you send. Wait for an AUTH reply from the server as notification that you were approved for login, or ERR if you were rejected.

Key Value
RCON RCON
Version 1
Type AUTH
Parameters Authorized RCON key.

Example:

RCON 1 AUTH MySecretKey

Execute Command

Can be sent once you have authenticated to execute a command.

Key Value
RCON RCON
Version 1
Type CMD
Parameters Command as would be used in chat.

Example:

RCON 1 CMD teleport -from=player1 -to=player2

Ping

Request a PONG from the server.

Key Value
RCON RCON
Version 1
Type PING
Parameters None.

Example:

RCON 1 PING

Pong

Should be sent in reply to a PING from the server.

Key Value
RCON RCON
Version 1
Type PONG
Parameters None.

Example:

RCON 1 PONG

Server to Client Messages

Welcome

Sent after your AUTH packet is verified and approved for login.

Key Value
RCON RCON
Version 1
Type AUTH
Parameters None.

Example:

RCON 1 AUTH

Error

Sent if your AUTH packet was denied, or a packet you sent was malformed.

Key Value
RCON RCON
Version 1
Type ERR
Parameters Explanation of error.

Example:

RCON 1 ERR Bad Key

Log Relay

Sent to mirror log messages that were printed on the server.

Key Value
RCON RCON
Version 1
Type LOG
Parameters Line(s) of output relayed from the log.

Example:

RCON 1 LOG LogAIModule: Creating AISystem for world Devtest

Ping

Sent by the server to check that you are still alive. You should send back a PONG or you will be disconnected.

Key Value
RCON RCON
Version 1
Type PING
Parameters None.

Example:

RCON 1 PING

Pong

Received in response to a PING you sent the server. The time difference between when you sent your PING and got this PONG is the travel time to the server plus the processing time on the server plus the travel time back.

Key Value
RCON RCON
Version 1
Type PONG
Parameters None.

Example:

RCON 1 PONG

Template:Navbox/Tutorials