An open API service indexing awesome lists of open source software.

https://github.com/thieleju/chess-com-insights

♟️ Browser Extension - Shows Win/Lose/Draw and average accuracy stats for games on chess.com
https://github.com/thieleju/chess-com-insights

chess chess-com chrome-extension crxjs typescript vite vue3 vuetify3

Last synced: 4 months ago
JSON representation

♟️ Browser Extension - Shows Win/Lose/Draw and average accuracy stats for games on chess.com

Awesome Lists containing this project

README

          

# chess-com-insights

[![Release](https://github.com/thieleju/chess-com-insights/actions/workflows/release.yml/badge.svg)](https://github.com/thieleju/chess-com-insights/actions/workflows/release.yml)
[![Tests](https://github.com/thieleju/chess-com-insights/actions/workflows/mocha.yml/badge.svg)](https://github.com/thieleju/chess-com-insights/actions/workflows/mocha.yml)
![Chrome Web Store](https://img.shields.io/chrome-web-store/users/mobpnhbkmljienoleojnhbfhkhodpffe?label=Active%20Users)
![Chrome Web Store](https://img.shields.io/chrome-web-store/stars/mobpnhbkmljienoleojnhbfhkhodpffe?label=Rating)

> [!WARNING]
> This addon is still in development and bugs might occur. If that happens, try to reload the site.

## 🚀 How it works

This extension shows statistics for chess.com games.
Use the extensions icon in your browser in the top right corner to adjust the settings.

- First three numbers are the wins/loses/draws of the player
- Percentage in brackets is the average accuracy of the player
- Accuracy is only available on reviewed games
- Hover over the stats to see information how many games the average is based on

### Preview

![preview](images/preview.png)
![preview](images/preview2.png)
![preview](images/preview3.png)

### Options

![options](images/options-small2.png)

## ⚙️ Installation

Add the extension to your browser:
[Chrome Web Store](https://chrome.google.com/webstore/detail/chesscom-insights/mobpnhbkmljienoleojnhbfhkhodpffe)

Manual installation:

- Download the latest release zip from [here](https://github.com/thieleju/chess-com-insights/releases)
- Go to your browser and type `chrome://extensions/` in the search bar
- Enable developer mode in the corner
- Drag and drop the zip file into the browser window

## 🪲 Bugs

- Hiding your own stats only hides the bottom stats, currently not depending on the username
- Sometimes the stats flash up when visiting a chess.com game link
- Chess data is fetched for the current month. At the start of a month, the stats don't show accurate game data

If you find any other bugs, please open an issue [here](https://github.com/thieleju/chess-com-insights/issues)

## 💻 Run locally

Prequisites:

- Node.js version 17 or higher
- pnpm installed globally `npm install -g pnpm`

Instructions:

- Clone/fork/download the project
- run `pnpm install` to install all dependencies
- run `pnpm run build` to build the extension
- Files will be exported to the `dist` directory
- You can also run `pnpm run dev` to start the vite dev server to view the options page, but some things f.e. reading the settings will not work
- do the manual installation steps above and select the `dist` directory

## 💯 Code Coverage Report

[Code Coverage Report](https://thieleju.github.io/chess-com-insights/) served with github pages

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
This extension is an independent project and is not affiliated with, endorsed by, or associated with Chess.com in any way.