Skip to content

Simple bot that connects to Twitch chat to interact or output the status of your IRLbox Encoder

Notifications You must be signed in to change notification settings

IRLtools/IRLboxBOT

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

IRLboxBOT

Simple bot that connects to Twitch chat to interact or output the status of your IRLbox Encoder

Features

  • Logs incoming commands and their outputs
  • Handles several commands (!cpu, !memory, !disk, !temp, !devices, !irlbox start, !irlbox stop)
  • Error handling and automatic restart on failure
  • Outputs logs to a file in the /logs/ directory

Setup

Download

You have the option to run this compiled download here (#placeholder), or continue and follow the instructions

Prerequisites

  • Node.js
  • npm (Node Package Manager)
  • pkg (Node.js compiler)

Installation

  1. Clone the repository:

    git clone https://github.com/IRLtools/IRLboxBOT.git
    cd IRLboxBOT
  2. Install dependencies:

    npm install
  3. Create and update config.json with your Twitch and API credentials:

Command permissions/restrictions can be set to to mods, vip, streamer, and everyone.

{
"twitch": {
 "username": "YOUR_TWITCH_USERNAME",
 "password": "YOUR_TWITCH_OAUTH_TOKEN",
 "channels": ["#YOUR_CHANNEL_NAME"]
},
"api": {
 "baseUrl": "https://remote.irlbox.com/api/Server",
 "boardCuid": "YOUR_BOARD_CUID",
 "authToken": "Bearer YOUR_API_AUTH_TOKEN"
},
"commands": {
 "!cpu": "everyone",
 "!memory": "mods",
 "!disk": "streamer",
 "!temp": "everyone",
 "!devices": "mods",
 "!irlbox start": "streamer",
 "!irlbox stop": "streamer",
 "!reboot": "streamer"
}
}

  1. Start the bot:

    npm start

Usage

Commands

  • !cpu: Get CPU usage information
  • !memory: Get memory usage information
  • !disk: Get disk usage information
  • !temp: Get temperature information
  • !devices: Get devices information
  • !irlbox start: Start the IRLBox stream
  • !irlbox stop: Stop the IRLBox stream

License

This project is licensed under the MIT License.

About

Simple bot that connects to Twitch chat to interact or output the status of your IRLbox Encoder

Resources

Stars

Watchers

Forks

Packages

No packages published