Archive > 0.3.x Custom/Unofficial Modules

Relay.php (Replaces GuildRelay_GUILD.php and Relay_GUILD.php)

(1/6) > >>

Ebag333:
This module is now included in SVN.  Please download from there to ensure that you have the latest version and it is compatible with your Bebot version (this is not 0.2.X or 0.3.3 compatible).

The idea for this plugin came from http://bebot.link/index.php?topic=780.msg5998;topicseen#new

Previously we had two plugins GuildRelay_GUILD.php and Relay_GUILD.php.  Now, many orgs have a setup something like:

privgrp <-> org chat <-> org chat <-> privgrp

Previously Relay_GUILD handed the private group to org chat, and GuildRelay_GUILD handled both the private group and org chat to the other org's bot.

This module replaces both the GuildRelay_GUILD.php and Relay_GUILD.php modules with a unified module that is configurable through !settings.


Known bugs:

None at this time.


Todo items:

None at this time.


Changelog:


* Configure an option for backwards compatibility (send !gcr in tells instead of only allowing for the relay bot).
* Confirm that the exterior private group is the one we've set in the Relay option, currently all exterior private groups can use !gcr as long as the person using it has access to the command.
* Customizable names included for private group and guild chat for relaying (IE: shorten Conquistador Coffee Inc. to CCI).  Now allows for any name to be used.  Defaults to the organizations name.
* Configurable colors!

To setup and use:

Step 1
Create a new bot to use as the relay.  Add the bots that will be using the relay as members.  Configure the relaybot to autoinvite the bots that will be using it.  (It is highly recommended to disable nearly all plugins on the relaybot.  As you are only using it for relaying purposes, there should be no reason why anyone needs access to it other than the bots and yourself.)

Step 2
Install the Relay.php plugin onto the bots that will be using the relay.  Make sure to disable GuildRelay_GUILD.php and Relay_GUILD.php as this will conflict with them.

Step 3
Give the bots that will be relaying the correct access level and permissions to use !gcr. (So if Bot1 is relaying to Bot2 via Relay1, Bot1 needs access to !gcr on Bot2 via pgmsg, and vice versa.)

Step 4
Restart the bots if you haven't already, and configure your settings to your specifications.

Step 5
Enjoy lightning quick relay messages, and less bot lag (due to no longer queueing the relay messages via /tell).

kuznechik:
smells nice. Gonna test it

Khalem:

--- Quote from: Ebag333 on May 25, 2007, 08:11:34 pm ---
Todo items:

Configure an option for backwards compatibility (send !gcr in tells instead of only allowing for the relay bot).

--- End quote ---

If you add this, please clearly state that it is a discouraged way of doing relays, and should only be used between two bots, not more.

Blueeagle:
Does this relay prevent persons banned or blacklisted from the one org to take part in chat via relay? Would such a filter be fesable to impliment?

How does the relay bot work? Is it possible for anyone to join a relay channel? Are one notified as new bots attach to the relay?

I haven't looked at the module yet, but the ide is very nice and if done right security wise it would be a major improvement over the old way.

Good job!

Khalem:
We actually need a central ignore feature that covers all relays, including IRC.

This should probably be simply string based, although it is feasible to take into account the blacklist/banlist as well for the ingame relays.

Navigation

[0] Message Index

[#] Next page