Platane/snk

これは何？

主な機能

• 01ユーザーのコントリビューショングラフのマスを順番に食べるスネークの経路を生成します。
• 02アニメーションSVGまたはGIFを出力します。
• 03GitHub Actionとして動作し、スケジュールに従って画像を再生成できます。
• 04色のプリセットと、スネークおよびドットの色のカスタマイズに対応しています。
• 05GitLabおよびForgejoアカウントでも使えるnpmパッケージを提供します。

ユースケース

• GitHubプロフィールのREADMEに、アニメーションするコントリビューショングラフを追加する。
• テーマに合わせてREADMEに埋め込めるよう、スネークアニメーションのライト版とダーク版を生成する。
• npmパッケージを使って、CodebergまたはGitLabのコントリビューショングラフからスネークアニメーションを作成する。

クイックスタート

1. 1

   READMEに記載されているuses行を使って、GitHub Actionsをワークフローファイルに追加します

2. 2

   または、npxでnpmパッケージを試します

   npx generate-snake-animation@3 --forgejo_user codeberg.org/JasterV --output snake.svg?palette=codeberg

使う前に知っておきたいこと

• !このプロジェクトはプルリクエストを受け付けていないため、変更についてはまずissueで相談してください。
• !リポジトリにライセンスが明記されていないため、利用権が不明確です。

トピック

よくある質問

snk とは？

GitHubユーザーのコントリビューショングラフをアニメーションするスネークゲームに変換し、プロフィールREADME向けにSVGまたはGIFで出力します。 snkはGitHubユーザーのコントリビューショングラフをスネークゲームに変換します。コントリビューションのマスを順番に食べる経路を計算し、アニメーションSVGまたはGIFとしてレンダリングします。

snk は無料で使えますか？ライセンスは？

snk にはライセンスが明記されていません。コードは公開されていますが、ライセンスがない場合は再利用の許諾がないため、利用前に作者に確認することをおすすめします。

snk は今もメンテナンスされていますか？

活発にメンテナンス中。snk の最終コミットは 2026年10月18日 です。

snk は何に使えますか？

GitHubプロフィールのREADMEに、アニメーションするコントリビューショングラフを追加する。 テーマに合わせてREADMEに埋め込めるよう、スネークアニメーションのライト版とダーク版を生成する。 npmパッケージを使って、CodebergまたはGitLabのコントリビューショングラフからスネークアニメーションを作成する。

snk のインストール方法は？

READMEに記載されているuses行を使って、GitHub Actionsをワークフローファイルに追加します または、npxでnpmパッケージを試します: npx generate-snake-animation@3 --forgejo_user codeberg.org/JasterV --output snake.svg?palette=codeberg

snk はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/Platane/snk