https://github.com/Carmoruda/Avocadobot

🤖 Twitch chatbot that will allow chat to run commands, etc
https://github.com/Carmoruda/Avocadobot

bot chatbot streamer streaming twitch twitch-bot twitchtv

Last synced: 3 months ago
JSON representation

🤖 Twitch chatbot that will allow chat to run commands, etc

• Host: GitHub
• URL: https://github.com/Carmoruda/Avocadobot
• Owner: Carmoruda
• License: gpl-3.0
• Created: 2022-06-09T14:53:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-09-04T22:53:26.000Z (over 2 years ago)
• Last Synced: 2023-03-06T09:27:10.130Z (almost 2 years ago)
• Topics: bot, chatbot, streamer, streaming, twitch, twitch-bot, twitchtv
• Language: JavaScript
• Homepage:
• Size: 234 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Avocadobot

![Build Status](https://img.shields.io/github/checks-status/carmoruda/avocadobot/main)

[![BCH compliance](https://bettercodehub.com/edge/badge/Carmoruda/Avocadobot?branch=main)](https://bettercodehub.com/)

![Languages](https://img.shields.io/github/languages/count/carmoruda/avocadobot)

![Top Language](https://img.shields.io/github/languages/top/carmoruda/avocadobot)

[![Total Downloads](https://img.shields.io/github/downloads/carmoruda/avocadobot/total)](https://github.com/Carmoruda/avocadobot/releases)

[![Version](https://img.shields.io/github/release/carmoruda/avocadobot)](https://github.com/Carmoruda/avocadobot/releases)

[![License](https://img.shields.io/github/license/carmoruda/avocadobot)](https://github.com/Carmoruda/Avocadobot/blob/main/LICENSE)

![Repo starts](https://img.shields.io/github/stars/carmoruda/avocadobot?style=social)

Avocadobot is a Twitch chatbot powered by Javascript. It is a simple chatbot that can be used to provide simple commands to Twitch users.

## Run the bot

1. Create a [Twitch](www.twitch.tv) account for the bot.

2. Create an application with the bot account using [Twitch dev console](https://dev.twitch.tv/login) (2FA is needed for this). Set the URL to "https://twitchapps.com/tmi/".

3. Use the [token generator](https://twitchapps.com/tmi/) to generate an Auth token.

4. Download the latests version of Avocadobot from [GitHub](https://github.com/Carmoruda/jellybot/releases).

5. If you don't have it already installed, download the latest version of [Node.js](https://nodejs.org/en/download/current/) (v15.14.0 or newer is required.)

6. In your terminal or command prompt, navigate to the folder where Avocadobot is located.

7. Install [tmi.js](https://www.npmjs.com/package/tmi.js) with the following command: `npm install -D tmi.js`

8. Install [chalk](https://www.npmjs.com/package/chalk) with the following command: `npm install -D chalk`

9. Install [dotenv](https://www.npmjs.com/package/dotenv) with the following command: `npm install -D dotenv`

10. In the `.env` file, replace `bot_name` with the name of the bot.

11. In the `.env` file, replace `oauth_token` with the Auth token you generated in Step 3 (the token must include at the beginning the following: `oauth:` followed by the token).

12. In the `index.js` file, replace `["channel_name"]` with the name of the channel you want the bot to log messages from.

13. To run the bot, use the following command: `node index.js`

## FAQ?

### How do I install / get Avocadobot?

Head on over to the [release page](https://github.com/Carmoruda/jellybot/releases) and download the latest version.

### How to report a bug?

You may create a bug report on the [issues page](https://github.com/Carmoruda/jellybot/issues/new/choose)

### Where to share a new feature idea?

You may create a feature request on the [issues page](https://github.com/carmoruda/jellybot/issues/new/choose)

## Contributing

See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project.

For quick fixes and more complex contributions, you can open an issue using the most appropiate [issue template](https://github.com/carmoruda/jellybot/issues/new/choose) to describe the changes you'd like to see.

If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/carmoruda/jellybot/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions.

## License

This code (everything in this repository) is licensed under the GNU General Public License v3.0. With this meaning, you may use the code in this repository, modify it as you see fit, and distribute this code. However, if you were to release it, it must be under the same license, make it open source, and provide documentation of the changes. All versions must have copyright credit pointing back to this source.

Anything using this code must be under the GNU Public License, and a copyright credit must point back here.