From d6bc0d2a79c5fbef824f665350ced2c599cd2d81 Mon Sep 17 00:00:00 2001 From: Jessica James Date: Fri, 29 Oct 2021 13:42:28 -0500 Subject: [PATCH] Improve RenX.FuckCronus/README.md --- src/Plugins/RenX/RenX.FuckCronus/README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/src/Plugins/RenX/RenX.FuckCronus/README.md b/src/Plugins/RenX/RenX.FuckCronus/README.md index 4e46591..97b9887 100644 --- a/src/Plugins/RenX/RenX.FuckCronus/README.md +++ b/src/Plugins/RenX/RenX.FuckCronus/README.md @@ -1,4 +1,18 @@ -== Function == +# Setup +1) Setup Jupiter on the same server as your game server +2) Add `RenX.Listen` and `RenX.FuckCronus` to your root `Config.ini` +3) Configure `RenX-ListenServer` (see RenX.Listen.ini) server block in `RenX.Core.ini`. These are the settings for any servers which connect to your bot. +4) In UDKRenegadeX.ini on the game server, replace `devbot.ren-x.com` with `127.0.0.1` +5) Startup Jupiter Bot +6) Startup game server +7) Verify your server is listed on the RenX server list + +### Optional: +It's also possible to use this plugin as a general proxy for devbot traffic, so that you can change the listed IP address of your game server. To do this: +1) Setup Jupiter on the server (i.e: proxy node) you wish to have listed instead of your game server +2) Follow the same steps as above, except use your proxy node's IP address instead of `127.0.0.1` + +# Function Sanitizes logs going to the Renegade X devbot (server list), and sanitizes commands coming from the Renegade X devbot. @@ -6,7 +20,7 @@ When all sanitizations are disabled, this can also be used to change the listed without relying on Cronus. This is done by hosting Jupiter on the IP address you wish to have listed, and routing traffic from there. -== Rationale == +# Rationale *Short*: Thieves shouldn't be trusted with personally identifiable information. This prevents that.