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:16] – 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 |
- | ------------- | + | |
- | The ircBot is controlled via a settings | + | |
- | Most important are the server settings; | + | |
+ | < | ||
[server_ServerName] | [server_ServerName] | ||
addresses=add.ress.one, | addresses=add.ress.one, | ||
Line 30: | Line 16: | ||
channels=# | channels=# | ||
port=6667 | 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' | + | |
- | -- Passwords are important but quite honestly I have not figured out how to authenticate a bot other than with /oper lines. Which I don't suggest giving a bot. More on this later... | + | |
- | -- 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] | + | < |
- | ;channels=# | + | [module_ModuleName] |
- | ;dir=/ | + | channels=# |
- | ;lib=mylib.js | + | dir=/ |
- | ;global=true | + | lib=mylib.js |
+ | global=true | ||
+ | </ | ||
+ | |||
+ | Looking at the '' | ||
+ | |||
+ | < | ||
- | Looking at the sbbs\exec\ircbots | + | ; |
+ | ;dir=/sbbs/exec/ircbots/trivia/ | ||
[module_Admin] | [module_Admin] | ||
Line 102: | Line 93: | ||
[module_RPG] | [module_RPG] | ||
dir=/ | dir=/ | ||
+ | </ | ||
- | Good seems to have some file dependencies and doesn' | + | //Notes// |
+ | - Google | ||
+ | - 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. | ||
+ | |||
- | See the help by sending /msg < | + | **Running |
- | You will need to IDENT against your bot to see the full menu of items, without IDENT the help looks like; | + | |
+ | 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 to the bot. To identify, use **/msg < | ||
+ | |||
+ | Without **IDENT** the help looks like; | ||
+ | |||
+ | < | ||
Usage: HELP < | Usage: HELP < | ||
[main] help,?, | [main] help,?, | ||
Line 130: | 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 154: | 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 ===== |