sharonx / hubot-script

0 stars 2 forks source link

tlxbot

tlxbot is a chat bot built on the Hubot framework. It was initially generated by generator-hubot, and configured to be deployed on Heroku to get you up and running as quick as possible.

This README is intended to help get you started. Definitely update and improve to talk about your own instance, how to use and deploy, what functionality he has, etc!

Running tlxbot Locally

You can test your hubot by running the following, however some plugins will not behave as expected unless the environment variables they rely upon have been set.

You can start tlxbot locally by running:

% bin/hubot

You'll see some start up output and a prompt:

tlxbot>

Then you can interact with tlxbot by typing tlxbot help.

tlxbot> tlxbot help
tlxbot animate me <query> - The same thing as `image me`, except adds [snip]
tlxbot help - Displays all of the help commands that tlxbot knows about.
...

hubot-scripts

Before hubot plugin packages were adopted, most plugins were held in the hubot-scripts package. Some of these plugins have yet to be migrated to their own packages. They can still be used but the setup is a bit different.

To enable scripts from the hubot-scripts package, add the script name with extension as a double quoted string to the hubot-scripts.json file in this repo.