robotirc

Multifonction IRC bot written in Node.js
Log | Files | Refs | README | LICENSE

README.md (2580B)


      1 # RobotIRC
      2 
      3 ## Description
      4 
      5 Multifonction IRC bot written in Node.js.
      6 
      7 ## Installation
      8 
      9 Install the program:
     10 
     11 	npm install -g robotirc
     12 
     13 ## Usage
     14 
     15 Start RobotIRC by invoking `robotirc`.
     16 
     17 ## Configuration
     18 
     19 Configuration options are set in the `~/.robotirc` file. If RobotIRC cannot find an user defined configuration file in the home directory, the bundled `config.json` if used instead.
     20 
     21 Example configuration with default options:
     22 
     23 	{
     24 	    "server": "irc.freenode.net",
     25 	    "nickname": "robotirc",
     26 	    "options": {
     27 	        "userName": "robotirc",
     28 	        "realName": "RobotIRC 0.1.2",
     29 	        "port": 6667,
     30 	        "autoRejoin": true,
     31 	        "autoConnect": true,
     32 	        "channels": [
     33 	            "#robotirc"
     34 	        ]
     35 	    }
     36 	}
     37 
     38 ## Commands
     39 
     40 RobotIRC supports the following commands:
     41 
     42 - !alexa (Get Alexa traffic rank for a domain or URL)
     43 - !date (Display server local time)
     44 - !expand (Expand a shortened URL)
     45 - !headers (Display HTTP headers for queried URL)
     46 - !resolve (Get A records (IPv4) and AAAA records (IPv6) for queried domain)
     47 - !reverse (Get reverse (PTR) records from IPv4 or IPv6 addresses)
     48 - !wikipedia (Query Wikipedia for an article summary)
     49 
     50 A list of available functions can be displayed by using the `!help` command.
     51 
     52 ## Examples
     53 
     54 	<fcambus> !alexa echojs.com
     55 	<robotirc> Alexa Traffic Rank for echojs.com: 267098
     56 
     57 	<fcambus> !date
     58 	<robotirc> Fri Jan 03 2014 01:02:39 GMT+0100 (CET)
     59 
     60 	<fcambus> !expand http://bit.ly/1g4jD0H
     61 	<robotirc> http://www.echojs.com/
     62 
     63 	<fcambus> !headers http://www.echojs.com
     64 	<robotirc> server: nginx
     65 	<robotirc> date: Fri, 03 Jan 2014 00:08:05 GMT
     66 	<robotirc> content-type: text/html;charset=utf-8
     67 	<robotirc> content-length: 16769
     68 	<robotirc> connection: keep-alive
     69 	<robotirc> vary: Accept-Encoding
     70 	<robotirc> status: 200 OK
     71 	<robotirc> x-xss-protection: 1; mode=block
     72 	<robotirc> x-frame-options: sameorigin
     73 
     74 	<fcambus> !resolve echojs.com
     75 	<robotirc> 46.19.37.108
     76 	<robotirc> 2a02:2770::21a:4aff:feb3:2ee
     77 
     78 	<fcambus> !reverse 77.88.8.8
     79 	<robotirc> dns.yandex.ru
     80 
     81 	<fcambus> !reverse 2a02:6b8::feed:ff
     82 	<robotirc> dns.yandex.ru
     83 
     84 	<fcambus> !wikipedia node.js
     85 	<robotirc> Node.js is a software system designed for writing scalable Internet applications, notably web servers. Programs are written in JavaScript, using event-driven, asynchronous I/O to minimize overhead and maximize scalability. http://en.wikipedia.org/wiki/Node.js
     86 
     87 ## License
     88 
     89 RobotIRC is released under the BSD 2-Clause license. See `LICENSE` file for details.
     90 
     91 ## Author
     92 
     93 RobotIRC is developed by Frederic Cambus.
     94 
     95 - Site: https://www.cambus.net