Skip to content

Commit

Permalink
Add a warning about watching streams in the browser during mining;
Browse files Browse the repository at this point in the history
Turn source code information into a note instead
  • Loading branch information
DevilXD committed Feb 9, 2025
1 parent 1997a51 commit b6a183b
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ Every several seconds, the application pretends to watch a particular stream by
### Notes:

> [!WARNING]
> Requires Python 3.10 or higher.
> Due to how Twitch handles the drop progression on their side, watching a stream in the browser (or by any other means) on the same account that is actively being used by the miner, will usually cause the miner to misbehave, reporting false progress and getting stuck mining the current drop.
>
> Using the same account to watch other streams during mining is thus discouraged, in order to avoid any problems arising from it.
> [!CAUTION]
> Persistent cookies will be stored in the `cookies.jar` file, from which the authorization (login) information will be restored on each subsequent run. Make sure to keep your cookies file safe, as the authorization information it stores can give another person access to your Twitch account, even without them knowing your password!
Expand All @@ -45,6 +47,9 @@ Every several seconds, the application pretends to watch a particular stream by
> [!NOTE]
> The time remaining timer always countdowns a single minute and then stops - it is then restarted only after the application redetermines the remaining time. This "redetermination" can happen at any time Twitch decides to report on the drop's progress, but not later than 20 seconds after the timer reaches zero. The seconds timer is only an approximation and does not represent nor affect actual mining speed. The time variations are due to Twitch sometimes not reporting drop progress at all, or reporting progress for the wrong drop - these cases have all been accounted for in the application though.
> [!NOTE]
> The source code requires Python 3.10 or higher to run.
### Notes about the Windows build:

- To achieve a portable-executable format, the application is packaged with PyInstaller into an `EXE`. Some antivirus engines (including Windows Defender) might report the packaged executable as a trojan, because PyInstaller has been used by others to package malicious Python code in the past. These reports can be safely ignored. If you absolutely do not trust the executable, you'll have to install Python yourself and run everything from source.
Expand Down

0 comments on commit b6a183b

Please sign in to comment.