Editing Relay
From Bebot Wiki 2
Jump to navigationJump to searchWarning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 18: | Line 18: | ||
'''2.1 Using tells''' | '''2.1 Using tells''' | ||
− | PROS: | + | PROS: easy setup, no relay-bot needed |
− | + | CONS: Only works with 2 bots, possibly illegal, tells might be dropped by the server if coming in to fast1) | |
− | CONS: Only works with 2 bots, possibly | ||
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! | 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. | + | 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. |
If you've done this, you let bot1 relay to bot2: | If you've done this, you let bot1 relay to bot2: | ||
Line 52: | Line 51: | ||
'''2.2 Using IRC''' | '''2.2 Using IRC''' | ||
− | PROS: scales well, no relay-bot needed, | + | PROS: scales well, no relay-bot needed, easy setup, allows linking between different game-servers and even games |
− | + | CONS: increases latency, order of messages not guaranteed, item-references will be broken, possibly insecure, doesn't look as nice as the other links | |
− | CONS: increases latency, order of messages not guaranteed, item- | ||
Before you start, please acknowledge that relaying via IRC is considered deprecated, yet it will still work. | Before you start, please acknowledge that relaying via IRC is considered deprecated, yet it will still work. | ||
Line 72: | Line 70: | ||
− | '''2.3 Using | + | '''2.3 Using a private channel''' |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | + | PROS: scales up to 1000 bots, best speed, possible sharing of online-lists if all bots are using the same DB | |
− | + | CONS: Needs a dedicated relay-bot | |
− | |||
− | |||
− | + | The fastest and most flexible solution is relaying via a private group. All bots you want to connect have to join the same private group and exchange messages via means of !gcr. For this to work, we need a new type of bot, a relay-bot, which has the job of creating the private group and inviting all other bots into this group whenever necessary. The org/raid-bots on the other hand are configured much like a tell-relay. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | The fastest and most flexible solution is relaying via a private group. All bots you want to connect have to join the same private group and exchange messages. For this to work, we need a new type of bot, a relay-bot, which has the job of creating the private group and inviting all other bots into this group whenever necessary. The org/raid-bots on the other hand are configured much like a tell-relay. | ||
CAVEAT: Before setting up everything, create all the bots you will need and make sure that some time passes so every bot has WHOIS-information on every bot involved. This will wipe out any possible problem related to people and bots not seeing each other. | CAVEAT: Before setting up everything, create all the bots you will need and make sure that some time passes so every bot has WHOIS-information on every bot involved. This will wipe out any possible problem related to people and bots not seeing each other. | ||
− | '''2. | + | '''2.3.1 Setting up the relay-bot''' |
Your most important bot is the relay-bot. Its only task is to be online, create the private channel which is used for the communication between your bots and invite all bots you want to link together to this chat. Nothing more. If your relay-bot is offline, your link will be gone, though your raid/guild-bots will continue to work. Once the relay-bot comes on again and all guild/org-bots are invited, the link will work again. | Your most important bot is the relay-bot. Its only task is to be online, create the private channel which is used for the communication between your bots and invite all bots you want to link together to this chat. Nothing more. If your relay-bot is offline, your link will be gone, though your raid/guild-bots will continue to work. Once the relay-bot comes on again and all guild/org-bots are invited, the link will work again. | ||
Line 182: | Line 135: | ||
− | '''2. | + | '''2.3.2 Setting up the org/raid-bots''' |
On your org-bots and raid-bots, you will need to make them use the relaybot's private group as their private group for relaying. | On your org-bots and raid-bots, you will need to make them use the relaybot's private group as their private group for relaying. | ||
Line 207: | Line 160: | ||
Therefore you'll send to relay-bot only while using this 1st letter (in org or private channel) : | Therefore you'll send to relay-bot only while using this 1st letter (in org or private channel) : | ||
@ Hello to other orgs | @ Hello to other orgs | ||
− | Note : this syntax will be | + | Note : this syntax will be ignored by bot's org <-> local private relay. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
Now that it's done, every org/raid-bot host configured like this should be in the private chat of the relaybot. If they aren't there already, either wait a bit, or join the relay-bot's private group and !invite them one by one. The only thing missing is to configure those bots to allow all linked bots to send them relay-messages via !gcr (or !agcr). Per default for security, only member with the access level MEMBER is allowed to do this. | Now that it's done, every org/raid-bot host configured like this should be in the private chat of the relaybot. If they aren't there already, either wait a bit, or join the relay-bot's private group and !invite them one by one. The only thing missing is to configure those bots to allow all linked bots to send them relay-messages via !gcr (or !agcr). Per default for security, only member with the access level MEMBER is allowed to do this. | ||
Line 245: | Line 186: | ||
− | '''2. | + | '''2.3.3 Scalability''' |
If you understood what we've just configured, you might have noticed that you can use a single relay-bot to manage different guild-links. If, for example, you now decide that you want to seperate your org-link and your raid-link you can achive this by making all org-bots member of the relaybots security-group on all org-bots (but not on any raid-bot) and all raid-bots members of the security-group relaybots on all raid-bots (but not on any org-bot). This way, you can use a single relay for several totally different relay-groups. The only proble being that the bot-admin can only decide from which bot he/she wants to receive messages, but not to which bots messages should be relayed. So you have to trust each other if you really plan such a weird setup. | If you understood what we've just configured, you might have noticed that you can use a single relay-bot to manage different guild-links. If, for example, you now decide that you want to seperate your org-link and your raid-link you can achive this by making all org-bots member of the relaybots security-group on all org-bots (but not on any raid-bot) and all raid-bots members of the security-group relaybots on all raid-bots (but not on any org-bot). This way, you can use a single relay for several totally different relay-groups. The only proble being that the bot-admin can only decide from which bot he/she wants to receive messages, but not to which bots messages should be relayed. So you have to trust each other if you really plan such a weird setup. | ||
Line 252: | Line 193: | ||
− | '''2. | + | '''2.3.4 Sharing the online-list across several bots''' |
If you are building a bot-network, you will most likely be interested in knowing who is online. And this includes all linked orgs, not just your own. Luckily, this is possible. There are two cases to consider: | If you are building a bot-network, you will most likely be interested in knowing who is online. And this includes all linked orgs, not just your own. Luckily, this is possible. There are two cases to consider: | ||
− | '''2. | + | '''2.3.4.1 All bots use the same DB''' |
If you want to share the online-list of all your bots, you need all org/raid-bots to use the same database. Then you only need to tell each bot about all the other bots: | If you want to share the online-list of all your bots, you need all org/raid-bots to use the same database. Then you only need to tell each bot about all the other bots: | ||
Line 270: | Line 211: | ||
− | '''2. | + | '''2.3.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 ! | + | Starting from 0.6.3, the online-list of linked bots are automatically syncronized within !grc 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. |
For other bots than Bebot, like Tyr or Buda/Nad, they have their own particular settings, so you have to read their documentation : | For other bots than Bebot, like Tyr or Buda/Nad, they have their own particular settings, so you have to read their documentation : | ||
Line 282: | Line 223: | ||
Tyr: may support agcr natively, requires extra module for !gcr https://github.com/Budabot/Tyrbot/tree/master/modules/extra/relay_gcr | Tyr: may support agcr natively, requires extra module for !gcr https://github.com/Budabot/Tyrbot/tree/master/modules/extra/relay_gcr | ||
− | Or do !help in tell with the host bot to check the way to set it up well for ! | + | Or do !help in tell with the host bot to check the way to set it up well for !grc protocol (or !agcr without online lists). |
− | |||
− | + | '''2.4 Using a shared database''' | |
− | '''2. | ||
PROS: ok speed (2s delay max), sharing of online-lists, no relay-bot needed | PROS: ok speed (2s delay max), sharing of online-lists, no relay-bot needed | ||
− | |||
CONS: All bots need to be using the same database | CONS: All bots need to be using the same database | ||
Line 296: | Line 234: | ||
Keep in mind that this setup only works if all your bots are using the same database. It's can't work elsewise. | 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. | + | 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): |
/tell bot1 !set Relay StrictNameCheck On | /tell bot1 !set Relay StrictNameCheck On | ||
Line 331: | Line 269: | ||
'''4. Extension''' | '''4. Extension''' | ||
− | PROS : can connect to more than one relay | + | PROS : can connect to more than one relay CONS : uses !agcr protocol without online list sharing. |
− | |||
− | CONS : uses !agcr protocol without online list sharing | ||
You may have to connect your bot to more than one relay channel, several networks at the same time. | You may have to connect your bot to more than one relay channel, several networks at the same time. | ||
Line 341: | Line 277: | ||
Then you'll have upto five "Hrelay" (HRelay1, HRelay2, HRelay3, HRelay4 and HRelay5) available in the !settings menu. | 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 : | You can edit any by its number, for example with number 1 you do : | ||
− | + | !settings HRelay1 | |
It's then up to you to setup on the same model than described upper. | 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. | Usually you'd use Channel mode, as Tells will be risky with many bots, & DB mode quite unusable for bots hosted separately. |