https://github.com/viktorholk/script-interactor

📷 Interactive Twitch bot for executing scripts
https://github.com/viktorholk/script-interactor

bot chat chatbot script twitch

Last synced: 29 days ago
JSON representation

📷 Interactive Twitch bot for executing scripts

• Host: GitHub
• URL: https://github.com/viktorholk/script-interactor
• Owner: viktorholk
• License: mit
• Created: 2021-12-19T02:21:26.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-20T15:55:32.000Z (over 2 years ago)
• Last Synced: 2024-10-25T06:00:21.222Z (3 months ago)
• Topics: bot, chat, chatbot, script, twitch
• Language: TypeScript
• Homepage:
• Size: 136 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • License: LICENSE

Awesome Lists containing this project

README

        





    Script Interactor

    


    Version: 1.0.1



# About

Script Interactor is a Twitch chatbot built in Node JS.  

It encourages your viewers to interact with your Twitch stream by letting them execute scripts, where you as the broadcaster are the target.  

You could for example configure the application to run a script whenever a viewer types !reverse - which could result in your keyboard input turning reversed or you could configure a script to spawn enemies around you. The possibilies are up to you.  

Currently the applicaton can only be run on Windows machines.

* How does it work?  

You configure scripts to be run by chat commands. By adding a script to the ``./scripts`` folder and configuring it in the ``./config/scripts.json``, you allow your viewers to run scripts on your system by typing commands in the chat.  

These scripts can be configured to your liking with cooldown timer, points cost, permissions etc. in the ``config/scripts.json``.  

## Requirements

* [Node](https://nodejs.org/en/) Will be used to run the program and install the necessary modules.  

Note: if you plan using the executable this will not be needed.

* [Python](https://www.python.org/downloads/) Will be used to execute Python scripts.  

Note: Remember to add Python to the system path, during the instillation.

* [AutoHotkey](https://www.autohotkey.com/) Will be used to execute AutoHotkey scripts.

## Installation

* Cloning the repository  

This require [Node](https://nodejs.org/en/) and [Git](https://git-scm.com/downloads) and installed.  

`git clone https://github.com/viktorholk/script-interactor` in your terminal, with [Git](https://git-scm.com/downloads) installed.  

You can also download the repository as a .zip file [here](https://github.com/viktorholk/script-interactor/archive/refs/heads/main.zip)  

Goto `./src` and type `npm install` in your terminal to install the necessary modules.  

Type `npm start` to run the application.  

You can skip this by downloading the latest [release](https://github.com/viktorholk/script-interactor/releases).

For further documentation check the [wiki](https://github.com/viktorholk/script-interactor/wiki).

* [Setup](https://github.com/viktorholk/script-interactor/wiki/Setup)

* [Scripts](https://github.com/viktorholk/script-interactor/wiki/Scripts)

* [Point system](https://github.com/viktorholk/script-interactor/wiki/Points-System)

* [OBS](https://github.com/viktorholk/script-interactor/wiki/Setup#obs)

## Issues

Please report issues using [GitHub's issues tab](https://github.com/viktorholk/script-interactor/issues), or in the [Discord](https://discord.gg/VEDrsqCn2D).

## License

Script Interactor is under the [MIT LICENSE](LICENSE).