Skip to content

A Microsoft Bot Framework chatbot for Ink stories.

License

Notifications You must be signed in to change notification settings

AvinZarlez/InkBot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

InkBot

This bot has been created using Microsoft Bot Framework.

This bot is designed to let you play through dialogs written in inkle's ink scripting language.

How to use

  1. Create a bot using the Microsoft Bot Framework, and get a Microsoft App ID and Password.
  2. Host this project online (I recommend Azure) and use this codebase.
  3. Set your enviromental variables MicrosoftAppId and MicrosoftAppPassword to the values you created in step 1.
  4. Lastly, write over the story.json file with your own story exported from inky.

Structure

app.js runs the bot code and starts a Restify server.

Your story.json file is loaded when the bot comes online. The user's position within the ink story is saved using inkjs's built in save/load state and the bot framework's session.dialogData.

Running the bot

If running locally, first run:

npm install

Then you can run the local restify server simply by running:

node app.js

Or within Visual Studio Code hitting the "Start Debugging" button.

You can then talk to your bot locally using the Bot Framework Emulator