lholman / AutoBot-Scripts

Community PowerShell scripts for [AutoBot](https://github.com/lholman/AutoBot), the awesome little automater

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

AutoBot-Scripts

A collection of community PowerShell scripts for AutoBot. AutoBot is inspired by GitHub's splendid HUBOT and a childhood love of Transformers, AutoBot however is a chat bot for the Windows crew.

  • The core bot engine is written in C# (.NET 4), his functionality and extensibility is provided by the addition of PowerShell 2.0 script modules which are dynamically loaded and executed at runtime.
  • AutoBot currently chats only with the XMPP powered awesomeness that is HipChat using the jabber-net library

WARNING: AutoBot is an infant and has some obvious (and other not so obvious) restrictions/issues/flaws, please take a look at AutoBot's current issues before continuing.

Writing Scripts

AutoBot's scripts are written in PowerShell 2.0 as Script Modules utilising the power of Advanced Functions for consistent documentation.

AutoBot comes with a couple of simple scripts to get you started, so have a look there first and of course check the ones here.

Scripts can come from here, as part of the AutoBot build, or from your own repository, however they must ultimately sit in the AutoBot\Scripts folder of your AutoBot installation. We tend to use TeamCity[http://www.jetbrains.com/teamcity/] to munge all the above together and output our deployable version of AutoBot with Scripts included.

Guidelines

These are the current guidelines for writing scripts and should give you the best chance of getting a sensible response from AutoBot.

  • Scripts must be a script module, i.e. Get-Help.psm1

  • The main returning function must have the same name as the script itself

      function Get-Help {
      ...
      }
    
  • Scripts must utilise Advanced Functions to aid in discoverability and consistency of documentation

  • Scripts must return System.String or System.Hastable types to guarantee AutoBot being able to pass the output

Note: Some of the above are optional, however for inclusion here we ask that they are all adhered to.

Contributing To AutoBot Scripts

  1. Fork it.
  2. Commit your changes (git commit -am "Added cool feature")
  3. Send us a Pull Request

Building Your AutoBot

  1. Head on over to AutoBot

Running Your AutoBot

  1. Head on over to AutoBot

Contributing To AutoBot's Core Engine

  1. Head on over to AutoBot

Disclaimer

NO warranty, expressed or written

About

Community PowerShell scripts for [AutoBot](https://github.com/lholman/AutoBot), the awesome little automater


Languages

Language:PowerShell 100.0%