Skip to content
This repository has been archived by the owner on Feb 2, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LeagueOfPoro committed Jul 25, 2022
1 parent f2fc95d commit 2c314f7
Showing 1 changed file with 49 additions and 7 deletions.
56 changes: 49 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,49 +9,75 @@ This tool makes the Chrome browser watch the matches for you!
- Closes finished matches
- Automatically logs user in
- Runs in background
- Sets Twitch quality to lowest possible
- Multiple accounts
- Sets Twitch quality to the lowest possible
- Checks for the Rewards check mark
- Experimental support for Firefox and Edge

### Video Tutorial

_(Outdated, the updated version will be added this week.)_

[![Tutorial](https://img.youtube.com/vi/FCk6MoSjt5w/0.jpg)](https://www.youtube.com/watch?v=FCk6MoSjt5w)

[![Total alerts](https://img.shields.io/lgtm/alerts/g/LeagueOfPoro/EsportsCapsuleFarmer.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/LeagueOfPoro/EsportsCapsuleFarmer/alerts/)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/LeagueOfPoro/EsportsCapsuleFarmer.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/LeagueOfPoro/EsportsCapsuleFarmer/context:python)

## Installation (simple)

**⚠️ This project utilizes the [Google Chrome browser](https://www.google.com/chrome/). Please ensure you have it installed before attempting to run the project.**
**⚠️ This project utilizes the [Google Chrome browser](https://www.google.com/chrome/) by default. However, there's an experimental support for Firefox and Edge (see [Configuration](#configuration) or [CLI](#cli) if you want to use alternative browsers). Please make sure you have the selected browser installed!**

1. Download and run the latest CapsuleFarmer.zip from [Releases tab](https://github.com/LeagueOfPoro/EsportsCapsuleFarmer/releases)
2. Extract the archive
3. (Optional) Edit the configuration file with a text editor (e.g. Notepad) - see [Configuration](#configuration) for details
4. Run `CapsuleFarmer.exe`
5. If you do not use the autologin feature - log into your account

_Note: I am using Google Chrome + automatic login + headless. This will be the most stable and preferred configuration._

## Configuration
**⚠️ The configuration file ([config.yaml](config.yaml)) MUST be present in the SAME folder as the executable!**

**⚠️ The configuration file ([config.yaml](config.yaml)) MUST be present in the SAME folder as the executable! To use non-default path, see [CLI](#cli).**

**⚠️ Automatic login will not work with 2FA enabled.**

Default configuration:
```yaml
version: 1.1

headless: false
autologin:
enable: false
```

If you wish to enable automatic login and to run the browser in the background:
```yaml
version: 1.1

headless: true
autologin:
enable: true
username: YourUsername
password: YourPassword
```

Experimental support for alternative browsers (default: _chrome_):
```yaml
browser: firefox # Other options: chrome, edge
```

Set delay in seconds between checks for new matches (default: _600_):
```yaml
delay: 600
```

## Multiple accounts

The program supports multiple accounts by default. However, if you want to use the automatic login + headless mode, the best method to start the program is to use the included [batch script](combine.bat).

**⚠️ Run the CapsuleFarmer.exe at least once before you attempt to use multiple accounts. Otherwise every instance will try to download the WebDriver and bad things WILL happen.**

1. Create configuration file for each account
2. Open the example [combine.bat](combine.bat) in a text editor
3. For each account, add path to the account's config file, e.g. `START CapsuleFarmer.exe -c config.account1.yaml`
4. Run the _.bat_ script

## Common Errors/Issues

- *The Riot Account login page is not loading*
Expand All @@ -72,6 +98,22 @@ autologin:
- *It doesn't work*
- [Have you tried turning it off and on again?](https://www.youtube.com/watch?v=p85xwZ_OLX0)

## CLI
```bash
usage: CapsuleFarmer.exe [-h] [-b {chrome,firefox,edge}] [-c CONFIGPATH] [-d DELAY]

Farm Esports Capsules by watching lolesports.com.

options:
-h, --help show this help message and exit
-b {chrome,firefox,edge}, --browser {chrome,firefox,edge}
Select one of the supported browsers
-c CONFIGPATH, --config CONFIGPATH
Path to a custom config file
-d DELAY, --delay DELAY
Time spent sleeping between match checking (in seconds)
```

## Installation (advanced)

### Prerequisities
Expand Down

0 comments on commit 2c314f7

Please sign in to comment.