Difference between revisions of "IRC.php"

From Bebot Wiki 2
Jump to navigationJump to search
(Created page with '====== IRC.php (incomplete) ====== ==== Description ==== This module allows the bot to connect to and interact with members on an Internet Relay Chat channel. ==== Features =…')
 
Line 18: Line 18:
  
 
===== Commands provided =====
 
===== Commands provided =====
 
+
<pre>
 
^Command  ^ Keyword  ^Argument(s)  ^Description                                                            ^Tell      ^Guild    ^Priv      ^
 
^Command  ^ Keyword  ^Argument(s)  ^Description                                                            ^Tell      ^Guild    ^Priv      ^
 
|!irc    | server    | <servername> |Selects the irc server <servername> as the one the bot will connect to. |Owner    |Owner    |Owner    |
 
|!irc    | server    | <servername> |Selects the irc server <servername> as the one the bot will connect to. |Owner    |Owner    |Owner    |
Line 26: Line 26:
 
|!irc    | nick      | <nickname>  |Changes the bot's name to <nickname>                                    |Owner    |Owner    |Owner    |
 
|!irc    | nick      | <nickname>  |Changes the bot's name to <nickname>                                    |Owner    |Owner    |Owner    |
 
|!irc    | port      | <portnumber> |Chooses the port that will be used to connect to the irc server        |Owner    |Owner    |Owner    |
 
|!irc    | port      | <portnumber> |Chooses the port that will be used to connect to the irc server        |Owner    |Owner    |Owner    |
 +
</pre>
  
 
<sub>
 
<sub>
Line 39: Line 40:
  
 
===== Module settings =====
 
===== Module settings =====
 
+
<pre>
 
^Setting      ^Default  ^Description                                              ^
 
^Setting      ^Default  ^Description                                              ^
 
|Setting_one  |SomeValue |Now tell me what does this setting do?                  |
 
|Setting_one  |SomeValue |Now tell me what does this setting do?                  |
 +
</pre>
  
 
<sub>
 
<sub>

Revision as of 08:59, 30 July 2021

IRC.php (incomplete)

Description

This module allows the bot to connect to and interact with members on an Internet Relay Chat channel.


Features

 * Shows guild-chat and (optionally) pg-chat in the IRC-channel
 * Shows IRC-chat in guild-chat and (optionally) in pg-chat.

Note:\\

- Relaying between guilds via IRC is depreciated. Please use the relay feature of the bot.


Commands provided
^Command  ^ Keyword   ^Argument(s)   ^Description                                                             ^Tell      ^Guild     ^Priv      ^
|!irc     | server    | <servername> |Selects the irc server <servername> as the one the bot will connect to. |Owner     |Owner     |Owner     |
|!irc     | port      | <portnumber> |Chooses the port that will be used to connect to the irc server         |Owner     |Owner     |Owner     |
|!irc     | channel   |#<channelname>|Selects the channel the bot will use when connected.                    |Owner     |Owner     |Owner     |
|!irc     | channelkey| <password>   |Uses <password> to connect to a locked channel.                         |Owner     |Owner     |Owner     |
|!irc     | nick      | <nickname>   |Changes the bot's name to <nickname>                                    |Owner     |Owner     |Owner     |
|!irc     | port      | <portnumber> |Chooses the port that will be used to connect to the irc server         |Owner     |Owner     |Owner     |

Notes to table:\\

- When specifying the channel the # is NOT OPTIONAL.


Related commands

 * **!related command** - How is this command related?


Module settings
^Setting       ^Default   ^Description                                              ^
|Setting_one   |SomeValue |Now tell me what does this setting do?                   |

Notes to table:\\

- Things to observe when reading the table

Module colors

^Scheme name ^Default ^ |name_of_scheme|colorname |


Notes
 * Notes to the module