majjo/Twitch-Drops-Miner
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

English

Browse Source 
Typos/grammar
This commit is contained in:
Keluke
2021-02-27 11:23:27 +02:00
parent b8f6fd09f0
commit 0ca2d96f6c
5 changed files with 29 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -10,7 +10,7 @@ Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue) - [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality) - [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected)
# How Has This Been Tested? # How Has This Been Tested?
@@ -19,7 +19,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi
# Checklist: # Checklist:
- [ ] My code follows the style guidelines of this project - [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code - [ ] I have performed a self-review of my code
- [ ] I have commented on my code, particularly in hard-to-understand areas - [ ] I have commented on my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation (README.md) - [ ] I have made corresponding changes to the documentation (README.md)
- [ ] My changes generate no new warnings - [ ] My changes generate no new warnings

8
CONTRIBUTING.md
View File

@@ -4,7 +4,7 @@
Before you begin: Before you begin:
- Have you read the [code of conduct](CODE_OF_CONDUCT.md)? - Have you read the [code of conduct](CODE_OF_CONDUCT.md)?
- Check out the [existing issues](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/issues) & see if there is already an opened issued - Check out the [existing issues](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/issues) & see if there is already an opened issue.
### Ready to make a change? Fork the repo ### Ready to make a change? Fork the repo
@@ -72,14 +72,14 @@ Labels can help you find an issue you'd like to help with.
- The `documentation` label is used when you suggest improvements or additions to documentation (README.md update) - The `documentation` label is used when you suggest improvements or additions to documentation (README.md update)
- The `duplicate` label is used when this issue or pull request already exists - The `duplicate` label is used when this issue or pull request already exists
- The `enhancement` label is used when you ask for / or propose a new feature or request - The `enhancement` label is used when you ask for / or propose a new feature or request
- The `help wanted` is used when labeling when you need help with something - The `help wanted` is used when you need help with something
- The `improvements` label is used when you would suggest improvements on already existing features - The `improvements` label is used when you would suggest improvements on already existing features
- The `invalid` label is used for a non-valid issue - The `invalid` label is used for a non-valid issue
- The `question` label, is used for further information is requested - The `question` label is used for further information is requested
- The `wontfix` label is used if we will not work on it - The `wontfix` label is used if we will not work on it
## Opening a pull request ## Opening a pull request
You can use the GitHub user interface :pencil2: for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally to view changes and run your tests on your machine. You can use the GitHub user interface :pencil2: for minor changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally to view changes and run your tests on your machine.
### Self review ### Self review
You should always review your own PR first. You should always review your own PR first.

32
README.md
View File

@@ -40,7 +40,7 @@ Read more about channels point [here](https://help.twitch.tv/s/article/channel-p
## Community ## Community
If you have any type of issue, you need help, or you just want to suggest a new feature, please open a GitHub Issue. Don't write me on [Instagram](https://www.instagram.com/tkd_alex/), [Telegram](https://t.me/TkdAlex), [Discord](https://discordapp.com/users/641397388132483121), [Twitter](https://twitter.com/TkdAxel) (but you can follow me 😆) or somewhere else. If you don't have an account on this platform, you can create it. It's free. I do not want to be rude, but if you have a problem, maybe another user can also have the same problem, and your issue can help the community. Same for the new feature, your idea can help other users, and It's beautiful to discuss between us. If you have any type of issue, need help, or want to suggest a new feature, please open a GitHub Issue. Don't write me on [Instagram](https://www.instagram.com/tkd_alex/), [Telegram](https://t.me/TkdAlex), [Discord](https://discordapp.com/users/641397388132483121), [Twitter](https://twitter.com/TkdAxel) (but you can follow me 😆) or somewhere else. If you don't have an account on this platform, you can create it. It's free. I do not want to be rude, but if you have a problem, maybe another user can also have the same problem, and your issue can help the community. Same for the new feature, your idea can help other users, and It's beautiful to discuss between us.
If you want to help on this project, please leave a star 🌟 and share it with your friends! 😎 If you want to help on this project, please leave a star 🌟 and share it with your friends! 😎
@@ -160,7 +160,7 @@ No browser needed. [#41](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner
## How to use: ## How to use:
1. Clone this repository `git clone https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2` 1. Clone this repository `git clone https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2`
2. Install all the requirements `pip install -r requirements.txt` . If you have problems with requirements make sure to have at least Python3.6. You could also try to create a virtualenv and then install all the requirements 2. Install all the requirements `pip install -r requirements.txt` . If you have problems with requirements, make sure to have at least Python3.6. You could also try to create a virtualenv and then install all the requirements
```sh ```sh
pip install virtualenv pip install virtualenv
virtualenv -p python3 venv virtualenv -p python3 venv
@@ -181,12 +181,12 @@ from TwitchChannelPointsMiner.classes.entities.Streamer import Streamer, Streame
twitch_miner = TwitchChannelPointsMiner( twitch_miner = TwitchChannelPointsMiner(
username="your-twitch-username", username="your-twitch-username",
password="write-your-secure-psw", # If no password will be provided the script will ask interactively password="write-your-secure-psw", # If no password will be provided, the script will ask interactively
claim_drops_startup=False, # If you want to auto claim all drops from Twitch inventory on startup claim_drops_startup=False, # If you want to auto claim all drops from Twitch inventory on the startup
priority=[ # Custom priority in this case for example: priority=[ # Custom priority in this case for example:
Priority.STREAK, # - we want first of all to catch all watch streak from all streamers Priority.STREAK, # - We want first of all to catch all watch streak from all streamers
Priority.DROPS, # - when we don't have anymore watch streak to catch wait until all drops are collected over the streamers Priority.DROPS, # - When we don't have anymore watch streak to catch, wait until all drops are collected over the streamers
Priority.ORDER # - when we have all of drops claimed and no watch-streak avaialable use the order priority (POINTS_ASCENDING, POINTS_DESCEDING) Priority.ORDER # - When we have all of the drops claimed and no watch-streak available, use the order priority (POINTS_ASCENDING, POINTS_DESCEDING)
], ],
logger_settings=LoggerSettings( logger_settings=LoggerSettings(
save=True, # If you want to save logs in a file (suggested) save=True, # If you want to save logs in a file (suggested)
@@ -196,7 +196,7 @@ twitch_miner = TwitchChannelPointsMiner(
less=False, # If you think that the logs are too verbose, set this to True less=False, # If you think that the logs are too verbose, set this to True
colored=True, # If you want to print colored text colored=True, # If you want to print colored text
color_palette=ColorPalette( # You can also create a custom palette color (for the common message). color_palette=ColorPalette( # You can also create a custom palette color (for the common message).
STREAMER_online="GREEN", # Don't worry about lower/upper case the script will be parse all the values. STREAMER_online="GREEN", # Don't worry about lower/upper case. The script will parse all the values.
streamer_offline="red", # Read more in README.md streamer_offline="red", # Read more in README.md
BET_wiN=Fore.MAGENTA # Color allowed are: [BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET]. BET_wiN=Fore.MAGENTA # Color allowed are: [BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET].
) )
@@ -254,7 +254,7 @@ twitch_miner.mine(["streamer1", "streamer2"]) # Array of strea
twitch_miner.mine(followers=True) # Automatic use the followers list OR twitch_miner.mine(followers=True) # Automatic use the followers list OR
twitch_miner.mine(["streamer1", "streamer2"], followers=True) # Mixed twitch_miner.mine(["streamer1", "streamer2"], followers=True) # Mixed
``` ```
If you follow so many streamers on Twitch, but you don't want to mine points for all of them, you can blacklist the users with `blacklist` keyword. [#94](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/issues/94) If you follow so many streamers on Twitch, but you don't want to mine points for all of them, you can blacklist the users with the `blacklist` keyword. [#94](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/issues/94)
```python ```python
from TwitchChannelPointsMiner import TwitchChannelPointsMiner from TwitchChannelPointsMiner import TwitchChannelPointsMiner
twitch_miner = TwitchChannelPointsMiner("your-twitch-username") twitch_miner = TwitchChannelPointsMiner("your-twitch-username")
@@ -263,13 +263,13 @@ twitch_miner.mine(followers=True, blacklist=["user1", "user2"]) # Automatic use
4. Start mining! `python run.py` 4. Start mining! `python run.py`
### Limits ### Limits
> Twitch has a limit - you can't watch more than 2 channels at one time. We take the first two streamers from the list as they have the highest priority. > Twitch has a limit - you can't watch more than two channels at one time. We take the first two streamers from the list as they have the highest priority.
Make sure to write the streamers array in order of priority from left to right. If you use `followers=True` Twitch return the streamers order by followed_at. So your last follow has the highest priority. Make sure to write the streamers array in order of priority from left to right. If you use `followers=True` Twitch return the streamers order by followed_at. So your last follow has the highest priority.
## Settings ## Settings
Most of the settings are self-explained and are commented in example. Most of the settings are self-explained and are commented on in the example.
You can watch only two streamers per time. With `priority` settings you can select which streamers watch by use priority. You can use an array of priority or single item. I suggest to use at least one priority from `ORDER`, `POINTS_ASCENDING`, `POINTS_DESCEDING` because for example If you set only `STREAK` after catch all watch streak the script will stop to watch streamers. You can watch only two streamers per time. With `priority` settings, you can select which streamers watch by use priority. You can use an array of priority or single item. I suggest using at least one priority from `ORDER`, `POINTS_ASCENDING`, `POINTS_DESCEDING` because, for example, If you set only `STREAK` after catch all watch streak, the script will stop to watch streamers.
Available values are the following: Available values are the following:
- `STREAK` - Catch the watch streak from all streamers - `STREAK` - Catch the watch streak from all streamers
- `DROPS` - Claim all drops from streamers with drops tags enabled - `DROPS` - Claim all drops from streamers with drops tags enabled
@@ -330,7 +330,7 @@ ColorPalette(
|-------------------- |------------- |-------------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |-------------------- |------------- |-------------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `make_predictions` | bool | True | Choose if you want to make predictions / bet or not | | `make_predictions` | bool | True | Choose if you want to make predictions / bet or not |
| `follow_raid` | bool | True | Choose if you want to follow raid +250 points | | `follow_raid` | bool | True | Choose if you want to follow raid +250 points |
| `claim_drops` | bool | True | If this value is True, the script will increase the watch-time for the current game. With this, you are able to claim the drops from Twitch Inventory [#21](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/issues/21) | | `claim_drops` | bool | True | If this value is True, the script will increase the watch-time for the current game. With this, you can claim the drops from Twitch Inventory [#21](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/issues/21) |
| `watch_streak` | bool | True | Choose if you want to change a priority for these streamers and try to catch the Watch Streak event [#11](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/issues/11) | | `watch_streak` | bool | True | Choose if you want to change a priority for these streamers and try to catch the Watch Streak event [#11](https://github.com/Tkd-Alex/Twitch-Channel-Points-Miner-v2/issues/11) |
| `bet` | BetSettings | | Rules to follow for the bet | | `bet` | BetSettings | | Rules to follow for the bet |
### BetSettings ### BetSettings
@@ -348,7 +348,7 @@ ColorPalette(
- **MOST_VOTED**: Select the option most voted based on users count - **MOST_VOTED**: Select the option most voted based on users count
- **HIGH_ODDS**: Select the option with the highest odds - **HIGH_ODDS**: Select the option with the highest odds
- **PERCENTAGE**: Select the option with the highest percentage based on odds (It's the same that show Twitch) - Should be the same as select LOWEST_ODDS - **PERCENTAGE**: Select the option with the highest percentage based on odds (It's the same that show Twitch) - Should be the same as select LOWEST_ODDS
- **SMART**: If the majority in percent chose an option, then follow the other users, otherwise choose the option with the highest odds - **SMART**: If the majority in percent chose an option, then follow the other users, otherwise select the option with the highest odds
![Screenshot](./assets/prediction.png) ![Screenshot](./assets/prediction.png)
@@ -357,7 +357,7 @@ Here a concrete example:
- **MOST_VOTED**: 21 Users have select **'over 7.5'**, instead of 9 'under 7.5' - **MOST_VOTED**: 21 Users have select **'over 7.5'**, instead of 9 'under 7.5'
- **HIGH_ODDS**: The highest odd is 2.27 on **'over 7.5'** vs 1.79 on 'under 7.5' - **HIGH_ODDS**: The highest odd is 2.27 on **'over 7.5'** vs 1.79 on 'under 7.5'
- **PERCENTAGE**: The highest percentage is 56% for **'under 7.5'** - **PERCENTAGE**: The highest percentage is 56% for **'under 7.5'**
- **SMART**: Calculate the percentage based on the users. The percentages are: 'over 7.5': 70% and 'under 7.5': 30%. If the difference between the two percentages are higher than `percentage_gap` select the highest percentage, else the highest odds. - **SMART**: Calculate the percentage based on the users. The percentages are: 'over 7.5': 70% and 'under 7.5': 30%. If the difference between the two percentages is higher than `percentage_gap` select the highest percentage, else the highest odds.
In this case if percentage_gap = 20 ; 70-30 = 40 > percentage_gap, so the bot will select 'over 7.5' In this case if percentage_gap = 20 ; 70-30 = 40 > percentage_gap, so the bot will select 'over 7.5'
### FilterCondition ### FilterCondition
@@ -388,7 +388,7 @@ Allowed values for `where` are: `GT, LT, GTE, LTE`
`FilterCondition(by=OutcomeKeys.TOP_POINTS, where=Condition.LT, value=2000)` `FilterCondition(by=OutcomeKeys.TOP_POINTS, where=Condition.LT, value=2000)`
## Migrating from an old repository (the original one): ## Migrating from an old repository (the original one):
If you already have a `twitch-cookies.pkl` and you don't want to login again, please create a `cookies/` folder in the current directory and then copy the .pkl file with a new name `your-twitch-username.pkl` If you already have a `twitch-cookies.pkl` and you don't want to log in again, please create a `cookies/` folder in the current directory and then copy the .pkl file with a new name `your-twitch-username.pkl`
``` ```
. .
+-- run.py +-- run.py

2
TwitchChannelPointsMiner/logger.py
View File

@@ -34,7 +34,7 @@ class GlobalFormatter(logging.Formatter):
if "\u2192" in record.msg: if "\u2192" in record.msg:
record.msg = record.msg.replace("\u2192", "-->") record.msg = record.msg.replace("\u2192", "-->")
# With the update of Stream class It's possible that the Stream Title contains emoji # With the update of Stream class, the Stream Title may contain emoji
# Full remove using a method from utils. # Full remove using a method from utils.
record.msg = remove_emoji(record.msg) record.msg = remove_emoji(record.msg)

11
example.py
View File

@@ -10,12 +10,12 @@ from TwitchChannelPointsMiner.classes.entities.Streamer import Streamer, Streame
twitch_miner = TwitchChannelPointsMiner( twitch_miner = TwitchChannelPointsMiner(
username="your-twitch-username", username="your-twitch-username",
password="write-your-secure-psw", # If no password will be provided the script will ask interactively password="write-your-secure-psw", # If no password will be provided, the script will ask interactively
claim_drops_startup=False, # If you want to auto claim all drops from Twitch inventory on startup claim_drops_startup=False, # If you want to auto claim all drops from Twitch inventory on the startup
priority=[ # Custom priority in this case for example: priority=[ # Custom priority in this case for example:
Priority.STREAK, # - we want first of all to catch all watch streak from all streamers Priority.STREAK, # - We want first of all to catch all watch streak from all streamers
Priority.DROPS, # - when we don't have anymore watch streak to catch wait until all drops are collected over the streamers Priority.DROPS, # - When we don't have anymore watch streak to catch, wait until all drops are collected over the streamers
Priority.ORDER # - when we have all of drops claimed and no watch-streak avaialable use the order priority (POINTS_ASCENDING, POINTS_DESCEDING) Priority.ORDER # - When we have all of the drops claimed and no watch-streak available, use the order priority (POINTS_ASCENDING, POINTS_DESCEDING)
], ],
logger_settings=LoggerSettings( logger_settings=LoggerSettings(
save=True, # If you want to save logs in a file (suggested) save=True, # If you want to save logs in a file (suggested)
@@ -26,6 +26,7 @@ twitch_miner = TwitchChannelPointsMiner(
colored=True, # If you want to print colored text colored=True, # If you want to print colored text
color_palette=ColorPalette( # You can also create a custom palette color (for the common message). color_palette=ColorPalette( # You can also create a custom palette color (for the common message).
STREAMER_online="GREEN", # Don't worry about lower/upper case the script will be parse all the values. STREAMER_online="GREEN", # Don't worry about lower/upper case the script will be parse all the values.
STREAMER_online="GREEN", # Don't worry about lower/upper case. The script will parse all the values.
streamer_offline="red", # Read more in README.md streamer_offline="red", # Read more in README.md
BET_wiN=Fore.MAGENTA # Color allowed are: [BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET]. BET_wiN=Fore.MAGENTA # Color allowed are: [BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, RESET].
) )