Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/AlexPetrusca/Mephisto
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexPetrusca committed Aug 7, 2022
2 parents d1e1752 + f89b96f commit f4dcc1e
Showing 1 changed file with 10 additions and 26 deletions.
36 changes: 10 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,19 @@
![alt text](https://raw.githubusercontent.com/AlexPetrusca/Mephisto/master/res/mephisto_banner_lowercase.png)

Mephisto is a browser extension that enables next best move calculation and automated gameplay on Chess.com and Lichess.
Mephisto is a browser extension that enables next best move analysis and automated gameplay on Chess.com and Lichess.


## Getting Started
Click Mephisto's icon to open its popup window and automatically scrape the current page for a chess position to
analyze.

### Pinning Mephisto
For ease of use, pin Mephisto in chrome's extensions menu. Click the puzzle icon to the right of Chrome's address bar.
analyze. For ease of use, pin Mephisto in chrome's extensions menu. Click the puzzle icon to the right of Chrome's address bar.
Find "Mephisto Chess Extension" and click the pin icon to the right of it.

### Keeping Mephisto Open
You may notice that when you click outside of Mephisto's popup window, the popup will lose focus and close. To prevent
this, right-click the pinned icon and click 'Inspect Popup'.
this, right-click the pinned icon and click 'Inspect Popup'.

For more information, see [Getting Started](https://github.com/AlexPetrusca/Mephisto/wiki/Getting-Started).


## How to Contribute
Thank you for your interest in contributing to Mephisto! There are many ways to contribute, and we appreciate all of them.

### Ways to Contribute
- Help contribute ideas to Mephisto
- Help identify and document bugs with Mephisto
- Implement requested features through PRs
- Fix identified bugs through PRs


## How to Develop Locally
Set up a local install:
1. Clone the repo
Expand All @@ -45,13 +31,11 @@ Test a code change:
For technical details, see [Technical Overview](https://github.com/AlexPetrusca/Mephisto/wiki/Technical-Overview).


## How to Run Python Autoplay Backend
Install dependencies:
```bash
pip3 install flask pyautogui
```
## How to Contribute
Thank you for your interest in contributing to Mephisto! There are many ways to contribute, and we appreciate all of them.

Run script:
```bash
python3 mephisto-clicker.py
```
Ways to Contribute:
- Help contribute ideas to Mephisto
- Help identify and document bugs with Mephisto
- Implement requested features through PRs
- Fix identified bugs through PRs

0 comments on commit f4dcc1e

Please sign in to comment.