]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Irc/extlib/phergie/Settings.php.dist
Added Phergie PHP IRC library
[quix0rs-gnu-social.git] / plugins / Irc / extlib / phergie / Settings.php.dist
1 <?php
2
3 return array(
4
5     // One array per connection, pretty self-explanatory
6     'connections' => array(
7         // Ex: All connection info for the Freenode network
8         array(
9             'host' => 'irc.freenode.net',
10             'port' => 6667,
11             'username' => 'Elazar',
12             'realname' => 'Matthew Turland',
13             'nick' => 'Phergie2',
14             // 'password' => 'password goes here if needed',
15             // 'transport' => 'ssl' // uncomment to connect using SSL
16         )
17     ),
18     
19     'processor' => 'async',    
20     'processor.options' => array('usec' => 200000),
21     // Time zone. See: http://www.php.net/manual/en/timezones.php
22     'timezone' => 'UTC',
23
24     // Whitelist of plugins to load
25     'plugins' => array(
26         // To enable a plugin, simply add a string to this array containing 
27         // the short name of the plugin as shown below. 
28
29         // 'ShortPluginName',
30
31         // Below is an example of enabling the AutoJoin plugin, for which 
32         // the corresponding PEAR package is Phergie_Plugin_AutoJoin. This 
33         // plugin allows you to set a list of channels in this configuration  
34         // file that the bot will automatically join when it connects to a 
35         // server. If you'd like to enable this plugin, simply install it, 
36         // uncomment the line below, and set a value for the setting 
37         // autojoin.channels (examples for which are located further down in 
38         // this file).
39
40         // 'AutoJoin',
41
42         // A few other recommended plugins:
43
44         // Servers randomly send PING events to clients to ensure that 
45         // they're still connected and will eventually terminate the 
46         
47         // connection if a PONG response is not received. The Pong plugin 
48         // handles sending these responses.
49
50         // 'Pong', 
51
52         // It's sometimes difficult to distinguish between a lack of 
53         // activity on a server and the client not receiving data even 
54         // though a connection remains open. The Ping plugin performs a self 
55         // CTCP PING sporadically to ensure that its connection is still 
56         // functioning and, if not, terminates the bot.
57
58         // 'Ping',
59
60         // Sometimes it's desirable to have the bot disconnect gracefully 
61         // when issued a command to do so via a PRIVMSG event. The Quit 
62         // plugin implements this using the Command plugin to intercept the 
63         // command.
64
65         // 'Quit',
66     ),
67
68     // If set to true, this allows any plugin dependencies for plugins 
69     // listed in the 'plugins' option to be loaded even if they are not 
70     // explicitly included in that list
71     'plugins.autoload' => true,
72
73     // Enables shell output describing bot events via Phergie_Ui_Console
74     'ui.enabled' => true,
75
76     // Examples of supported values for autojoins.channel:
77     // 'autojoin.channels' => '#channel1,#channel2',
78     // 'autojoin.channels' => array('#channel1', '#channel2'),
79     // 'autojoin.channels' => array(
80     //                            'host1' => '#channel1,#channel2',
81     //                            'host2' => array('#channel3', '#channel4')
82     //                        ),
83
84     // Examples of setting values for Ping plugin settings
85
86     // This is the amount of time in seconds that the Ping plugin will wait 
87     // to receive an event from the server before it initiates a self-ping 
88
89     // 'ping.event' => 300, // 5 minutes
90
91     // This is the amount of time in seconds that the Ping plugin will wait 
92     // following a self-ping attempt before it assumes that a response will 
93     // never be received and terminates the connection
94
95     // 'ping.ping' => 10, // 10 seconds
96
97 );