Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bankkroll/streamer-alerts-discord-bot
Discord bot to alert for Kick, Twitch, Youtube, Rumble, Tiktok... NO API KEYS REQUIRED
https://github.com/bankkroll/streamer-alerts-discord-bot
discord discord-js discordbot kick rumble tiktok twitch youtube
Last synced: about 1 month ago
JSON representation
Discord bot to alert for Kick, Twitch, Youtube, Rumble, Tiktok... NO API KEYS REQUIRED
- Host: GitHub
- URL: https://github.com/bankkroll/streamer-alerts-discord-bot
- Owner: BankkRoll
- License: mit
- Created: 2023-11-07T19:55:39.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-10T05:37:05.000Z (about 1 year ago)
- Last Synced: 2024-04-15T05:19:17.943Z (9 months ago)
- Topics: discord, discord-js, discordbot, kick, rumble, tiktok, twitch, youtube
- Language: JavaScript
- Homepage:
- Size: 42 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Streamer Notification Discord Bot
### NO API KEYS REQUIRED
## Overview
**StreamerBot** is a specialized Discord bot designed to track and notify users of live streams from their favorite content creators. Utilizing the Sapphire Framework, it provides an efficient and user-friendly experience.
- **Live Stream Tracking**: Monitors platforms like Kick.com, Twitch.com, YouTube.com, Rumble.com, TikTok.com ect..
- **Notification System**: Sends alerts when a tracked streamer goes live.
- **Streamer Management**: Add or remove streamers from the tracking list.
## Checklist
- [x] Kick working
- [x] YouTube working
- [x] Twitch working
- [x] Rumble working
- [ ] TikTok working
- [ ] Fix timestamps
- [ ] Restyle/Clean up embeds
- [ ] Clean tracking to be consistent for each platform ( ADD MORE PULLED DETAILS FOR EACH)
- should follow this format
```plaintext
platform: "", // platform name
username: "", // username
bio: "", // bio
followersCount: "", // number of followers
profileImageUrl: "", // profile image url
verified: "", // (or subscribed)
name: "", // username
title: "", // stream title
viewers: "", // live viewers
imageUrl: "", // live img preview url
startedAt: "", // stream start time
url: "", // stream url
```
## Installation Instructions
1. **Clone the Repository**:
```sh
git clone https://github.com/BankkRoll/streamer-alerts-discord-bot
cd streamer-alerts-discord-bot
```
2. **Install Dependencies**:
```sh
npm install
```
3. **Configure Settings**:
- Rename `config.json.example` to `config.json`.
- Edit `config.json` to include your bot token and any other required settings.
4. **Start the Bot**:
```sh
npm start
```
## Usage
- Use `/help` to see available commands.
- Admin commands like `/addstreamer` and `/removestreamer` manage the streamers list.
- Utility commands such as `/liststreamers` display all tracked streamers.
## Commands
### Admin Commands
1. `addstreamer`: Adds a new streamer to the notification list.
2. `removestreamer`: Removes a streamer from the notification list.
### Utility Commands
1. `help`: Lists all available commands and their usage.
2. `liststreamers`: Shows all streamers currently being tracked.
3. `ping`: Checks the bot's response time.
## Contributing
Contributions to the StreamerBot project are welcome! Please submit pull requests or open issues to suggest improvements or report bugs.
## License
> [!IMPORTANT]
> **Disclaimer:**
> Please note that the APIs used in this bot are not owned or maintained by us. The usage of these APIs is at your own risk, and we make no guarantees regarding the availability, accuracy, or functionality of these services. If you are the endpoint owner and would like to remove them please open a issue and ill handle it accordingly.
This project is licensed under the MIT License. For more details, see the [LICENSE](./LICENSE) file in the repository.