Table of contents

• About
• Chatbot Usage
• Setup
• Contributing
• Plugin Development
• Help

About

Blazebot is a powerful Node.js Chatbot which utilizes the Trovo.js module allowing you to create powerful interactive chatbots quickly, and easily for the Trovo Platform.

Chatbot Usage

This is a Trovo.js bot, showcasing all the various plugins. Please follow the directions listed below in order to use this example to showcase a working functioning chatbot. :)

Open the settings.json and edit the values listed within.

• prefix: This is the Prefix your bot will respond too i.e. !pong so, '!' is the prefix.
• trovo.email: The Email of the Account the bot will be logging into.
• trovo.password: The Password of the Account the bot will be loggin' into.
• trovo.page: The Page where the Bot will be operating on. Needs to be in the format, https://trovo.live/<username>
• trovo.name: The Name of the Account the bot will use.

Setup

Video: How to Setup TrovoBot

1. Install Node.js and Chocolatey offered during installation.
2. Download the code as a .zip, and unpack into a folder where you want the bot to run from.
3. Fill in the Values inside of the settings.json file as explained above in Chatbot Usage.
4. Open command prompt, change the directory by cd <folder-address> change the folder-address to the one you made in step 2.
5. Type, npm install to install the required packages for the bot.
6. Once completed type, node ./index.js to start Blazebot.

Alternately in the "bat" folder, after you setup the.env file, run install-deps.bat then run startup-bot.bat

Reporting a bug

Before creating an issue, please ensure that it hasn't already been reported/suggested.

Plugin Development / Contributing

All developers are welcome to make Pull Requests with Plugins you've created!

The following infos are meant for developers. If you have any questions feel free to join our Discord (link above) and ask questions. If you would like to contribute in any way (bugfixes, features, etc.) please adhere to the following points:

• Fork this repository, create a feature branch, do your changes in this feature branch, and then create a Pull Request from that. Your pull request needs to be auto-mergeable. Therefore, if there were any intermediate commits on the project since you created the feature branch, please resolve the conflicts by e.g. rebasing your branch.
• The project exploded in the first couple of days (feature and commit wise) which resulted in a messy code base. That's why we decided to use Prettier & ESLint. Before creating a Pull Request your code has to match these requirements. To display any errors run node ./node_modules/eslint/bin/eslint.js .

This will display all errors and warnings. Most of these things can probably be fixed automatically (like code formatting). To do this, run node ./node_modules/eslint/bin/eslint.js . --fix

Chat Command Plugin Example

• The folder structure for plugins is the following: plugins/<pluginname>. Inside the <pluginname> folder you need to put a file called <pluginname>.js with your plugin. Optionally you can add a settings.json and a README.md file.

Plugin example inside Plugin Template in the github.

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official discord: Streamer's Workshop.

OBS Plugin

More info can be found on the wiki page, OBS Alerts.

SLOBS Plugin

More info can be found on the wiki page, SLOBS Alerts setup.

HTTP Overlay Plugin

Create a Data JSON file in /modules/http/data/<filehere.json> Event plugins showcasing stuff are located in /events/http-overlay-text-*.js

URL http://localhost:/text/ <-- filehere is the name of the json file you created, without .json