PsychoticNinja/JLU5-SupyPlugins
1
0
Fork 0
mirror of https://github.com/jlu5/SupyPlugins.git synced 2025-04-29 23:11:07 -05:00
Code Issues Projects Releases Wiki Activity

RelayNext: update README.md [skip ci]

Browse Source 
This adds some documentation regarding ignores and non-PRIVMSG event toggling.
This commit is contained in:
James Lu 2015-01-30 18:20:52 -08:00
parent c9d22a64bf
commit 7672ae3e71
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
RelayNext/README.md
View File

@ -32,3 +32,23 @@ The `list` command will list all relays defined.
### Removing/clearing relays
The `unset` command removes a relay name, while the `clear` command clears all relays. The `remove` command removes individual channels from a relay, deleting it completely when the amount of channels is less than 2.
## Configuration
### Relaying non-PRIVMSG events
RelayNext supports relaying the following non-PRIVMSG events: joins, kicks, mode changes, nick changes, parts, quits, and topic changes. Each of these can be turned on and off using configuration variables, and have the following defaults:
- `config plugins.RelayNext.events.relayjoins`: True
- `config plugins.RelayNext.events.relaykicks`: True
- `config plugins.RelayNext.events.relaymodes`: True
- `config plugins.RelayNext.events.relaynicks`: True
- `config plugins.RelayNext.events.relayparts`: True
- `config plugins.RelayNext.events.relayquits`: True
- `config plugins.RelayNext.events.relaytopics`: False
Note: Topic relaying will only show topic *changes* in a channel. **It does not, and can not sync topics between channels!**
### Ignoring users
RelayNext uses Supybot's built in ignore system, but you can set which kinds of messages you want to ignore from ignored users using `config plugins.RelayNext.events.userignored`.
This key takes a space separated list, and defaults to ignoring `PRIVMSG` and `MODE`. **If you want to disable this ignore feature, simply set the value blank: `config plugins.RelayNext.events.userignored ""`**