Relay - Revision history

B3b0tUzR at 12:44, 14 December 2021

2021-12-14T12:44:39Z

B3b0tUzR at 13:56, 8 December 2021

2021-12-08T13:56:55Z

B3b0tUzR at 13:55, 8 December 2021

2021-12-08T13:55:45Z

B3b0tUzR at 13:53, 8 December 2021

2021-12-08T13:53:48Z

B3b0tUzR at 12:28, 8 December 2021

2021-12-08T12:28:48Z

B3b0tUzR at 12:26, 8 December 2021

2021-12-08T12:26:47Z

B3b0tUzR at 12:24, 8 December 2021

2021-12-08T12:24:23Z

B3b0tUzR at 12:22, 8 December 2021

2021-12-08T12:22:08Z

B3b0tUzR at 12:21, 8 December 2021

2021-12-08T12:21:33Z

B3b0tUzR at 12:20, 8 December 2021

2021-12-08T12:20:17Z

@@ Line 82: / Line 82: @@
 Also beware that, if you use such public websocket, the AES-GCM encryption goes from optionnal to mandatory for privacy protection !
-So from version 0.7.21, Bebot(s) will also be able to jump into the room and all bots should speak together, no matter which.
+So from version 0.7.21 under PHP 7.0 or more, Bebot(s) will also be able to jump into the room and all bots should speak together, no matter which.
 For Bebot hosts, the WebSocket Relay is configured like this:

@@ Line 82: / Line 82: @@
 Also beware that, if you use such public websocket, the AES-GCM encryption goes from optionnal to mandatory for privacy protection !
-So from version 0.7.21, Bebot(s) will also be able to jump into the room and all should speak together.
+So from version 0.7.21, Bebot(s) will also be able to jump into the room and all bots should speak together, no matter which.
 For Bebot hosts, the WebSocket Relay is configured like this:

@@ Line 79: / Line 79: @@
 This is a compatible option available only into most recent bots (Bebot, Tyrbot, Nadybot). Most common choice is to use the websocket publicly provided for Nadybot.
-From there, your Nadybot(s) relay should be using websocket+highway+tyrbot layers (aes-gcm-encryption being optionnal) which will maximize the compatiliby with Tyrbot(s). You should check their respective documentation (as detailed lower) if you meet issues.
+From there, your Nadybot(s) relay should be using websocket+highway+tyrbot layers (aes-gcm-encryption being optionnal) which will maximize the compatiliby with Tyrbot(s). You should check their respective documentation (as detailed lower) if you ever met issues with those 2 bots.
 Also beware that, if you use such public websocket, the AES-GCM encryption goes from optionnal to mandatory for privacy protection !

@@ Line 87: / Line 87: @@
      /tell org1bot !set websocket Room example2-test0-room9-1234abc-xyz789
-     /tell org1bot !set websocket Key C0mpl3x-P4ssW0rD!
+     /tell org1bot !set websocket Password C0mpl3x-P4ssW0rD!
 Assuming that our Org1 is called “The proud and well-known fr00bs of Rubi Ka”, relayed messages from your guildchat would be displayed on Org2 as [Org2] Org2Bot: [The proud and well-known fr00bs of Rubi Ka] [Channel] Pigtail: Test. You might want to shorten that “The proud and well-known fr00bs of Rubi Ka” a bit:

@@ Line 24: / Line 24: @@
 Using tells as relay is discouraged nowadays (and you even run the risk of having your bots banned by funcom without warning), but we will describe it shortly nonetheless. Use at your own risk!
-Assuming you have two bots “bot1” and “bot2”, you start by allowing each bot to relay to each other. You could do a “!member add bot2” on bot1 and vice versa, but the member-list of org-bots might get wiped during roster-updates. Refer to section 2.3.2 as to how to create a new security group named “relaybots” with SUPERADMIN level on both bots and then make them member on the other bot's group.
+Assuming you have two bots “bot1” and “bot2”, you start by allowing each bot to relay to each other. You could do a “!member add bot2” on bot1 and vice versa, but the member-list of org-bots might get wiped during roster-updates. So rather refer to section 2.4.2 as to how to create a new security group named “relaybots” with SUPERADMIN level on both bots and then make them member on the other bot's group.
 If you've done this, you let bot1 relay to bot2:
@@ Line 296: / Line 296: @@
 Keep in mind that this setup only works if all your bots are using the same database. It's can't work elsewise.
-First, make sure to grant each of the bots involved in your network access to each other (either by using “!member add botX” or creating a special security group for this as described in 2.3.2. Now do the following (assuming there are three bots, named bot1, bot2 and bot3):
+First, make sure to grant each of the bots involved in your network access to each other (either by using “!member add botX” or creating a special security group for this as described in 2.4.2. Now do the following (assuming there are three bots, named bot1, bot2 and bot3):
      /tell bot1 !set Relay StrictNameCheck On

@@ Line 341: / Line 341: @@
 Then you'll have upto five "Hrelay" (HRelay1, HRelay2, HRelay3, HRelay4 and HRelay5) available in the !settings menu.
 You can edit any by its number, for example with number 1 you do :
-!settings HRelay1
+    !settings HRelay1
 It's then up to you to setup on the same model than described upper.
 Usually you'd use Channel mode, as Tells will be risky with many bots, & DB mode quite unusable for bots hosted separately.

@@ Line 272: / Line 272: @@
 '''2.4.4.2 At least one bot not using the same DB'''
-Starting from 0.6.3, the online-list of linked bots are automatically syncronized within !gcr protocol (not within !agcr), but all bots have to run at least 0.6.3 or higher for this to work. When you meet these requirements, proceed to set OtherBots as described in 2.3.4.1.
+Starting from 0.6.3, the online-list of linked bots are automatically syncronized within !gcr protocol (not within !agcr), but all bots have to run at least 0.6.3 or higher for this to work. When you meet these requirements, proceed to set OtherBots as described in 2.4.4.1.
 For other bots than Bebot, like Tyr or Buda/Nad, they have their own particular settings, so you have to read their documentation :

@@ Line 110: / Line 110: @@
 But to help you discover them faster, once your bot is connected into WebSocket & receiving messages, you could rather do :
      /tell org1bot !ws others
-This command should provide you with the wanted Tag list formatted to be copy-pasted to upper online set. Just beware that if some new Org joined in, or if any Org changed its Tag, you'd have to update & reset that online OtherBots value by redoing this process.
+This command should provide you with the wanted Tags list formatted to be copy-pasted to upper online set. Just beware that if some new Org joined in, or if any Org changed its Tag, you'd have to update & reset that online OtherBots value by redoing this process.
 Few other Websocket options are also into :

@@ Line 108: / Line 108: @@
 And as soon you discover more Org Tags you'd add them separated by commas ',' like this :
      /tell org1bot !set online OtherBots Org2Tag,Org3Tag,Org4Tag
-But to help you discover them, once your bot is connected into WebSocket and receiving messages, you can do :
+But to help you discover them faster, once your bot is connected into WebSocket & receiving messages, you could rather do :
      /tell org1bot !ws others
-Beware that if some new Org joins in, or if any Org ever changes its Tag, you'd have to update by reset that online OtherBots value.
+Just beware that if some new Org joined in, or if any Org changed its Tag, you'd have to update & reset that online OtherBots value.
 Few other Websocket options are also into :