Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: 先在网页版里搜一下
- name: 先在网页版里搜一下 / Search the web version first
url: https://syydaniel.github.io/awesome-code-animation/
about: 按画风筛选、搜索,看看项目是不是已经收录了。
about: 按画风筛选、搜索,看看项目是不是已经收录了。 / Filter by style and search to see if it is already listed.
86 changes: 47 additions & 39 deletions .github/ISSUE_TEMPLATE/recommend.yml
Original file line number Diff line number Diff line change
@@ -1,65 +1,73 @@
name: 推荐项目
description: 推荐一个用代码做动画、做 MV 的开源项目
title: "[推荐] "
name: 推荐项目 / Suggest a project
description: 推荐一个用代码做动画、做 MV 的开源项目 / Suggest an open-source project that makes animation or music videos with code
title: "[推荐 / Suggestion] "
labels: ["推荐项目"]
body:
- type: input
id: repo
attributes:
label: 仓库地址
label: 仓库地址 / Repository URL
placeholder: https://github.com/owner/name
validations:
required: true
- type: dropdown
id: styles
attributes:
label: 画风(可多选)
label: 画风(可多选)/ Styles (pick any)
multiple: true
options:
- 数学讲解风
- 扁平 MG 动效
- 代码演示风
- 动态文字 · 歌词
- 短视频 · 字幕 · 快剪
- 手绘 · 白板 · 水彩
- 生成艺术 · 几何
- 着色器 · 迷幻光影
- Live Coding · VJ
- 音乐可视化
- 3D 渲染
- 二次元 · MMD · VRM
- 粒子 · 流体 · 物理
- 故障 · 后期特效
- 像素 · 复古
- ASCII · 终端
- 数据可视化动画
- 水墨 · 山水(小众)
- 汉字 · 手写笔画(小众)
- 示波器 · 矢量光线(小众)
- 绘图仪 · 单线画(小众)
- 抖动 · 1-bit(小众)
- Riso · 剪纸拼贴(小众)
- 人工生命 · 元胞自动机(小众)
- 程序化生成 · 波函数坍缩(小众)
- 分形 · 数学艺术(小众)
- 等距 · 体素(小众)
- 科幻 HUD · 赛博界面(小众)
- 地图 · 路线动画(小众)
- Demoscene 演示场景(小众)
- 其他(请在说明里写)
- 数学讲解风 / Math Explainer
- 扁平 MG 动效 / Motion Graphics
- 代码演示风 / Code & Terminal Demo
- 动态文字 · 歌词 / Kinetic Type & Lyrics
- 短视频 · 字幕 · 快剪 / Shorts, Captions & Editing
- 手绘 · 白板 · 水彩 / Hand-drawn & Whiteboard
- 生成艺术 · 几何 / Generative Art
- 着色器 · 迷幻光影 / Shaders & Psychedelic
- Live Coding · VJ / Live Coding & VJ
- 音乐可视化 / Music Visualization
- 3D 渲染 / 3D
- 二次元 · MMD · VRM / Anime, MMD & VRM
- 粒子 · 流体 · 物理 / Particles & Physics
- 故障 · 后期特效 / Glitch & Post FX
- 像素 · 复古 / Pixel & Retro
- ASCII · 终端 / ASCII & Terminal
- 数据可视化动画 / Data Animation
- 水墨 · 水彩 / Ink & Watercolor(小众 niche)
- 汉字 · 手写笔画 / Handwriting & Strokes(小众 niche)
- 示波器 · 矢量光线 / Oscilloscope & Vector(小众 niche)
- 绘图仪 · 单线画 / Plotter & Line Art(小众 niche)
- 抖动 · 1-bit / Dither & 1-bit(小众 niche)
- Riso · 剪纸拼贴 / Riso & Paper Collage(小众 niche)
- 人工生命 · 生长形态 / Artificial Life & Growth(小众 niche)
- 程序化生成 · 波函数坍缩 / Procedural Generation(小众 niche)
- 分形 · 混沌 · 数学艺术 / Fractals & Chaos(小众 niche)
- 等距 · 体素 / Isometric & Voxel(小众 niche)
- 科幻 HUD · 赛博界面 / Sci-fi HUD(小众 niche)
- 地图 · 路线动画 / Map & Route(小众 niche)
- Demoscene 演示场景 / Demoscene(小众 niche)
- 落沙 · 像素物理 / Falling Sand(小众 niche)
- 流场 · 风场 / Flow & Wind Fields(小众 niche)
- VHS · 模拟信号 / VHS & Analog(小众 niche)
- 折纸 · 纸艺 / Origami & Papercraft(小众 niche)
- 几何重构 · 低多边形 / Geometric & Low-poly(小众 niche)
- 写实光追 / Path Tracing(小众 niche)
- 星空 · 宇宙 / Space & Stars(小众 niche)
- 液态玻璃 · 玻璃拟态 / Liquid Glass(小众 niche)
- 其他(请在说明里写)/ Other (describe below)
validations:
required: true
- type: textarea
id: why
attributes:
label: 一句话说明
description: 它能做出什么样的画面?有作品链接更好。和已收录的哪个项目有关系(基于、插件、同类)也可以写上。
label: 一句话说明 / One-line description
description: 它能做出什么样的画面?有作品链接更好。和已收录的哪个项目有关系(基于、插件、同类)也可以写上。 / What does it make? Links to work help, and so does any relation to listed projects.
validations:
required: true
- type: checkboxes
id: rules
attributes:
label: 收录标准
label: 收录标准 / Rules
options:
- label: 画面由代码绘制或渲染,不依赖视频或图像生成模型,也不靠 Blender 等 3D 软件出画面
required: true
Expand Down
85 changes: 85 additions & 0 deletions CONTRIBUTING.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Contributing

[Chinese version](CONTRIBUTING.md)

Thanks for suggesting a project! This list exists to help people find the right code animation tool by **visual style**, so two things matter most: the picture is really drawn by code, and the project is still worth using.

## What gets listed

1. **Frames are drawn or rendered by code.** Projects that make their pictures with video or image generation models aren't listed, and neither are ones that render through Blender or other 3D apps. Skills and films where AI coding agents like Claude or Opus write the code are welcome. They're filed by style as usual, with an extra `"agent": true`.
2. **Main styles:** 1,000+ GitHub stars, or 200+ stars with a push in the last year.
3. **Niche styles:** 20+ stars with a push in the last year. Small and interesting projects are welcome.
4. **Projects marked `"agent": true`:** 50+ stars with a push in the last year.
5. **The repository isn't archived.**

The exact checks are in [`scripts/rules.py`](scripts/rules.py) and run every week when the data refreshes.

## The easy way: open an issue

Under [Issues](../../issues/new/choose), pick "Suggest a project" and give the repository URL and style. The maintainer fills in the rest.

Every Monday an automatic "weekly candidates" issue lists projects that were found but aren't listed yet. Help judging them is welcome.

## Open a pull request

1. Add an entry to [`data/projects.json`](data/projects.json):

```json
{
"repo": "owner/name",
"name": "Display name",
"tags": ["mg", "type"],
"lang": "TypeScript",
"use": "Music videos · Short videos",
"use_en": "MV · Shorts",
"desc": "(optional Chinese description)",
"desc_en": "One sentence on what kind of picture it makes.",
"note_en": "(Optional) Anything to warn about, like license limits or an optional generation feature.",
"license": null,
"stars": 0,
"pushed_at": "2026-01-01",
"archived": false
}
```

`tags` are the `key` values in [`data/styles.json`](data/styles.json). You can list several, with the main style first. Styles with `"zone": "niche"` are niche styles. `stars`, `pushed_at`, `archived` and `license` can be anything, because the next step refreshes them.

The site and README exist in Chinese and English. `name`, `desc`, `use`, `note` and `lang` each have an optional `*_en` field. `desc` and `use` are required by the build, so if you don't write Chinese, put the English text in both and the maintainer will translate it.

2. If it relates to a listed project (built on it, a plugin for it, similar to it), add an entry to [`data/relations.json`](data/relations.json):

```json
{"from": "owner/name", "type": "plugin", "to": "mrdoob/three.js", "note": "(Chinese note)", "note_en": "One short clause."}
```

`type` is one of: `fork`, `built_on`, `plugin`, `official`, `uses`, `data`, `alt`, `pair`, `author`.

3. Refresh the data and rebuild the READMEs and web page:

```bash
python scripts/update_stats.py # optional: needs network, export GITHUB_TOKEN=... first
python scripts/build.py
```

4. Commit your changes under `data/`, plus `README.md`, `README.en.md` and `docs/index.html`.

Please don't edit `README.md`, `README.en.md` or `docs/index.html` by hand. They're generated, and the next build overwrites them.

Projects we looked at and decided against go in [`data/excluded.json`](data/excluded.json) with a reason, so automatic discovery stops suggesting them.

## Adding a style

Add an entry to `data/styles.json` (with `"zone": "niche"` for a niche style), and write a thumbnail function for it in the `SW` object in [`site/template.html`](site/template.html), using a 240×96 canvas. Then run:

```bash
pip install playwright && playwright install chromium
python scripts/build.py
python scripts/render_swatches.py # regenerates the thumbnails, banners and graph images in assets/
python scripts/build.py
```

## Tips for descriptions

- Say **what kind of picture it makes**, not just the technology.
- One or two sentences is enough.
- If it has license limits (paid commercial use, AGPL, non-commercial), only works on one system, or has an optional generation feature, put that in `note_en`.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 参与贡献

[English](CONTRIBUTING.en.md)

谢谢你愿意推荐项目!这份合集的目标是帮人按**画风**找到合适的代码动画工具,所以收录时最看重两点:画面确实是代码画出来的,以及项目还值得用。

## 收录标准
Expand Down Expand Up @@ -30,6 +32,7 @@
"lang": "TypeScript",
"use": "MV · 短视频",
"desc": "一句话说明它能做出什么样的画面。",
"desc_en": "(可选)英文说明,网页英文版和 README.en.md 用它,没写时先用 GitHub 简介。",
"note": "(可选)需要提醒的事,比如许可证限制、可选的生成功能。",
"license": null,
"stars": 0,
Expand All @@ -40,6 +43,8 @@

`tags` 用 [`data/styles.json`](data/styles.json) 里的 `key`,可以写多个,第一个放最主要的画风。带 `"zone": "niche"` 的是小众画风区。`stars`、`pushed_at`、`archived`、`license` 随便填,下一步会自动刷新。

网站和 README 都有中英两版。`name`、`desc`、`use`、`note`、`lang` 都可以加对应的 `*_en` 字段写英文;`relations.json` 的 `note` 同样可以加 `note_en`。不会写英文也没关系,维护者会补上。

2. 如果它和已收录的项目有关系(基于谁、是谁的插件、和谁同类),在 [`data/relations.json`](data/relations.json) 里加一条:

```json
Expand Down
Loading
Loading