Home

Welcome to the Concierge wiki!

(Karma + Sassy) * (Facebook + Slack + Skype + Hipchat + Telegram) = Concierge

It does way more than this now...

Concierge is a modular, easily extensible general purpose chat bot. Small node.js modules can be written for it then placed in the modules directory - some examples can be found here. Current pre-installed modules are located here, additional modules can be created or installed through the built in package manager. Existing modules include a variety of functionality from getting animated gifs to running arbitrary sandboxed JavaScript code, voting and giving karma.

Basic Usage

Make sure that both git, node and npm are available in your path. Once that is done, clone the repository and install required npm packages:

git clone https://github.com/concierge/Concierge.git
cd Concierge
npm install

Then start one or more of the available integrations:
(eg. node main.js facebook slack skype test after configuring to start them all)

Modules

• Creating Modules
• KPM Modules List

All Documentation

• Creating Modules
  • Module Methods
  • API Object
  • Event Object
  • kassy.json
  • Translations
• KPM Modules Table
• Default Commands
• Usage Example/Overview
• Integrations (Integrations are chat platforms that Concierge integrates into)
  • Existing Integrations. Look here for documentation on how to set them up.
    • Facebook Integration
    • Slack Integration
    • Discord Integration
    • Skype Integration
    • Telegram Integration
    • Messenger Bots
    • Testing Mode
  • Creating Integrations
    • Integration Methods
• CLI Arguments, Debugging and Logging
• Docker
• Contributing

Testing

See Running and writing tests

Disclaimer

HERE BE DRAGONS! Written to see if it could be done, not written to be readable.
Enter at your own peril.

Contributions

Contributions welcome, see Contributing.

Copyright and License

Licensed under the MIT license. Unless otherwise specified, code is Copyright (c) Matthew Knox 2015.