分享到微信

当前解读页的微信分享二维码

用微信扫一扫打开,点击右上角「···」分享给朋友或朋友圈。

手机上可截屏后,在微信扫一扫中从相册识别二维码。

yalongwastaken/git-koi

多媒体与设计

把 GitHub 账号的公开活动画成像素锦鲤 GIF,可用于个人主页 README,也能命令行或作为 Rust 库调用。

213
11
Rust
MIT
创建于 6 天前

项目用途

Git koi 读取 GitHub 账号的公开活动,生成像素风格的锦鲤。使用的编程语言决定鱼的颜色,贡献量决定鱼的成长,连续贡献记录形成标记,刚过去一天的活跃情况决定它的游动方式。每次运行输出一段循环 GIF,可直接放进个人主页 README。

同一套生成逻辑有三种用法:面向个人主页仓库的 GitHub Action、git-koi 命令行工具,以及发布在 crates.io 上的 Rust 库。README 中展示了六种体色(白、黑、浅葱、茶、金、铂金)在各自成长阶段的样子。

生成锦鲤

入门指南分别说明这三种用法。

用 Action 放到主页 README: 在个人主页仓库添加工作流,调用仓库内置的 Action,使用自带的 GITHUB_TOKEN,再在 README 中引用生成的 GIF。作者的示例工作流和实际效果可参考 profile 工作流示例 与 生成结果。

命令行: 从 Releases 页面下载二进制,或用等于或高于 Cargo.toml 中 rust-version 的 Rust 从源码构建。命令行依赖已认证的 GitHub CLI 读取账号活动;在本地执行同一命令即可在 GitHub Actions 之外生成 GIF。

作为库: 引入 crate 并调用其 API,接口文档见 docs.rs。

使用约束

  • 通过 Action 渲染主页 README 时,需要个人主页仓库的工作流能使用其内置 token,该 Action 依赖这一环境。
  • 从源码构建需要不低于 Cargo.toml 所标版本的 Rust;命令行还要求 GitHub CLI 已完成认证。
  • 输出为 GIF,是 2D 像素动画,不是静态图片或可交互组件。
  • 项目采用 MIT 许可证。

HotRepo 点评

2026-11-01,该项目出现在 Rust 新项目榜上:从 01:45 UTC 起约 8 小时的统计窗口内新增 111 Star,到 09:45 UTC 达到 213 Star;逐小时采样显示当天上午是持续上升,而不是一次性的尖峰。站内没有记录到全语言日榜名次,也没有提供讨论帖。项目契合当前对生成式主页装饰的兴趣,而同一渲染器同时以命令行和 crate 发布,让人可以先试用,不必一开始就接入 Action。

本文由 AI 根据项目 README 生成,更新于 ,以项目官方文档为准。