freifunk-bot

Modular parser for the hackerspace door status with handlers for multiple services
git clone git://archive.git.mtrnord.blog/MTRNord/freifunk-bot.git
Log | Files | Refs | README | LICENSE

README.md (1955B)


      1 [![Code Climate](https://codeclimate.com/github/MTRNord/nordlab-hackerspace-door/badges/gpa.svg)](https://codeclimate.com/github/MTRNord/nordlab-hackerspace-door) [![Total alerts](https://img.shields.io/lgtm/alerts/g/MTRNord/freifunk-bot.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/MTRNord/freifunk-bot/alerts/)
      2 Nordlab Bot
      3 ===========
      4 
      5 [![Greenkeeper badge](https://badges.greenkeeper.io/MTRNord/nordlab-hackerspace-door.svg)](https://greenkeeper.io/)
      6 Modular parser for the hackerspace door status with handlers for multiple services and IRC Bot for the Nordlab e.V.
      7 
      8 How to install
      9 ==============
     10 1. npm install
     11 2. npm start
     12 
     13 Commandline options
     14 ===================
     15 When using commandline arguments use ```node main.js``` to start.<br>
     16 ```--noupdate``` - stops bot from getting updates <br>
     17 
     18 Commands
     19 ========
     20 ```!help | !hilfe``` - Lists all commands in a PM<br>
     21 ```!doorstatus``` - Send an PM with the actual Door Status<br>
     22 ```!doorstatus [arg]``` - If the arg is <b>"this"</b> it sends in the actual channel the Door Status or is there an <b>existing channel as argument</b> it sends to the channel which is the argument<br>
     23 ```!where``` - Send an PM with the address of the Hackerspace<br>
     24 ```!who``` - Send an PM with information about who can go to the Hackerspace<br>
     25 ```!when``` - Send an PM with information about when the Hackerspace usually is open<br>
     26 ```!source``` - Send an PM with the link of this repo. If you add <b>"this"</b> after it you can post it in the actual channel<br>
     27 ```!license``` - Send an PM with the link of the bot license<br>
     28 ```!afk``` - Send in the actual channel that you are A(way) F(rom) K(eyboard)<br>
     29 ```!alone``` - Send in the actual channel that you are alone in the channel<br>
     30 ```!freifunk``` - Send in the actual channel a link with an meme about Freifunk<br>
     31 
     32 Updates
     33 =======
     34 The Bot pulls the repo every day at 2am (if not deativated) and restarts the bot. So it is always UpTo-Date :)<br>