README Arcade

Turn your GitHub login into animated contribution-grid arcade art.

Русская версия

Gallery

Lifegrid

Conway's Game of Life starts from your GitHub login.

Snake

A snake and a fast worm appear from your login and eat GitHub-colored cells.

Matrix

Code rain drops over your login.

Defrag

A Windows 98-style disk map compacts fragmented cells.

Quick Start

1. Fork this repository.

2. Open readme-arcade.config.json and change three fields:

{
  "user": "YOUR_LOGIN",
  "mode": "snake",
  "speed": "normal"
}

user is your GitHub login. mode is lifegrid, snake, matrix, or defrag. speed is slow, normal, fast, or turbo.

3. Commit the file. GitHub Actions will render SVG files into dist/.

If Actions are disabled in your fork, open the Actions tab, enable workflows, then run render README Arcade once.

4. Paste this into your profile README.

Your profile README is the README.md file inside the special repository named YOUR_LOGIN/YOUR_LOGIN.

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/YOUR_LOGIN/README-Arcade/main/dist/readme-arcade-dark.svg">
    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/YOUR_LOGIN/README-Arcade/main/dist/readme-arcade.svg">
    <img src="https://raw.githubusercontent.com/YOUR_LOGIN/README-Arcade/main/dist/readme-arcade.svg" width="920" alt="README Arcade">
  </picture>
</p>

Replace YOUR_LOGIN in the snippet. If your fork has another repository name, replace README-Arcade too. The <picture> block lets GitHub choose the dark or light SVG automatically.

Local Preview

You do not need local setup if you use GitHub Actions. Local render is optional:

python scripts/render.py
python scripts/render_gallery.py

Open preview/index.html to view all modes.

Donate

If README Arcade helped your profile, tips are welcome:

TON: pointoncurve.ton
BTC: 1ECDSA1b4d5TcZHtqNpcxmY8pBH1GgHntN
USDT (TRC20): TSWcFVfqCp4WCXrUkkzdCkcLnhtFLNN3Ba

License

MIT