Chess.com Stats for GitHub README

Display your Chess.com statistics on your GitHub profile with automatically updated SVG graphics.

Features

• Free - Uses only free GitHub resources
• Automatic Updates - GitHub Actions updates every 6 hours
• No Server Required - Static SVG files, no hosting needed
• 8 Themes - All themes generated automatically, just choose the URL
• Line Charts - Rating evolution for Rapid, Blitz, Bullet, and Daily

Quick Start

1. Fork this Repository

Click the Fork button at the top of this page.

2. Configure Your Username

Go to Settings > Secrets and variables > Actions > Variables

Create a variable:

• Name: CHESS_USERNAME
• Value: Your Chess.com username

3. Run the Workflow

1. Go to Actions tab
2. Click Update Chess.com Stats
3. Click Run workflow

4. Add to Your Profile README

Copy one of the URLs below and paste in your README:

Themes

All 8 themes are generated automatically. Choose your favorite:

Dark (Default)

![Chess Stats](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats.svg)

Light

![Chess Stats](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-light.svg)

Midnight

![Chess Stats](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-midnight.svg)

Chess Classic

![Chess Stats](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-chess.svg)

Wood

![Chess Stats](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-wood.svg)

Neon

![Chess Stats](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-neon.svg)

Matrix

![Chess Stats](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-matrix.svg)

Ocean

![Chess Stats](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-ocean.svg)

Line Charts

Rating history charts are also available for each game mode and theme.

URL Pattern

chess-stats-{mode}.svg           # Dark theme (default)
chess-stats-{mode}-{theme}.svg   # Other themes

Where {mode} is: rapid, blitz, bullet, or daily

Examples

<!-- Rapid - Dark theme -->

![Rapid](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-rapid.svg)

<!-- Blitz - Neon theme -->

![Blitz](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-blitz-neon.svg)

<!-- Bullet - Matrix theme -->

![Bullet](https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-bullet-matrix.svg)

All Available Files

After running the workflow, these files are generated:

File	Description
chess-stats.svg	Main card (dark)
chess-stats-{theme}.svg	Main card (other themes)
chess-stats-rapid.svg	Rapid chart (dark)
chess-stats-rapid-{theme}.svg	Rapid chart (other themes)
chess-stats-blitz.svg	Blitz chart (dark)
chess-stats-blitz-{theme}.svg	Blitz chart (other themes)
chess-stats-bullet.svg	Bullet chart (dark)
chess-stats-bullet-{theme}.svg	Bullet chart (other themes)
chess-stats-daily.svg	Daily chart (dark)
chess-stats-daily-{theme}.svg	Daily chart (other themes)

Themes: light, midnight, chess, wood, neon, matrix, ocean

Advanced HTML Usage

GitHub READMEs support HTML, allowing you to customize the layout of your stats.

Centralize Graphics

<div align="center">
  <img src="https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats.svg" alt="Chess Stats" />
</div>

Two Graphics Side by Side

<div align="center">
  <img src="https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-rapid.svg" alt="Rapid" />
  <img src="https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-blitz.svg" alt="Blitz" />
</div>

Main Card + Line Chart (Stacked)

<div align="center">
  <img src="https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-neon.svg" alt="Chess Stats" />
  <br/>
  <img src="https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-rapid-neon.svg" alt="Rapid Rating" />
</div>

Mixed Themes Layout

<div align="center">
  <img src="https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-dark.svg" alt="Stats" />
  <br/><br/>
  <img src="https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-rapid-matrix.svg" alt="Rapid" />
  <img src="https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats-blitz-neon.svg" alt="Blitz" />
</div>

With Links (Click to Open Chess.com Profile)

<div align="center">
  <a href="https://www.chess.com/member/YOUR_CHESS_USERNAME">
    <img src="https://raw.githubusercontent.com/YOUR_USERNAME/chess_readme_status/main/assets/chess-stats.svg" alt="Chess Stats" />
  </a>
</div>

Pro Tip: Replace YOUR_USERNAME with your GitHub username and YOUR_CHESS_USERNAME with your Chess.com username.

Local Development

git clone https://github.com/your-username/chess_readme_status.git
cd chess_readme_status
npm install
CHESS_USERNAME=your_username npm run generate

Windows

$env:CHESS_USERNAME="your_username"
npm run generate

Update Frequency

Stats update automatically every 6 hours (4 times per day).

License

MIT License - See LICENSE for details.