OpenDevBot

Twitch Chatbot
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

a personal chat bot for my twitch channel, will make it usable on other channels at some point, im only a beginner coder but as i learn how to code better i will add more features to the bot, currently working on features that can be checked out in the Roadmap Section of this readme.

(back to top)

Built With

• Twurple
• Express.js
• guilded.js Basics, just for discord Embeds for webhooks

(back to top)

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• node
  Node

• Code Editor[Optional Choices] NOTE: i do not know how to setup the project with Atom so everything is based on VS Code
  VS Code
  Atom
  

Installation

1. Create a Twitch Dev Application Twitch Developer Application, you will need access to a discord bot aswell, for webhooks

2. Clone the repo

   git clone https://github.com/skullgaming31/OpenDevBot.git

3. Install NPM packages

   npm install

4. Fill out the .env with all nessasary Information, check .env.example for whats needed

(back to top)

Roadmap

• Connected auth to account
• Connected ChatClient
• connected to PubSub(Dont Use Anymore)
• connected to EventSub with websockets
• add commands
  • commands load from there own .ts file
  • convert followage/accountage to years,months,day,hours,minutes,seconds
  • convert uptime to display days,hours,minutes,seconds(24 hour streams)
• add word detection to send commands without prefix
• create channelPoints with userToken to modify the channel points with commands [Hard Coded ChannelPoints]
• Advanced Lurk Command
• Timer Commands
• Counters
• Quotes System?
• Viewer Watch Time?
• Virtual Currency System
  • duel
  • dig
  • Heist
  • Gamble
• Que/delay webhooks being sent to avoid being rate limited by the Discord API

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature)
3. Commit your Changes (git commit -m 'describe your feature')
4. Push to the Branch (git push origin feature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

📫 How to reach me:

skullgaminghq
Email

Other Projects: Projects

(back to top)

Acknowledgments

• Twurple Twitch Library

(back to top)