Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.
viktorholk edited this page Apr 20, 2022 · 9 revisions

Initial Setup

Run the application first to create the necessary config files.
Open the settings.json in your config folder.
It will look something like this:

{
    "client": {
        "username": "",     // USERNAME OF YOUR BOT
        "oauth": "",        // OAuth TOKEN FOR YOUR BOT
        "channel": ""       // THE CHANNEL THE BOT WILL LISTEN IN
    },
    "prefix": "!",          // THE PREFIX OF THE BOT COMMANDS
    "cooldown": 5,          // THE GLOBAL COOLDOWN FOR ALL SCRIPTS
    ...

Fill in your bot's credentials.

  • Getting an OAuth token
    Go to twitchapps.com/tmi/ to generate your token.
    DO NOT SHARE THIS TOKEN WITH ANYONE

Remember that each time you change the configuration or add new scripts, restart the application.

Administrative Privileges

The appliation requires to be run as administrator.
This is because a lot of the scripts will not be working as intended otherwise.

  • Enable administrator privileges for the exectuable
    Right click on the executable, go to the compatibility page and enable Run this program as an administrator under the settings.
    run-as-administrator.png
  • Enable administrator privileges for the terminal
    If you're running the applicaton through the terminal. The terminal has to also be run with elevated privileges.
    When opening the terminal make sure you right click and Run as administrator

OBS

When a script gets executed, it's script name will be appended to the obs.txt file generated by the application.

With this, you can import the file in OBS, and the current running script will be displayed on your stream.

  • Go to your scene and Sources. Create a new Text Source.
  • Enable Read from file.
  • Browse the local path on your computer where Script Interactor is located. and select obs.txt
  • You can now move the text source to your desired location on your screen.

OBS

Clone this wiki locally