Twitch Drops Miner Documentation

repository·master·Indexed 25 days ago

https://github.com/devilxd/twitchdropsminer

A tool by DevilXD designed to automatically mine timed Twitch drops by fetching stream metadata to save bandwidth. It features game priority lists, automatic channel switching, and concurrent channel tracking via sharded websockets. Supports Windows, Linux (AppImage/PyInstaller), and macOS, with a CLI for controlling verbosity, logging, and data-dumping.

Tokens
1.3K
Snippets
0
Records
12
Agent score
84%

What's inside Twitch Drops Miner

  1. Configure game priority and mining modes

    master

    You can control which games the miner focuses on using the following settings:

    • Priority List: Located in the Settings tab. Add specific games here to ensure the miner prioritizes them. After updating, press Reload to fetch applicable streams.
    • Priority Mode: Use this setting to specify the mining order for all other games that are not explicitly listed in your Priority List. This keeps the miner occupied with any available drops beyond your selection.
    • Manual Switching: You can manually switch to a different channel within the application as needed.
  2. Install and run Twitch Drops Miner

    master

    To use the application, follow these steps:

    1. Download: Get the latest release from the GitHub releases page.
    2. Extract: Unzip the downloaded archive. It is recommended to keep the contents in the folder they were extracted into.
    3. Login: Run the application and use the in-app login form to connect your Twitch account.
    4. Configure: After logging in, the app fetches available campaigns. Go to the Settings tab to add games to your Priority List, then click the Reload button to start mining.

    Note: The application requires Python 3.10 or higher if running from source.

  3. Avoid conflicts when using the same Twitch account

    master

    Do not use the same Twitch account to watch streams in a web browser (or any other method) while the miner is active.

    Doing so can cause the miner to misbehave, resulting in false progress reports and the miner getting stuck on the current drop.

  4. Handle macOS Gatekeeper security blocks

    master

    Because the macOS version is not signed with a paid Apple Developer Certificate, macOS Gatekeeper may block it with an error stating "The application is damaged and can't be opened".

    To resolve this, run the following command in your terminal to remove the quarantine attribute:

    xattr -cr "Twitch Drops Miner (by DevilXD).app"

    Alternatively, you can type xattr -cr (with a trailing space) in the terminal and drag the application file into the window to auto-fill the path.

  5. Security warning for cookies.jar

    master

    The application stores your Twitch authorization (login) information in a file named cookies.jar.

    CAUTION: This file contains persistent cookies that allow anyone who possesses it to access your Twitch account without your password. Keep this file secure.

  6. Platform-specific notes for Windows, Linux, and macOS

    master

    Windows

    • Antivirus: Some engines (like Windows Defender) may flag the PyInstaller-packaged .exe as a trojan. These are false positives and can be safely ignored.
    • Storage: The executable uses %TEMP% for temporary runtime files. Persistent data (like cookies.jar) is stored in the directory where the executable resides.
    • Autostart: The autostart feature uses a registry entry in HKCU. If you move the application to a different directory, you must toggle the autostart option off and back on to fix it.

    Linux

    • Formats: Available as AppImage (recommended) and PyInstaller.
    • Requirements: Requires glibc>=2.35 and a working display server.
    • Dependencies: The Linux build is larger because it includes gtk3 for system tray and notification support.

    macOS

    • Storage: Persistent files (cookies.jar, settings.json, lock.file, and the cache folder) are stored inside the application bundle at: Twitch Drops Miner (by DevilXD).app/Contents/MacOS
    • To access this directory, right-click the app and select Show Package Contents.
  7. Interpret Twitch Drops Miner exit codes

    master

    When the application terminates, it returns an exit code that indicates the reason for shutdown. Use these codes to diagnose issues in automated environments or scripts:

    • 0: Application exited successfully
    • 1: Exit caused by a CAPTCHA or a Fatal Exception
    • 2: Incorrect command line arguments
    • 3: Application already running
    • 4: Loading of the settings file failed
  8. Use command line arguments with Twitch Drops Miner

    master

    Twitch Drops Miner can be controlled via several command line arguments to modify its startup behavior, logging, and debugging modes.

    Available Arguments

    • --tray: Starts the application minimized into the system tray.
    • -v: Increases verbosity level. This flag can be stacked (e.g., -vv, -vvv) to show more information during runtime.
    • --log: Enables logging of runtime information into a log.txt file. The logging verbosity matches the level set by the -v flag.
    • --dump: Starts the application in data-dump mode. It creates a dump.dat file containing anonymous raw Twitch API data for troubleshooting. The application will automatically close once the dump is finished.
    • --version: Displays the application version information.
  9. Exit Codes

    master

    The application uses the following exit codes to indicate the reason for termination:

    • 0: Successful exit.
    • 1: Fatal error encountered or CaptchaRequired exception.
    • 3: Application is already running (lock file exists).
    • 4: Error loading the settings file.