{"id":16210763,"url":"https://github.com/avinzarlez/inkbot","last_synced_at":"2025-10-16T09:28:55.029Z","repository":{"id":145639656,"uuid":"86759238","full_name":"AvinZarlez/InkBot","owner":"AvinZarlez","description":"A Microsoft Bot Framework chatbot for Ink stories.","archived":false,"fork":false,"pushed_at":"2017-04-18T02:36:12.000Z","size":50,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-13T22:49:49.099Z","etag":null,"topics":["bot-framework","ink","inky","interactive-fiction","microsoft"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AvinZarlez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-30T23:48:14.000Z","updated_at":"2018-05-06T21:29:49.000Z","dependencies_parsed_at":"2023-07-22T23:00:24.814Z","dependency_job_id":null,"html_url":"https://github.com/AvinZarlez/InkBot","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AvinZarlez%2FInkBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AvinZarlez%2FInkBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AvinZarlez%2FInkBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AvinZarlez%2FInkBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AvinZarlez","download_url":"https://codeload.github.com/AvinZarlez/InkBot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247730984,"owners_count":20986571,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot-framework","ink","inky","interactive-fiction","microsoft"],"created_at":"2024-10-10T10:44:08.173Z","updated_at":"2025-10-16T09:28:49.986Z","avatar_url":"https://github.com/AvinZarlez.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# InkBot\n\nThis bot has been created using [Microsoft Bot Framework](https://dev.botframework.com).\n\nThis bot is designed to let you play through dialogs written in inkle's ink scripting language.\n\n## How to use\n\n1. Create a bot using the Microsoft Bot Framework, and get a Microsoft App ID and Password.\n1. Host this project online (I recommend [Azure](https://azure.microsoft.com/)) and use this codebase.\n1. Set your enviromental variables MicrosoftAppId and MicrosoftAppPassword to the values you created in step 1.\n1. Lastly, write over the `story.json` file with your own story exported from [inky](https://github.com/inkle/inky).\n\n### Structure\n\n`app.js` runs the bot code and starts a [Restify](http://restify.com/) server.\n\nYour `story.json` file is loaded when the bot comes online. The user's position within the ink story is saved using [inkjs](https://github.com/y-lohse/inkjs)'s built in save/load state and the bot framework's `session.dialogData`.\n\n### Running the bot\nIf running locally, first run:\n\n```\nnpm install\n```\n\nThen you can run the local restify server simply by running:\n\n```\nnode app.js\n```\n\nOr within [Visual Studio Code](https://code.visualstudio.com/) hitting the \"Start Debugging\" button.\n\nYou can then talk to your bot locally using the [Bot Framework Emulator](https://docs.botframework.com/en-us/tools/bot-framework-emulator/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favinzarlez%2Finkbot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favinzarlez%2Finkbot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favinzarlez%2Finkbot/lists"}