← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gozerbot/utopic

« back to all changes in this revision

Viewing changes to doc/plugins/UDP

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Malcolm
  • Date: 2009-09-14 09:00:29 UTC
  • mfrom: (1.1.4 upstream) (3.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20090914090029-uval0ekt72kmklxw
Tags: 0.9.1.3-3
http://bugs.debian.org/546435
Changed dependency on python-setuptools to python-pkg-resources
(Closes: #546435) 

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/plugins/UDP
1
 
=====
2
 
 UDP 
3
 
=====
4
 
| 
5
 
 
6
 
about
7
 
-----
8
 
| 
9
 
 
10
 
:author:  Bart Thate <bthate@gmail.com>
11
 
:contact: IRCNET/#dunkbots
12
 
:website: http://plugins.gozerbot.org
13
 
:license: Public Domain
14
 
 
15
 
| 
16
 
 
17
 
description
18
 
-----------
19
 
| 
20
 
 
21
 
run the udp listen thread
22
 
 
23
 
| 
24
 
 
25
 
 
26
 
 the bot has the capability to listen for udp packets which it will use
27
 
 to /msg a given nick or channel.
28
 
 
29
 
 1) udp config 
30
 
 
31
 
 edit the following section in you gozerdata/config
32
 
 
33
 
 ::
34
 
 
35
 
   # udp
36
 
   udp = 1 # set to 1 to enable
37
 
   udphost = 'localhost'
38
 
   udpport = 5500
39
 
   udpallow = ['127.0.0.1', ]
40
 
   udpallowednicks = ['#gozerbot', 'dunker']
41
 
   udppassword = 'mekker'
42
 
   udpseed = "blablablablablaz" # needs to be 16 chars wide
43
 
 
44
 
 udpallow is set to the ip from which udp packets are accepted .. 
45
 
 udpallowednicks are nicks/channels the bot is allowed to send messages to
46
 
 and udppassword is passed along with the message. set udpseed if you want to
47
 
 have your messages encrypted.
48
 
 
49
 
 2) limiter
50
 
 
51
 
 on IRC the bot's /msg to a user/channel are limited to 1 per 3 seconds so the
52
 
 bot will not excessflood on the server. you can use partyudp if you need no 
53
 
 delay between sent messages, this will use dcc chat to deliver the message.
54
 
 on jabber bots there is no delay
55
 
 
56
 
 3) toudp
57
 
 
58
 
 ::
59
 
 
60
 
   # files/toudp.py
61
 
   
62
 
   use this script to pipeline a programs output to the bot
63
 
   
64
 
   example: tail -f /var/log/httpd-access.log | ./todup.py
65
 
 
66
 
 
67
 
| 
68
 
 
69
 
commands
70
 
--------
71
 
| 
72
 
 
73
 
no commands in this plugin