mirror of https://github.com/str4d/RelayBot.git
Fix readme and config sample.
This commit is contained in:
parent
e3847f76cc
commit
bd898207c6
|
@ -11,6 +11,7 @@ This distribution includes `run.sh` for easier control of the daemon.
|
|||
- Default: simple two-way relaying.
|
||||
- NickServ: authenticates with nickserv before joining channels.
|
||||
- FLIP: specialized mode for [FLIP](http://new-wiki.freenetproject.org/FLIP) which removes the numbered suffix on outgoing usernames.
|
||||
- RelayByCommand: only messages with the bot's name followed by a colon will be relayed.
|
||||
|
||||
## Requirements
|
||||
|
||||
|
@ -25,4 +26,4 @@ Edit the sample config file as desired. If no local value exists for a section a
|
|||
|
||||
## Internals
|
||||
|
||||
On startup, the config file is read, and for each section the local entry is preferred over the default one. For each defined host, an instance of `IRCRelay` or a subclass thereof (depending on `mode`) connects to the host and joins the channel. Each instance relays events to the others though a global `Communicator` class with which it registers. When the bot recieves a message, if it is to the channel it relays it, and if it is a private message to the bot it replies directly to the sender with the content of `info`. If a message to the channel starts with the bot's name followed by a colon, it announces `info` to the channel.
|
||||
On startup, the config file is read, and for each section the local entry is preferred over the default one. For each defined host, an instance of `IRCRelay` or a subclass thereof (depending on `mode`) connects to the host and joins the channel. Each instance relays events to the others though a global `Communicator` class with which it registers. When the bot recieves a message, if it is to the channel it relays it.
|
||||
|
|
|
@ -3,12 +3,12 @@
|
|||
#Twisted's default is 30 seconds.
|
||||
timeout=120
|
||||
port=6667
|
||||
channel=#a-bridged-channel
|
||||
nick=RelayBot
|
||||
channel=#swarm
|
||||
nick=Bender
|
||||
#Can change to allow more specialized behavior.
|
||||
mode=Default
|
||||
username=RelayBot
|
||||
realname=Relay P. Botterson
|
||||
username=unit22
|
||||
realname=Bender Bending Rodríguez
|
||||
heartbeat=90
|
||||
|
||||
[Freenode]
|
||||
|
@ -18,6 +18,9 @@ nickServPassword=applesAndOranges
|
|||
#Server password: can leave unspecified if there isn't one.
|
||||
password=ItsASecretToEveryone
|
||||
|
||||
[Umich]
|
||||
host=irc.umich.edu
|
||||
|
||||
[N*A]
|
||||
host=irc.n*a.gov
|
||||
port=6697
|
||||
ssl=True
|
||||
fingerprint=9A:AB:25:1F:96:DA:CB:BA:AF:F5:A4:9B:6E:76:BC:9F:28:89:6F:83
|
||||
mode=RelayByCommand
|
||||
|
|
Loading…
Reference in New Issue