# hubot-ab

[![Build Status](https://travis-ci.org/ClaudeBot/hubot-ab.svg)](https://travis-ci.org/ClaudeBot/hubot-ab)
[![devDependency Status](https://david-dm.org/ClaudeBot/hubot-ab/dev-status.svg)](https://david-dm.org/ClaudeBot/hubot-ab#info=devDependencies)

A Hubot script for [Muan's AB](http://ab.muan.co/). A 4-digit number guessing game.

See [`src/guess.coffee`](src/guess.coffee) for full documentation.


## Installation via NPM

1. Install the __hubot-ab__ module as a Hubot dependency by running:

    ```
    npm install --save hubot-ab
    ```

2. Enable the module by adding the __hubot-ab__ entry to your `external-scripts.json` file:

    ```json
    [
        "hubot-ab"
    ]
    ```

3. Run your bot and see below for available config / commands


## Commands

Command | Listener ID | Description
--- | --- | ---
hubot guess `number` | `ab.guess` | Returns a feedback indicating how accurate your 4-digit `number` guess is
hubot guess surrender | `ab.surrender` | Restarts the game with a new number, duh!
hubot guess tutorial | `ab.tutorial` | Tells you how to play this game


## Sample Interaction

```
user1>> hubot guess 1234
hubot>> user1: 0A 1B
```