# ttvdropbot
**Repository Path**: ironV/ttvdropbot
## Basic Information
- **Project Name**: ttvdropbot
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-26
- **Last Updated**: 2024-11-30
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
TTVDropBot
Farms automatically Twitch Drops for you!
## 🤔 **What is this Twitch Bot all about?**
* Makes your twitch drop experience as easy as possible.
* No need to watch the stream in a browser, fully uses twitch inner gql.
* No need to care about who is online and when.
* Saves your twitch session providing you autologin.
* Can watch every Twitch Drop / Campaign available.
* Automatically claims your Drops.
* Switches automatically to other games or drops if drop is claimed/claimable or offline.
* Send Discord Webhooks to your server.
* Host 24/7 on heroku.
## ⚡ **Installation**
Windows
1. Download the windows executable from the **[build branch](https://github.com/Zaarrg/TTVDropBot/tree/build)** or **[release page](https://github.com/Zaarrg/TTVDropBot/releases)**.
2. Move the executable to a folder.
3. **Execute** the `TTVDropBot.exe`. The **settings** and **twitch-session** will be generated right beside the executable.
Linux
1. Download the linux executable from the **[build branch](https://github.com/Zaarrg/TTVDropBot/tree/build)** or **[release page](https://github.com/Zaarrg/TTVDropBot/releases)**.
2. Move the executable to a folder.
3. Give the `TTVDropBot-linux-x64` file permission to execute via chmod if needed.
```bash
chmod +x ./TTVDropBot-linux-x64
```
4. **Execute** the `TTVDropBot-linux-x64`. The **settings** and **twitch-session** will be generated right beside the executable.
```bash
./TTVDropBot-linux-x64
```
Ubuntu
Using Bot with No GUI - Only Command Line
1. Download the linux executable from the **[build branch](https://github.com/Zaarrg/TTVDropBot/tree/build)** or **[release page](https://github.com/Zaarrg/TTVDropBot/releases)**.
2. Drag and Drop a `settings.json` and `twitch-session.json` file right beside the executable.
3. Make sure you have set `displayless` to `true` in your settings.json
4. **Execute** the `TTVDropBot-linux-x64`.
```bash
./TTVDropBot-linux-x64
```
⚠️ _If you want to specifiy wich games to watch use the **Prioritylist** setting_ ⚠️
⚠️ _If you want to watch Custom Channels drag and drop a `customchannels.json` to your executable location and set `ForceCustomChannel` in settings.json to `true`_ ⚠️
⚠️ _If you can't seem to get any progress on drops "always stuck" try loging in instead of copying twitch-session.json._ ⚠️
Npm
1. Clone the **[Repository](https://github.com/Zaarrg/TTVDropBot)**.
```bash
git clone https://github.com/Zaarrg/TTVDropBot
```
2. Install NPM packages.
```bash
cd TTVDropBot/
npm install
```
3. Run the bot via npm scripts.
```bash
npm run start:production
OR
npm run start:dev
```
---
## 📚 **How to use the Bot?**
Step by Step Usage: Twitch Drops
**1. Step**
Select the way you want to Log in into your twitch account.
⚠️ If you cant login directly because of CAPTCHA use the browser method. ⚠️
⚠️ Only Chromium Browsers are supported like Brave and Chrome . ⚠️
**2. Step**
Select Twitch Drops to watch a Twitch Campaign or Custom Channels if you want to add your own channels. Refer to Step by Step Usage: Custom Channels for those.
**3. Step**
Select the campaign you want to start watching. If you want to only watch certain campaign and not all refer to Settings: Priority list
**4. Step**
Select the Drop you want to start watching.
**5. Step**
🎉 Enjoy! You are successfully watching your drop.
Step by Step Usage: Custom Channels
**1. Step**
Select Custom Channels to start watching them.
**2. Step**
Fill in the needed information to add a Channel. They can always be modified in the customchannel.json
**3. Step**
Select the Channel you want to start. The bot will switch between the Custom Channels, if one goes offline.
**4. Step**
🎉 Enjoy! You are successfully watching your Custom Channel.
Step by Step Usage: Heroku
⚠️ Only Recommended for advanced users. ⚠️
**1. Step**
Click on the Deploy to Heroku Button at the top of the Readme
**2. Step**
Login if necessary, and choose any app name you want, select your region and click Deploy app
After that let Heroku go through the build process and then click on Manage App
**3. Step**
Go to the Resources tab and disable the web dyno and enable the worker instead
**4. Step**
Click on more in the top right corner and then on Run console.
Type in bash and click Run.
**5. Step**
Now run the command node ./build/index.js --showtoken in the Terminal.
Login Directly via command Line, until you see your auth token and copy it.
**6. Step**
Close the Terminal and go to Settings then Reveal Config Vars
Now type in as key ttvdropbot_token and as value your copied token and click add
You can find more environment variables
here
**7. Step**
🎉 Thats it Enjoy! You are successfully watching.
To check if its working click on more in the top right corner then view logs.
Give it some time to start up, and you should see the bot working.
---
## 📝 **Settings**
Down below you can find the settings Variables and what they do.
### Chromeexe
- The path of your Browser: Linux: google-chrome | Windows: C:\Program Files\Google\Chrome\Application\chrome.exe
### UserDataPath
- Providing a userdatapath, will give the loginpage the option to use cookies out of your browser. Option not really needed anymore.
- You can find the UserdataPath under chrome://version then under Profile Path
### Webhook
- The Discord Webhook URL: https://discord.com/api/webhooks/...
### WebHookEvents
- Set what events should be send via webhook.
- Defaults to: ["requestretry", "claim", "newdrop", "offline", "newgame", "get", "getresult", "progress", "start", "error", "warn", "info"]
### Debug
- Will log important values to the console for debugging.
### Displayless
- Give the ability to use the bot fully automated with no user input needed. Especially useful for gui-less systems. See [Ubuntu - No Gui](https://github.com/Zaarrg/TTVDropBot/#ubuntu)
### ForceCustomChannel
- Force the bot to watch Custom Channels, only useful for display-less mode.
### ProgressCheckInterval
- The time in ms, in what interval the progress should be checked. Recommended is `60000 ms - 60 s` anything under could cause twitch blocking your request.
### RetryDelay
- The time in ms, in what interval failed requests should be retried. Recommended is `60000 ms - 60 s` anything under could cause twitch blocking your request.
### WaitforChannels
- If set to false the Bot will no longer wait 5 Minutes for new Channels to come online. It will switch to another game instead.
### Prioritylist
- A list of Games the bot should watch / prioritize. Only Provide games with active Drop Campaigns in this Format:
`["Rust","Fortnite", "Elite: Dangerous"]`
- You can get the valid name from: `https://www.twitch.tv/directory`
- If provided the bot will only watch the games listed.
### AutoClaim
- Allow the bot to autoClaim or not
### LogToFile
- Log the Console to a file.
---
## ✏️ **Start Arguments**
All available start Arguments, basically everything which is also in the [settings.json](https://github.com/Zaarrg/TTVDropBot#-settings) file.
```bash
./TTVDropBot.exe --help
Usage: ./TTVDropBot or index.js --arg...
Options:
--help Show help. [boolean]
--version Show version number. [boolean]
-c, --chrome The path to your Chrome executable. [string]
-u, --userdata The path to your userdata folder location. [string]
--webhook, --wh The Discord Webhook URL. [string]
--webhookevents Set what events should be send via webhook. [array]
-i, --interval The progress interval in ms. [number]
--retryinterval, --retry The retry interval in ms. [number]
-g, --games The Games the bot should watch. [array]
--token Your twitch auth_token. [string]
-d, --debug Enable Debug logging. [boolean]
--displayless, --dl Enable Displayless mode. [boolean]
--forcecustomchannel Force Custom Channels. Only useful for
display-less mode. [boolean]
--waitforchannels, --waitonline Disable waitforchannels, forcing the bot to not wait
for other channels with drops instead switch the game. [boolean]
--autoclaim Enable autoclaim. [boolean]
--log Enable logging to file. [boolean]
--tray Start app in the tray. [boolean]
Examples:
--chrome C:path:to:chrome.exe Sets your chrome path.
--userdata C:path:to:userdata-folder Sets your userdata path.
--webhook https:discord.com:api:webh.... Sets your webhook url.
--webhookevents requestretry claim Defaults to the events in this
newdrop offline newgame get getresult example provided.
progress start error warn info
--interval 30000 Sets the progress interval to 30s.
--retryinterval 30000 Sets the retry interval to 30s.
--games Rust Krunker 'Elite: Dangerous' Sets the Prioritylist to Rust,
Krunker and Elite: Dangerous.
--token yourkindalongtoken Sets the your current twitch auth
token, overwriting any in
twitch-session.json.
```
## ✏️ **Environment variables**
All these Start Arguments also work as environment variable:
```bash
ttvdropbot_chrome = YourPath
ttvdropbot_userdata = YourPath
ttvdropbot_webhook = DiscordWebhookURL
ttvdropbot_interval = 60000
ttvdropbot_games = Game1 Game2 Game3... ⚠️ Black Desert -> Black_Desert ⚠️
ttvdropbot_debug = true || false
ttvdropbot_displayless = true || false
ttvdropbot_forcecustomchannel = true || false
ttvdropbot_waitforchannels = true || false
ttvdropbot_autoclaim = true || false
ttvdropbot_log = true || false
ttvdropbot_retryinterval = 60000
ttvdropbot_webhookevents = Event1 Event2 Event3...
ttvdropbot_showtoken = true || false Usefull for System were you cant access your twitch-session.json
ttvdropbot_token = YourToken
```
## 📘 Adding Custom Channels
### Name
- The Name can be any String like `Rainbow Six, Best Ch ever etc...`
### Twitch Url
- The Url is very important, never use the same Url twice, it has to be a valid Channel link and has always to start with `https://www.twitch.tv/`. Example for a Valid Url: `https://www.twitch.tv/rainbow6tw`
### How the Channel should be Watched
`Watch until the time runs out:`
- Watches the channel until the left time reaches 0 then switches to other custom channel.
`Watch indefinitely:`
- Watches the channel until it goes offline, then switches.
### Farm Points
- Pretty simple, should the bot farm Points or not.
### Editing already Added Channel's
- You can always edit Channel's which are already added in the [CustomChannels.json]('https://github.com/Zaarrg/TTVDropBot/#example-customchannelsjson').
---
## 📄 Json Files Examples
### Example Settings.json
```json
{
"Chromeexe": "",
"UserDataPath": "",
"WebHookURL": "",
"WebHookEvents": [],
"debug": false,
"displayless": false,
"ProgressCheckInterval": 60000,
"RetryDelay": 60000,
"WaitforChannels": true,
"Prioritylist": [],
"AutoClaim": true,
"LogToFile": true,
"ForceCustomChannel": false
}
```
### Example CustomChannels.json
```json
[
{
"Name": "tarik",
"TTVLink": "https://www.twitch.tv/tarik",
"WatchType": "Watch until time runs out",
"Time": "50",
"Points": true
}
]
```
### Example Twitch Session
```json
[
{
"name": "auth-token",
"value": "yourtoken"
}
]
```
⚠️ _Never share your **Token** with anyone, because it gives full access to your account_ ⚠️
---
## 🎉 Enjoy the bot and hopefully its helpful!
[](https://github.com/Zaarrg)
[](https://github.com/Zaarrg/TTVDropBot/stargazers)
[](https://github.com/Zaarrg/TTVDropBot/watchers)
[](https://github.com/Zaarrg/TTVDropBot/network/members)
Have fun and Enjoy! 😃
---
## 🍰 Contact
**_Quickest Response:_**
Discord Server: https://discord.gg/rV26FZ2upF
**_Slow Response:_**
Discord: - Zarg#8467
> Distributed under the MIT License. See LICENSE for more information.⚠️
_Made with a lot of ❤️❤️ by **[@Zarg](https://github.com/Zaarrg)**_