RCON - Revision history

StalEF at 20:34, 20 April 2024

2024-04-20T20:34:27Z

← Older revision		Revision as of 22:34, 20 April 2024
Line 31:		Line 31:
	!Field\|\|Type\|\|\|Value		!Field\|\|Type\|\|\|Value
	\|-		\|-
	\|Size\|\|32-bit [[wiki:Endianness\|little-endian]] Signed [[Integer]]\|\|Varies, see below.		\|Size\|\|32-bit [[wiki:Endianness\|little-endian]] Signed Integer\|\|Varies, see below.
	\|-		\|-
	\|ID\|\|32-bit [[wiki:Endianness\|little-endian]] Signed [[Integer]]\|\|Varies, see below.		\|ID\|\|32-bit [[wiki:Endianness\|little-endian]] Signed Integer\|\|Varies, see below.
	\|-		\|-
	\|Type\|\|32-bit [[wiki:Endianness\|little-endian]] Signed [[Integer]]\|\|Varies, see below.		\|Type\|\|32-bit [[wiki:Endianness\|little-endian]] Signed Integer\|\|Varies, see below.
	\|-		\|-
	\|Body\|\|[[wiki:Null-terminated string\|Null-terminated]] ~~[[wiki:~~ASCII~~\|ASCII]] [[~~String]]\|\|Varies, see below.		\|Body\|\|[[wiki:Null-terminated string\|Null-terminated]] ASCII String\|\|Varies, see below.
	\|-		\|-
	\|Empty String\|\|[[wiki:Null-terminated string\|Null-terminated]] ~~[[wiki:~~ASCII~~\|ASCII]] [[~~String]]\|\|0x00		\|Empty String\|\|[[wiki:Null-terminated string\|Null-terminated]] ASCII String\|\|0x00
	\|-		\|-
	\|}		\|}
Line 51:		Line 51:
	\|4 Bytes\|\|Type Field		\|4 Bytes\|\|Type Field
	\|-		\|-
	\|At least 1 [[Byte]]\|\|Packet body (potentially empty)		\|At least 1 Byte\|\|Packet body (potentially empty)
	\|-		\|-
	\|1 Bytes\|\|Empty string terminator		\|1 Bytes\|\|Empty string terminator

StalEF at 20:31, 20 April 2024

2024-04-20T20:31:59Z

← Older revision		Revision as of 22:31, 20 April 2024
Line 47:		Line 47:
	!Size\|\|Containing		!Size\|\|Containing
	\|-		\|-
	\|4 ~~[[Byte\|~~Bytes]]\|\|ID Field		\|4 Bytes\|\|ID Field
	\|-		\|-
	\|4 ~~[[Byte\|~~Bytes]]\|\|Type Field		\|4 Bytes\|\|Type Field
	\|-		\|-
	\|At least 1 [[Byte]]\|\|Packet body (potentially empty)		\|At least 1 [[Byte]]\|\|Packet body (potentially empty)
	\|-		\|-
	\|1 ~~[[Byte\|~~Bytes]]\|\|Empty string terminator		\|1 Bytes\|\|Empty string terminator
	\|}		\|}
	====Packet ID====		====Packet ID====

Redwyre: Added picture of config

2021-08-21T14:09:04Z

Added picture of config

← Older revision		Revision as of 16:09, 21 August 2021
Line 4:		Line 4:
	=== Using Eco RCON ===		=== Using Eco RCON ===
	By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the [[Server Configuration\|Network plugin configuration]]. Servers without a valid password will reject all incoming authentication requests.		By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the [[Server Configuration\|Network plugin configuration]]. Servers without a valid password will reject all incoming authentication requests.

			[[File:RCON Settings in Network Config.png\|frame\|none\|rcon settings in network config]]

Silsha at 09:33, 14 May 2021

2021-05-14T09:33:36Z

← Older revision		Revision as of 11:33, 14 May 2021
Line 3:		Line 3:
	== Server Owner/Admin Documentation ==		== Server Owner/Admin Documentation ==
	=== Using Eco RCON ===		=== Using Eco RCON ===
	By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.		By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the [[Server Configuration\|Network plugin configuration]]. Servers without a valid password will reject all incoming authentication requests.

JohnK at 21:36, 3 May 2021

2021-05-03T21:36:41Z

← Older revision		Revision as of 23:36, 3 May 2021
Line 1:		Line 1:
	== Eco RCON Protocol ==		== Eco RCON (Remote Console) Protocol ==
	The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.		The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
	== Server Owner/Admin Documentation ==		== Server Owner/Admin Documentation ==

Thetestgame: Added link to chat commands page

2021-05-01T03:17:16Z

Added link to chat commands page

← Older revision		Revision as of 05:17, 1 May 2021
Line 6:		Line 6:


			When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution to ban a using the mcrcon tool linked in the tool section below.

	When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution to ban a using the mcrcon tool linked in the tool section below.		[[File:2021-04-30 22-04-51.mp4\|800px]]

	[[~~File:2021-04-30 22-04-51.mp4~~\|~~800px~~]]		A complete list of commands that can be used with RCON or in game can be found [[Chat_Commands\|here]].
	===Public Tools and Libraries===		===Public Tools and Libraries===
	Most standard tools for communicating with standard RCON will work with Eco RCON. A short list of known working tools can be found below		Most standard tools for communicating with standard RCON will work with Eco RCON. A short list of known working tools can be found below
Line 19:		Line 20:

	All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.		All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
	== Developer Documentation ==		== Developer Documentation==
	===Establishing a Connection===		===Establishing a Connection===
	To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.		To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
	=== Packet Structure===		===Packet Structure===
	====Basic Packet Structure====		==== Basic Packet Structure====
	All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket		All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
	{\| class="wikitable standard-table"		{\| class="wikitable standard-table"
Line 36:		Line 37:
	\|Body\|\|[[wiki:Null-terminated string\|Null-terminated]] [[wiki:ASCII\|ASCII]] [[String]]\|\|Varies, see below.		\|Body\|\|[[wiki:Null-terminated string\|Null-terminated]] [[wiki:ASCII\|ASCII]] [[String]]\|\|Varies, see below.
	\|-		\|-
	\|Empty String \|\|[[wiki:Null-terminated string\|Null-terminated]] [[wiki:ASCII\|ASCII]] [[String]]\|\|0x00		\|Empty String\|\|[[wiki:Null-terminated string\|Null-terminated]] [[wiki:ASCII\|ASCII]] [[String]]\|\|0x00
	\|-		\|-
	\|}		\|}
	==== Packet Size====		====Packet Size====
	The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.		The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
	{\| class="wikitable standard-table"		{\| class="wikitable standard-table"
Line 46:		Line 47:
	\|4 [[Byte\|Bytes]]\|\|ID Field		\|4 [[Byte\|Bytes]]\|\|ID Field
	\|-		\|-
	\|4 [[Byte\|Bytes]]\|\| Type Field		\|4 [[Byte\|Bytes]]\|\|Type Field
	\|-		\|-
	\|At least 1 [[Byte]]\|\|Packet body (potentially empty)		\|At least 1 [[Byte]]\|\|Packet body (potentially empty)
Line 54:		Line 55:
	====Packet ID====		====Packet ID====
	The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.		The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
	==== Packet Type====		====Packet Type ====
	The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.		The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
	{\| class="wikitable standard-table"		{\| class="wikitable standard-table"
Line 61:		Line 62:
	\|3\|\|SERVERDATA_AUTH		\|3\|\|SERVERDATA_AUTH
	\|-		\|-
	\|2\|\|SERVERDATA_AUTH_RESPONSE		\|2\|\| SERVERDATA_AUTH_RESPONSE
	\|-		\|-
	\|2\|\|SERVERDATA_EXECCOMMAND		\|2\|\|SERVERDATA_EXECCOMMAND
Line 67:		Line 68:
	\|0\|\|SERVERDATA_RESPONSE_VALUE		\|0\|\|SERVERDATA_RESPONSE_VALUE
	\|}		\|}
	====Packet Body====		====Packet Body ====
	The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.		The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
	====Packet Types====		====Packet Types====
Line 73:		Line 74:
	'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:		'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
	{\| class="wikitable"		{\| class="wikitable"
	! Field		!Field
	!Contains		!Contains
	\|-		\|-
Line 90:		Line 91:
	{\| class="wikitable"		{\| class="wikitable"
	!Field		!Field
	!Contains		! Contains
	\|-		\|-
	\|ID		\|ID
Line 99:		Line 100:
	\|-		\|-
	\|Body		\|Body
	\|Empty string (0x00)		\| Empty string (0x00)
	\|}		\|}
	====='''SERVERDATA_EXECCOMMAND'''=====		====='''SERVERDATA_EXECCOMMAND'''=====
Line 114:		Line 115:
	\|-		\|-
	\|Body		\|Body
	\| the command to be executed on the server		\|the command to be executed on the server
	\|}		\|}
	====='''SERVERDATA_RESPONSE_VALUE'''=====		====='''SERVERDATA_RESPONSE_VALUE'''=====
Line 123:		Line 124:
	\|-		\|-
	\|ID		\|ID
	\|The ID assigned by the original request		\| The ID assigned by the original request
	\|-		\|-
	\|Type		\|Type
	\|0		\|0
	\|-		\|-
	\| Body		\|Body
	\|The server's response to the original command.		\|The server's response to the original command.
	\|}		\|}

Thetestgame at 03:09, 1 May 2021

2021-05-01T03:09:58Z

← Older revision		Revision as of 05:09, 1 May 2021
Line 1:		Line 1:
	== Eco RCON Protocol ==		== Eco RCON Protocol ==
	The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.		The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.

	== Server Owner/Admin Documentation ==		== Server Owner/Admin Documentation ==

	=== Using Eco RCON ===		=== Using Eco RCON ===
	By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.		By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.


	When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution using the mcrcon tool linked in the tools/libraries section below.

	[[File:~~RconExample~~.~~png~~\|800px]]		When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution to ban a using the mcrcon tool linked in the tool section below.

			[[File:2021-04-30 22-04-51.mp4\|800px]]
	===Public Tools and Libraries===		===Public Tools and Libraries===
	Most standard tools for communicating with standard RCON will work with Eco RCON. A short list of known working tools can be found below		Most standard tools for communicating with standard RCON will work with Eco RCON. A short list of known working tools can be found below
Line 20:		Line 19:

	All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.		All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.

	== Developer Documentation ==		== Developer Documentation ==

	===Establishing a Connection===		===Establishing a Connection===
	To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.		To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.

Thetestgame: Adjusted the document into a developer and user section

2021-05-01T00:40:07Z

Adjusted the document into a developer and user section

← Older revision		Revision as of 02:40, 1 May 2021
Line 1:		Line 1:
	== Eco RCON Protocol ==		== Eco RCON Protocol ==
	The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.		The Eco RCON Protocol is a TCP based communication protocol loosely based on the Source RCON Protocol standard. It allows admin commands to be issued to the server via a "remote console". The most common use of RCON is to allow server owners to control their game servers without being in game for easy administration or automated processes.
	== Using Eco RCON ==
			== Server Owner/Admin Documentation ==

			=== Using Eco RCON ===
	By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.		By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.



Line 10:		Line 12:
	[[File:RconExample.png\|800px]]		[[File:RconExample.png\|800px]]
	===Public Tools and Libraries===		===Public Tools and Libraries===
	Most standard tools~~/libraries~~ for communicating with standard RCON will work with Eco RCON. A short list of known working tools ~~and libraries~~ can be found below		Most standard tools for communicating with standard RCON will work with Eco RCON. A short list of known working tools can be found below

	'''Tools'''		'''Tools'''
	*https://github.com/n0la/rcon (RCON command line tool)		*https://github.com/n0la/rcon (RCON command line tool)
	*https://github.com/Tiiffi/mcrcon (RCON command line client)		*https://github.com/Tiiffi/mcrcon (RCON command line client)
	~~'''Libraries'''~~
	*https://github.com/Subtixx/source-rcon-library (C# Library)


	All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.		All command requests sent through RCON are executed with server admin permissions. For best practice its advised you keep your RCON information secure and only let trusted users or trusted programs access your RCON server.
	==Establishing a Connection==
			== Developer Documentation ==

			===Establishing a Connection===
	To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.		To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
	== Packet Structure==		=== Packet Structure===
	===Basic Packet Structure===		====Basic Packet Structure====
	All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket		All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
	{\| class="wikitable standard-table"		{\| class="wikitable standard-table"
Line 39:		Line 42:
	\|-		\|-
	\|}		\|}
	=== Packet Size===		==== Packet Size====
	The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.		The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
	{\| class="wikitable standard-table"		{\| class="wikitable standard-table"
Line 52:		Line 55:
	\|1 [[Byte\|Bytes]]\|\|Empty string terminator		\|1 [[Byte\|Bytes]]\|\|Empty string terminator
	\|}		\|}
	===Packet ID===		====Packet ID====
	The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.		The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
	=== Packet Type===		==== Packet Type====
	The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.		The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
	{\| class="wikitable standard-table"		{\| class="wikitable standard-table"
Line 67:		Line 70:
	\|0\|\|SERVERDATA_RESPONSE_VALUE		\|0\|\|SERVERDATA_RESPONSE_VALUE
	\|}		\|}
	===Packet Body===		====Packet Body====
	The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.		The packet body field is a null-terminated ASCII encoded string. The contents of the packet body vary by the executed request.
	===Packet Types===		====Packet Types====
	===='''SERVERDATA_AUTH'''====		====='''SERVERDATA_AUTH'''=====
	'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:		'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
	{\| class="wikitable"		{\| class="wikitable"
Line 86:		Line 89:
	\|}		\|}
	'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.		'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
	===='''SERVERDATA_AUTH_RESPONSE'''====		====='''SERVERDATA_AUTH_RESPONSE'''=====
	'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.		'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
	{\| class="wikitable"		{\| class="wikitable"
Line 101:		Line 104:
	\|Empty string (0x00)		\|Empty string (0x00)
	\|}		\|}
	===='''SERVERDATA_EXECCOMMAND'''====		====='''SERVERDATA_EXECCOMMAND'''=====
	'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.		'''SERVERDATA_EXECCOMMAND''' represents a command issued to the server by a client. This can be any valid player or admin command that does not require a physical player in the world to execute. The response will vary depending on the command issued.
	{\| class="wikitable"		{\| class="wikitable"
Line 116:		Line 119:
	\| the command to be executed on the server		\| the command to be executed on the server
	\|}		\|}
	===='''SERVERDATA_RESPONSE_VALUE'''====		====='''SERVERDATA_RESPONSE_VALUE'''=====
	'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.		'''SERVERDATA_RESPONSE_VALUE''' is sent when a command had finished executing from a '''SERVERDATA_EXECCOMMAND''' request and contains the chat displayed results of the requested command.
	{\| class="wikitable"		{\| class="wikitable"

Thetestgame: Added proper example image

2021-04-29T19:48:56Z

Added proper example image

← Older revision		Revision as of 21:48, 29 April 2021
Line 8:		Line 8:
	When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution using the mcrcon tool linked in the tools/libraries section below.		When executing a command through ECO RCON you do not need to supply the forward slash like you would in game. Below is an example of remote command execution using the mcrcon tool linked in the tools/libraries section below.

	~~https~~:~~//i.gyazo.com/1b0bc2d991d5c780d0376adc4ec46411~~.png		[[File:RconExample.png\|800px]]
	===Public Tools and Libraries===		===Public Tools and Libraries===
	Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below		Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below
Line 22:		Line 22:
	==Establishing a Connection==		==Establishing a Connection==
	To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.		To establish a TCP connection to an Eco RCON server you need to know the server's configured RCON port and the server's configured password and connect via a standard TCP client. Once connected you must authenticate your selves by sending a '''SERVERDATA_AUTH''' packet. Failure to do so will result in no response. If your authentication request was successful you should receive back a '''SERVERDATA_AUTH_RESPONSE''' packet with a matching id of the authentication request packet. Receiving an packet id of -1 means the authentication request has failed. An authentication request can fail if the password is incorrect, misconfigured, or if there is already an active RCON client connection.
	==Packet Structure==		== Packet Structure==
	===Basic Packet Structure===		===Basic Packet Structure===
	All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket		All Eco RCON packets payloads follow this basic structure and are sent over a TCP socket
	{\| class="wikitable standard-table"		{\| class="wikitable standard-table"
	!Field\|\|Type\|\|\| Value		!Field\|\|Type\|\|\|Value
	\|-		\|-
	\|Size\|\|32-bit [[wiki:Endianness\|little-endian]] Signed [[Integer]]\|\|Varies, see below.		\|Size\|\|32-bit [[wiki:Endianness\|little-endian]] Signed [[Integer]]\|\|Varies, see below.
Line 34:		Line 34:
	\|Type\|\|32-bit [[wiki:Endianness\|little-endian]] Signed [[Integer]]\|\|Varies, see below.		\|Type\|\|32-bit [[wiki:Endianness\|little-endian]] Signed [[Integer]]\|\|Varies, see below.
	\|-		\|-
	\|Body \|\|[[wiki:Null-terminated string\|Null-terminated]] [[wiki:ASCII\|ASCII]] [[String]]\|\|Varies, see below.		\|Body\|\|[[wiki:Null-terminated string\|Null-terminated]] [[wiki:ASCII\|ASCII]] [[String]]\|\|Varies, see below.
	\|-		\|-
	\|Empty String \|\|[[wiki:Null-terminated string\|Null-terminated]] [[wiki:ASCII\|ASCII]] [[String]]\|\|0x00		\|Empty String \|\|[[wiki:Null-terminated string\|Null-terminated]] [[wiki:ASCII\|ASCII]] [[String]]\|\|0x00
	\|-		\|-
	\|}		\|}
	===Packet Size===		=== Packet Size===
	The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.		The RCON packet size field is represented by a 32-bit little endian integer, It represents the total length of the request in bytes. Note that the '''packet size''' field itself is '''not''' included when determining the size of the packet, so the value of this field is always 4 less than the packet's actual length. The minimum possible value for '''packet size''' is 14.
	{\| class="wikitable standard-table"		{\| class="wikitable standard-table"
	! Size\|\|Containing		!Size\|\|Containing
	\|-		\|-
	\| 4 [[Byte\|Bytes]]\|\|ID Field		\|4 [[Byte\|Bytes]]\|\|ID Field
	\|-		\|-
	\|4 [[Byte\|Bytes]]\|\|Type Field		\|4 [[Byte\|Bytes]]\|\| Type Field
	\|-		\|-
	\|At least 1 [[Byte]]\|\|Packet body (potentially empty)		\|At least 1 [[Byte]]\|\|Packet body (potentially empty)
	\|-		\|-
	\| 1 [[Byte\|Bytes]]\|\|Empty string terminator		\|1 [[Byte\|Bytes]]\|\|Empty string terminator
	\|}		\|}
	===Packet ID ===		===Packet ID===
	The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.		The packet id field is a 32-bit little endian integer which is specified by the requesting client for each request. Its value can be any positive integer. When the server responds to a client request it will send back the same packet id it received for that command request allowing you match the original request to the server response.
	===Packet Type===		=== Packet Type===
	The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.		The packet type field is represented by a 32-bit little endian integer. It the intended purpose of the packet.
	{\| class="wikitable standard-table"		{\| class="wikitable standard-table"
	!Value\|\|String Descriptor		!Value\|\|String Descriptor
	\|-		\|-
	\| 3\|\| SERVERDATA_AUTH		\|3\|\|SERVERDATA_AUTH
	\|-		\|-
	\|2\|\|SERVERDATA_AUTH_RESPONSE		\|2\|\|SERVERDATA_AUTH_RESPONSE
Line 65:		Line 65:
	\|2\|\|SERVERDATA_EXECCOMMAND		\|2\|\|SERVERDATA_EXECCOMMAND
	\|-		\|-
	\|0\|\| SERVERDATA_RESPONSE_VALUE		\|0\|\|SERVERDATA_RESPONSE_VALUE
	\|}		\|}
	===Packet Body===		===Packet Body===
Line 73:		Line 73:
	'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:		'''SERVERDATA_AUTH''' is the first packet to be sent by a newly connected client. It is used to authenticate with the RCON server and gain access to the '''SERVERDATA_EXECCOMMAND''' request. The values of this packet type's fields are as follows:
	{\| class="wikitable"		{\| class="wikitable"
	!Field		! Field
	!Contains		!Contains
	\|-		\|-
	\|ID		\|ID
	\| any positive integer, chosen by the client (will be mirrored back in the server's response)		\|any positive integer, chosen by the client (will be mirrored back in the server's response)
	\|-		\|-
	\| Type		\|Type
	\|3		\|3
	\|-		\|-
	\|Body		\|Body
	\|the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)		\| the RCON password of the server (If this field matches the password set in the Network configuration the auth request will succeed)
	\|}		\|}
	'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.		'''Note''': If the password is not properly configured on the server all '''SERVERDATA_AUTH''' requests will be refused.
Line 89:		Line 89:
	'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.		'''SERVERDATA_AUTH_RESPONSE''' is the response notification packet of a client's '''SERVERDATA_AUTH''' request and contains the results of its authentication attempt. The status is represented by the id of the packet. A -1 value denotes a failed authentication request. If authentication was a success it matches the packet id provided in the original authentication request.
	{\| class="wikitable"		{\| class="wikitable"
	! Field		!Field
	!Contains		!Contains
	\|-		\|-
Line 128:		Line 128:
	\|0		\|0
	\|-		\|-
	\|Body		\| Body
	\|The server's response to the original command.		\|The server's response to the original command.
	\|}		\|}

Thetestgame at 19:14, 29 April 2021

2021-04-29T19:14:27Z

← Older revision		Revision as of 21:14, 29 April 2021
Line 3:		Line 3:
	== Using Eco RCON ==		== Using Eco RCON ==
	By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.		By default, Eco's RCON implementation listens on TCP port 3002. This setting can be changed inside the network configuration options as well as the IP/host address the RCON server binds to. To use RCON a valid password must be set inside the Network plugin configuration. Servers without a valid password will reject all incoming authentication requests.



Line 8:		Line 9:

	https://i.gyazo.com/1b0bc2d991d5c780d0376adc4ec46411.png		https://i.gyazo.com/1b0bc2d991d5c780d0376adc4ec46411.png

	===Public Tools and Libraries===		===Public Tools and Libraries===
	Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below		Most standard tools/libraries for communicating with standard RCON will work with Eco RCON. A short list of known working tools and libraries can be found below
Line 133:		Line 133:
	__NOEDITSECTION__		__NOEDITSECTION__
	[[Category:Server Management]]		[[Category:Server Management]]
			[[Category:Modding]]