Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
module:ircbot [2019/04/18 15:35] – hansolo | module:ircbot [2019/04/24 12:29] – Removed the IRC log (placeholder documentation) from the top of the page. ecbbs |
---|
====== Ircbot ====== | ====== IRC Bot ====== |
| |
<code> | **Installation** |
<cellguy> can anyone answer a Sychronet IRC question for me? has to do with the bot scripts included with synchronet package | |
<cellguy> How do you get them working? Cant find any documentation on them | |
<cellguy> need to get one oman IRC channel on my server | |
<cellguy> saw them in the directory and looked at the configs, just need a jump start | |
<Troice> You set up the ini file and run it using jsexec. | |
<cellguy> ok sweet, thats the jump start I was looking for | |
<Troice> ctrl/ircbot.ini | |
<Troice> sbbs/exec/jsexec -d ircbot.js | |
<cellguy> thanks a bunch | |
</code> | |
| |
I'm going to start working on revising this page. Since there is not a great deal of info about the ircBot included with the BBS package, I've been doing some experimenting. Based on what I find, I'll be updating the page here. | The IRC bot is included with Synchronet BBS, at ''exec/ircbot.js''. Additional IRC bot modules are available in ''exec/ircbots/''. |
| |
**Installation** | **Configuration** |
There is an ircBot program included with the Synchro.net BBS package, but it is not enabled by default. I have found that the only method to get the bot running is to run it from a separate CMD window as Troice states above. Create a shortcut to it with the command line of **sbbs/exec/jsexec -d ircbot.js** to start. This assumes you already have the ircd configured and running. | |
| |
**Configuration** | The IRC bot configuration file is ''ctrl/ircbot.ini''. |
The ircBot is controlled via a settings file //ctrl/ircbot.ini// | |
Most important are the server settings; | |
| |
<code> | <code> |
| |
//Notes:// | //Notes:// |
- If running from the same machine as the ircD then using localhost or 127.0.0.1 works OK. But if you have multiple IP's configured use the specific IP's. | - If you are running the Synchronet ircd, you can connect the bot to localhost, 127.0.0.1, or the specific interface that the ircd binds to as configured in ''ctrl/services.ini'' |
- Port is required but if you use the default 6667 or a dedicated port doesn't matter. If all running from the same machine I find 6667 works fine, really depends on how my activity your ircd is getting. If under heavy load and/or running from another machine, you might want to us e a different port that is not open to the outside. Whatever you decide, if not 6667 be sure you have listed it in //ctrl/irc.conf// as a P line (P:*:*:*:7000). | - You may place more than one server section in ''ctrl/ircbot.ini'', however connecting to multiple servers with one bot currently does not work. Instead, you would need to run multiple instances of ircbot.js. |
- 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. However, the subsequent bots do not see to behave the same as the default and I need to experiment more with using dedicated ports / running multiple command windows to host individual bots. | |
| |
**Modules** | **Modules** |
There are a number of modules available for the ircBot to host, although they are not all enabled (or listed) in the //ctrl/ircbot.ini// by default. | There are a number of modules available for the IRC bot, but they are not all enabled (or listed) in ''ctrl/ircbot.ini'' by default. |
| |
<code> | <code> |
</code> | </code> |
| |
Looking at the //sbbs/exec/ircbots// directory for your version of the BBS you may see more modules that are installed but bot configured. As of BBS v3.17 I find the following; | Looking at the ''exec/ircbots'' directory, you may see more modules that are installed but bot configured. As of the time of this writing, the following are available: |
| |
<code> | <code> |
| |
| |
**Usage** | **Running the IRC Bot** |
| |
| The IRC bot can be executed via [[:util:jsexec]], ''jsexec ircbot.js'', and an alternate configuration file may be specified like so: ''jsexec ircbot.js -f /some/other/ircbot.ini''. |
| |
//Notes// | You can also run the IRC bot via your services thread by adding an entry to [[:config:services.ini:]]: |
- See the help by sending **/msg <botnick> help**. | |
- You will need to **/msg <botnick> IDENT <password>** against your bot to see the full menu of items | <code> |
| [IRCBot] |
| Port=6668 |
| Options=STATIC|LOOP |
| Command=ircbot.js |
| </code> |
| |
| Note that the //Port// value must be supplied, but is irrelevant; the bot does not listen for connections. Just pick an unused port. |
| |
| You can add '' -f /some/other/ircbot.ini'' to the //Command// line to specify an alternate configuration file. |
| |
| |
| **Using the IRC Bot** |
| |
| - See the help menu by sending **/msg <botnick> help**. |
| - 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 <botnick> ident <password>**. (Your IRC nickname must be the same as your username on the BBS for this to work.) |
| |
Without **IDENT** the help looks like; | Without **IDENT** the help looks like; |
for help with the editor, type 'rpg help editor' | for help with the editor, type 'rpg help editor' |
</code> | </code> |
| |
I am going to begin going through all the commands for the bot and will list them out here. | |
| |
===== See Also ===== | ===== See Also ===== |