Platane/snk

这是什么？

核心功能

• 01生成一条按顺序吃掉贡献图每个格子的蛇形路径。
• 02输出动画 SVG 或 GIF 文件。
• 03以 GitHub Action 形式运行，可定时重新生成图片。
• 04支持预设配色，也支持自定义蛇和格子的颜色。
• 05提供 npm 包，同时支持 GitLab 和 Forgejo 账号。

适用场景

• 在 GitHub 个人主页 README 中加入动态贡献图。
• 生成浅色和深色两个版本，适配不同主题。
• 借助 npm 包，把 Codeberg 或 GitLab 的贡献图做成贪吃蛇动画。

快速上手

1. 1

   在工作流文件中使用 README 里的 uses 配置添加 GitHub Action

2. 2

   或者用 npx 试用 npm 包

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

使用前须知

• !该项目不接受拉取请求，如需修改应先在 issue 中讨论。
• !该仓库未声明许可证，使用权限不明确。

标签

常见问题

snk 是什么？

把 GitHub 用户的贡献图变成贪吃蛇动画，输出 SVG 或 GIF，适合放在个人主页 README 中。 snk 读取 GitHub 用户的贡献图，把它变成一局贪吃蛇游戏。程序会规划一条路径，按顺序吃掉每个贡献格子，并将结果渲染为动画 SVG 或 GIF。

snk 可以免费使用吗？用的什么许可证？

snk 没有声明许可证。代码虽然公开，但没有许可证就没有明确的使用授权，正式使用前建议先联系作者。

snk 还在维护吗？

活跃维护中。snk 最近一次提交是在 2026年10月18日。

snk 适合用来做什么？

在 GitHub 个人主页 README 中加入动态贡献图。 生成浅色和深色两个版本，适配不同主题。 借助 npm 包，把 Codeberg 或 GitLab 的贡献图做成贪吃蛇动画。

snk 怎么安装和运行？

在工作流文件中使用 README 里的 uses 配置添加 GitHub Action 或者用 npx 试用 npm 包: npx generate-snake-animation@3 --forgejo_user codeberg.org/JasterV --output snake.svg?palette=codeberg

在哪里获取 snk？

源代码和安装说明在 GitHub 上：https://github.com/Platane/snk