A dynamic SVG animation that displays your GitHub contribution graph as a snake game! This project automatically generates and updates the snake animation based on your GitHub activity.


This project uses Platane/snk to generate a snake animation that "eats" your GitHub contributions. It runs automatically at midnight via GitHub Actions and only updates when you've made new contributions.
- Automatic Updates: The snake animation updates daily at midnight (if you made contributions)
- Multiple Themes: Includes both light and dark mode versions
- Customizable: You can change the snake color and other visual elements
- Contribution-Aware: Only generates new animations when you've been active on GitHub
-
Fork this repository
-
Enable GitHub Actions in your repository settings
-
Customize the workflow file at
.github/workflows/snake.yml
if needed -
First run workflow manually at
.github/workflows/snake.yml
(Otherwise it will start at midnight automatically.) -
Add the snake animation to your profile:
Replace
{your-username}
and{forked-repository-name}
with your GitHub username and the name of your repository.
You can customize the snake animation by modifying the workflow file:
- Change snake color: Edit
color_snake=blue
to your preferred color - Change theme: Edit
palette=github-dark
to another theme - Adjust check frequency: Modify the cron schedule in the workflow file
- GitHub Actions runs the workflow on a schedule (midnight daily)
- The workflow checks if you've made any contributions
- If contributions are found, it generates new snake animations
- The updated SVG files are committed back to your repository
- Display the SVG in your README or GitHub profile
Copyright (c) 2025 Saviru Kashmira Atapattu
This project uses components from Platane/snk which is licensed under the MIT License.
- Platane/snk for the snake animation generator
- GitHub Actions for automation
Check the commit history for recent animation updates!
Made with ❤️ for the GitHub community