snk

Generates a snake game from a github user contributions graph

Pull a github user's contribution graph. Make it a snake Game, generate a snake path where the cells get eaten in an orderly fashion.

Generate a gif or svg image.

Available as github action. Automatically generate a new image at the end of the day. Which makes for great github profile readme

Usage

github action

- uses: Platane/snk@v2.0.0-rc.1
  with:
    # github user name to read the contribution graph from (**required**)
    # using action context var `github.repository_owner` or specified user
    github_user_name: ${{ github.repository_owner }}

    # list of files to generate.
    # one file per line. Each output can be customized with options as query string.
    outputs: |
      dist/github-snake.svg
      dist/github-snake.svg?palette=github-dark
      dist/ocean.gif?color_snake=orange&color_dots=#bfd6f6,#8dbdff,#64a1f4,#4b91f1,#3c7dd9

example with cron job

If you are only interested in generating a svg, you can use this other faster action: uses: Platane/snk/svg-only@v2.0.0-rc.1

interactive demo

platane.github.io/snk

local

npm install

npm run dev:demo

Implementation

solver algorithm