From d915b9ee06d027683ae5f1e3fa0005daf0adcc05 Mon Sep 17 00:00:00 2001 From: Rafael Ibasco <13303385+ribasco@users.noreply.github.com> Date: Tue, 28 Jun 2022 13:35:32 +0800 Subject: [PATCH] Added note about rust rcon. See issues #86 and #87. Signed-off-by: Rafael Ibasco <13303385+ribasco@users.noreply.github.com> --- site/markdown/examples/source_rcon_example.md | 25 +++++++++++++------ 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/site/markdown/examples/source_rcon_example.md b/site/markdown/examples/source_rcon_example.md index 3ceb109444..0e0418609d 100644 --- a/site/markdown/examples/source_rcon_example.md +++ b/site/markdown/examples/source_rcon_example.md @@ -2,13 +2,14 @@ 1. [Failsafe Features](#failsafe-features) 2. [Examples](#examples) - 1. [Authentication](#authentication) - 2. [Commands](#commands) - 3. [Invalidating credentials](#invalidating-credentials) - 4. [Cleanup Connections](#cleaning-up-active-connections) - 5. [Display connection statistics](#display-connection-statistics) - 6. [Providing your own custom CredentialsStore implementation](#providing-your-own-custom-credentialsstore-implementation) - 7. [Compatibility with non-source games](#compatibility-with-non-source-games) + 1. [Authentication](#authentication) + 2. [Commands](#commands) + 3. [Invalidating credentials](#invalidating-credentials) + 4. [Cleanup Connections](#cleaning-up-active-connections) + 5. [Display connection statistics](#display-connection-statistics) + 6. [Providing your own custom CredentialsStore implementation](#providing-your-own-custom-credentialsstore-implementation) + 7. [Compatibility with non-source games](#compatibility-with-non-source-games) +3. [Note about Rust RCON](#rust-rcon-support) #### About this module @@ -300,4 +301,12 @@ class NonSourceBasedGames { } } -``` \ No newline at end of file +``` + +#### Rust Rcon Support + +To make this library work with rust, please ensure that you start the server with ` "+rcon.web 0"` to enable legcy mode. + +It's also worth noting that Facepunch will eventually [remove](https://github.com/Facepunch/webrcon) legacy mode (source protocol implementation) sometime in the future and will be replaced by their websockets implementation as the default. + +Currently, there are no plans to support the web sockets version. \ No newline at end of file