/webex-game-bot

A template to deploy a bot in Webex Teams using the webex-node-bot-framework

Primary LanguageJavaScriptThe UnlicenseUnlicense

Webex Game Bot

This is a Hackathon project based on the Webex-Bot-Starter for the 2020 Cisco Webex Virtual Hackathon. We created a bot that will allow friends and co-worker alike to play various games between themselves, facilitating virtual socialization and settling who once and for all is the greatest at Rock Paper Scissors. The installation process is the same as the normal Webex-Bot-Starter as described below.

Currently, only Rock Paper Scissors has been implemented as a game, but there are plans to implement more social tabletop games such as Mafia and Secret Hitler.

Webex-Bot-Starter

Starter kit and template for a simple Webex Teams bot

For a more detailed walkthorugh, see the companion blog post here: https://developer.webex.com/blog/from-zero-to-webex-teams-chatbot-in-15-minutes

This is a very simple Webex Teams node.JS bot application that serves as a template to be further extended. It features the webex-node-bot-framework that simplifies development for Webex Teams bots by abstractig away some of the complexity of the API calls and registering for events. Some parts of the app are taken from on the old sparkbotstarter template created by Victor Algaze.

Here is the bot in action:

git What we're making

Prerequisites:

  • node.js (minimum supported v8.0.0 & npm 2.14.12 and up)

  • Sign up for Webex Teams (logged in with your web browser)

Steps to get the bot working

  1. Create a Webex Teams bot (save the API access token and username): https://developer.webex.com/my-apps/new/bot

  2. Sign up for nGrok, then connect and start it on your machine (save the port number and public web address): https://ngrok.com/download

  3. After installing ngrok, run it on your local machine to get a public ip address, eg ngrok http 3000 --region=eu

  4. Copy the ip address displayed in the ngrok window, ie: : https://1234.eu.ngrok.io

  5. Copy the config-template.json file to a file called config.json

  6. Edit config.json with the following values:

  • token - Set this to the token for your bot that you got in step 1
  • port - Set this to the port you set when you started ngrok in step 3 (ie: 3000)
  • webhookUrl - Set this to the ip address that you copied in step 4

  1. Turn on your bot server with npm start

  2. Create a space in Webex Teams

  3. Add the bot (by its username) to the space in Webex Teams