Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

viktorholk/script-interactor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 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 Will be used to execute Python scripts.
    Note: Remember to add Python to the system path, during the instillation.
  • AutoHotkey Will be used to execute AutoHotkey scripts.

Installation

  • Cloning the repository
    This require Node and Git and installed.
    git clone https://github.com/viktorholk/script-interactor in your terminal, with Git installed.
    You can also download the repository as a .zip file here

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.

For further documentation check the wiki.

Issues

Please report issues using GitHub's issues tab, or in the Discord.

License

Script Interactor is under the MIT LICENSE.