Skip to content

Commit

Permalink
Update README in accordance to v1.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
MytkoEnko committed Oct 17, 2020
1 parent 5998b03 commit 056cba5
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,38 @@
![YouTube Video Likes](https://img.shields.io/youtube/likes/1aa6YVsSKeM?style=social)

![helPES logo](src/logo.png "Anna Berkowska's helPES logo")
[![Donate](https://img.shields.io/badge/Download-helPES-green?style=for-the-badge&logo=windows)](https://github.com/MytkoEnko/helPES/releases/download/v1.0.0/helPES-v1.0.0.zip)
[![Donate](https://img.shields.io/badge/Download-helPES-green?style=for-the-badge&logo=windows)](https://github.com/MytkoEnko/helPES/releases/download/v1.1.0/helPES-v1.1.0.zip)
[![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/donate/?token=ED2KScvCaoOMELItg0T_ulvcYIlL0F5O5fRLDfhN6GCx-6yKAKmNYndxQj5ZhoCasL_PSG&country.x=PL&locale.x=PL)
[![Donate](https://img.shields.io/badge/Donate-patreon-red)](https://www.patreon.com/helPES)
-----
### Features:
- Sign your scouts (with possibility to skip first n)
- Sign your scouts (with possibility to skip first 6+ scouts, 0 - for no skipping)
- Convert your players to EXP trainers (converts all players of **cost** below selected, eg 10, 15, 20..).
- Playing SIM games with the same squads (alternately plays first two squads from list, prolongues contracts when expired)
- Playing SIM games with the same squads (alternately plays first two squads from list, extends contracts when expired)
- Playing SIM games wasting squads:
- Alternately plays first two squads from list
- When contracts expire - signs earned scouts, converts both squads (except bench players) to EXP trainers, selects new players of "max cost"
- Cycle continues specified number of games or until scout or EXP trainers slots available
- **This mode is extremely profitable, as you save GP and gain EXP trainers, yet you need to have higher number of players/scouts to waste, as each cycle of 20 games you'll lose 22 players but gain only 20 new scouts**

**Added in 1.1.0:**
- PES2021 support
- Standalone, just extract zip archive and run helPES.exe

##### Additional features:
- If program fails - send email with a screenshot and last 30 log entries
- Auto shutdown computer when program fails/completes
- Possibility to run on Azure Virtual Machine with shutting down VM when completes
#### Limitations:
- As for now only supports PES2020
- ~~As for now only supports PES2020~~ (fixed in v1.1.0)
- Only supports PC version of game
- Program resizes game window to 1280x720 and manipulates it emulating controller, you can't use your computer in meanwhile
- Program detects game by window name (eg. "eFootball PES 2020"), if you have folder with same name opened it can mull
- Entire game window must be visible on your PC screen, program itself doesn't need to
- As for now **only** supports usage of **managers with 4-3-3 tactics**
- As for now to use email sending you'll need your own sendgrid token (see wiki instructions or youtube video)
- For using on Azure VM you'll need to set it up and provide the program with all the necessary credentials
- When choosing "scouts to skip" can only choose 0 or 6+
- You need to start "Playing loop" or "Actions" only from:
- desktop before PES even started
- myClub **Club House/Squad Management:**
Expand All @@ -44,25 +50,24 @@
##### Known issues:
- helPES won't start if Steam is not installed
- On first run it can detect PES executable but may fail to run it, should work after helPES restart.
-
-----

![helPES logo](./img/screenshot.JPG "helPES screenshot")
### Requirements:
To successfully use helPES you will need:
- Windows 10 (PC or Azure VM with graphic card)
- tesseract ocr installed (it is used for visual recognition of text on your game screen - v [3.05.1](https://digi.bib.uni-mannheim.de/tesseract/tesseract-ocr-setup-3.05.01.exe) from [this source](https://digi.bib.uni-mannheim.de/tesseract/) was used. instalation path should be added to PATH so `tesseract` should be callable from terminal)
- ~~tesseract ocr installed (it is used for visual recognition of text on your game screen - v [3.05.1](https://digi.bib.uni-mannheim.de/tesseract/tesseract-ocr-setup-3.05.01.exe) from [this source](https://digi.bib.uni-mannheim.de/tesseract/) was used. instalation path should be added to PATH so `tesseract` should be callable from terminal)~~ Starting from v1.2.0 it is now standalone program with no dependencies.

### Installation
1. Install tesseract-ocr
2. Add tesseract-ocr executable to system PATH (see wiki for detailed steps)
1. ~~Install tesseract-ocr~~ (fixed in v1.1.0)
2. ~~Add tesseract-ocr executable to system PATH (see wiki for detailed steps)~~ (fixed in v1.1.0)
3. Download and extract the archive with the latest program version to a folder, enter it and run helPES.exe
4. Windows can warn you of untrusted software producer, it is because the program is generated from code above and does not have software producer's signature
### Usage:
1. Open helPES.exe make sure everything is "green" in **Checks section**:
- **Settings are ready** - each time you run the program your PES settings file will be backed up and replaced by the one provided by this program. **When you done with the usage of program - press "Revert" button to revert to your original settings file**
- **Game path** - it should automatically detect your PES2020.exe file, if it doesn't - please select manually using the button.
- **Tesseract version** - it will check if tesseract executable is in PATH and print it's version. If it's not - please fix it first.
- **Game path** - it should automatically detect your PES2020/1.exe file, if it doesn't - please report an issue.
- **Tesseract version** - it will show included tesseract version.
2. Configure **Settings**
- **Send email** - if you select this and provide your email and sendgrid token - each time script completes it will send you an email with statistics, also when it fails - will take screenshot of game window, attach last 30 lines of detailed logs and send it to you. Use the **Test email** button to send yourself a test mail and make sure everything is working fine.
- **Run on azure vm** - this only affects the way the machine is turned off after the program is failed/completed. If selected and all necessary information provided - instead of shutting down **deallcoate** call will be sent to Azure instance, so it will be correctly stopped and won't spend your funds.
Expand Down

0 comments on commit 056cba5

Please sign in to comment.