Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
module:ircbot [2019/04/18 15:27] – Added initial bot docs hansolo | module:ircbot [2019/04/24 12:29] – Removed the IRC log (placeholder documentation) from the top of the page. ecbbs | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
- | < | + | **Installation** |
- | < | + | |
- | < | + | |
- | < | + | |
- | < | + | |
- | < | + | |
- | < | + | |
- | < | + | |
- | < | + | |
- | < | + | |
- | </ | + | |
- | I'm going to start working on revising this page. Since there is not a great deal of info about the ircBot | + | The IRC bot is included with Synchronet |
- | **Installation | + | **Configuration** |
- | ------------** | + | |
- | There is an ircBot program included with the Synchro.net BBS package, but it is not enabled by default. | + | |
- | **Configuration | + | The IRC bot configuration file is '' |
- | -------------** | + | |
- | The ircBot | + | |
- | Most important are the server settings (omit the bullets I just needed them for formatting in this wiki); | + | |
- | * [server_ServerName] | + | < |
- | | + | [server_ServerName] |
- | | + | addresses=add.ress.one, |
- | | + | nick=BotNickname |
- | | + | services_password=? |
- | | + | channels=# |
+ | port=6667 | ||
+ | </ | ||
//Notes:// | //Notes:// | ||
- | - If running | + | - If you are running the Synchronet ircd, you can connect |
- | - Port is required but if you use the default 6667 or a dedicated port doesn' | + | - You may place more than one server section in '' |
- | - Passwords are important but quite honestly I have not figured out how to authenticate a bot other than with /oper lines. | + | |
- | - I have found that you may place more than one server section in the //ini// and it does in fact create more than one bot in the ircd. | + | |
- | **Modules | + | **Modules** |
- | -------** | + | There are a number of modules available for the IRC bot, but they are not all enabled (or listed) in '' |
- | There are a number of modules available for the ircBot to host, although | + | |
- | * [module_ModuleName] | + | < |
- | | + | [module_ModuleName] |
- | | + | channels=# |
- | | + | dir=/ |
- | | + | lib=mylib.js |
+ | global=true | ||
+ | </ | ||
- | Looking at the //sbbs/exec/ | + | Looking at the '' |
- | * [module_Admin] | + | < |
- | * global=true | + | |
- | * dir=/ | + | |
- | * [module_Antispam] | + | ;[module_Trivia] |
- | * global=true | + | ;dir=/ |
- | * dir=/ | + | |
- | * [module_Decider] | + | [module_Admin] |
- | | + | global=true |
- | | + | dir=/ |
- | * [module_Dice] | + | [module_Antispam] |
- | | + | global=true |
- | | + | dir=/ |
- | * [module_Dis] | + | [module_Decider] |
- | | + | global=true |
+ | dir=/ | ||
- | * ;[module_Google] | + | [module_Dice] |
- | * ;global=true | + | global=true |
- | * ;dir=/ | + | dir=/ |
- | * [module_Ham] | + | [module_Dis] |
- | | + | dir=/ |
- | * [module_Humanity] | + | ;[module_Google] |
- | | + | ; |
+ | ;dir=/ | ||
- | * [module_Info] | + | [module_Ham] |
- | * global=true | + | dir=/ |
- | * dir=/ | + | |
- | * lib=http.js | + | |
- | * [module_Poker] | + | [module_Humanity] |
- | | + | dir=/ |
- | * lib=cardlib.js | + | |
- | * [module_Presence] | + | [module_Info] |
- | | + | global=true |
+ | dir=/ | ||
+ | lib=http.js | ||
- | * [module_Weather] | + | [module_Poker] |
- | * global=true | + | dir=/ |
- | * dir=/ | + | lib=cardlib.js |
- | | + | |
- | * [module_WhereIs] | + | [module_Presence] |
- | * global=true | + | dir=/ |
- | * dir=/ | + | |
- | * lib=http.js | + | |
- | * [module_RPG] | + | [module_Weather] |
- | | + | global=true |
+ | dir=/ | ||
+ | lib=http.js | ||
+ | |||
+ | [module_WhereIs] | ||
+ | global=true | ||
+ | dir=/ | ||
+ | lib=http.js | ||
+ | |||
+ | [module_RPG] | ||
+ | dir=/ | ||
+ | </ | ||
//Notes// | //Notes// | ||
- Google seems to have some file dependencies and doesn' | - Google seems to have some file dependencies and doesn' | ||
- No trivia directory although it is listed in the ini file. | - No trivia directory although it is listed in the ini file. | ||
- | - Otherwise, by adding the modules to the ini and restarting the bot you may make these available in your ircd. | + | - Otherwise, by adding the modules to the ini and restarting the bot you may make these available in your ircd. |
- | - See the help by sending **/msg < | + | |
- | - You will need to **/msg < | + | |
+ | **Running the IRC Bot** | ||
+ | |||
+ | The IRC bot can be executed via [[: | ||
+ | |||
+ | You can also run the IRC bot via your services thread by adding an entry to [[: | ||
+ | |||
+ | < | ||
+ | [IRCBot] | ||
+ | Port=6668 | ||
+ | Options=STATIC|LOOP | ||
+ | Command=ircbot.js | ||
+ | </ | ||
+ | |||
+ | Note that the //Port// value must be supplied, but is irrelevant; the bot does not listen for connections. | ||
+ | |||
+ | You can add '' | ||
+ | |||
+ | |||
+ | **Using the IRC Bot** | ||
+ | |||
+ | - See the help menu by sending **/msg < | ||
+ | - Some commands are restricted and will not show up in the help menu (or be usable), until you have identified yourself | ||
Without **IDENT** the help looks like; | Without **IDENT** the help looks like; | ||
+ | < | ||
Usage: HELP < | Usage: HELP < | ||
[main] help,?, | [main] help,?, | ||
Line 134: | Line 149: | ||
for help creating a characer, type 'rpg help create' | for help creating a characer, type 'rpg help create' | ||
for help with the editor, type 'rpg help editor' | for help with the editor, type 'rpg help editor' | ||
+ | </ | ||
With **IDENT** it looks like; | With **IDENT** it looks like; | ||
+ | < | ||
Usage: HELP < | Usage: HELP < | ||
[main] reload, | [main] reload, | ||
Line 159: | Line 176: | ||
for help creating a characer, type 'rpg help create' | for help creating a characer, type 'rpg help create' | ||
for help with the editor, type 'rpg help editor' | for help with the editor, type 'rpg help editor' | ||
- | + | </ | |
- | + | ||
- | I am going to begin going through all the commands for the bot and will list them out here. | + | |
===== See Also ===== | ===== See Also ===== |