From ab5ebfbae1cb59c56cbe1827a5b774555e0a8630 Mon Sep 17 00:00:00 2001 From: Brandon Thomas Date: Wed, 7 Oct 2026 21:16:47 -0400 Subject: [PATCH] About: contributor and model credits compiled in (grab bag + table, self-submitted names) (#228) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * About: contributors compiled in from contributors.json (grab bag + table, sortable, name toggle) About EffectCraft now has tabs About · Contributors · Models, following the craftrules standard (standards/contributors.md): contributors/contributors.json is generated by craftrules/scripts/contributors.py and baked into the binary by crates/ui-egui/build.rs as static tables. Each contributor line: @username, opt-in display/real name, PRs, commits, lines +/−/Δ, binary assets +/−, first/last commit. Sortable by every column; alphabetical ignores case and the leading @. Every control registers an automation id (about.tab.*, about.credits.*). Co-Authored-By: Claude Opus 5.5 * Contributors: self-submitted names in contributors/people.toml; AGENTS.md credit-yourself section build.rs reads contributors/people.toml next to the generated contributors.json and shows a name only for entries the generator verified as written by that person (craftrules standards/contributors.md). Co-Authored-By: Claude Opus 5.5 * Contributors: regenerate (verified people.toml entries) Co-Authored-By: Claude Opus 5.5 --------- Co-authored-by: Claude Opus 5.5 --- AGENTS.md | 20 ++ Cargo.lock | 1 + contributors/contributors.json | 179 +++++++++++ contributors/people.toml | 23 ++ crates/ui-egui/Cargo.toml | 4 + crates/ui-egui/build.rs | 102 +++++++ crates/ui-egui/src/credits.rs | 435 +++++++++++++++++++++++++++ crates/ui-egui/src/lib.rs | 1 + crates/ui-egui/src/panels/dialogs.rs | 146 +++++---- docs/contributors.md | 55 ++++ 10 files changed, 912 insertions(+), 54 deletions(-) create mode 100644 contributors/contributors.json create mode 100644 contributors/people.toml create mode 100644 crates/ui-egui/build.rs create mode 100644 crates/ui-egui/src/credits.rs create mode 100644 docs/contributors.md diff --git a/AGENTS.md b/AGENTS.md index 62be3740..6ccc5686 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -111,6 +111,7 @@ Shared real-file test corpora (Photoshop-authored PSDs, etc.) live in Never commit large binary fixtures to this repo; fetch them pinned by commit and sha256-verified, as PhotoCraft does with `cargo xtask corpus`. + ## See also - [docs/gaps.md](docs/gaps.md): where EffectCraft falls short of After Effects and the prioritised workstreams (G1–G9); read it before choosing work @@ -119,4 +120,23 @@ as PhotoCraft does with `cargo xtask corpus`. - [docs/testing.md](docs/testing.md): oracle tests, criteria, benchmarks - [docs/agents.md](docs/agents.md): driving EffectCraft over MCP / the control channel, and the agent work loop - [docs/control-protocol.md](docs/control-protocol.md): control-channel method reference +- [docs/contributors.md](docs/contributors.md): the About window's contributor and model credits - [ATTRIBUTION.md](ATTRIBUTION.md): asset index + +## Contributor credits (About window) + +- About ▸ Contributors/Models are compiled into the binary from `contributors/contributors.json` + (commit stats; generated, never hand-edit) and `contributors/people.toml` (names people chose for + themselves). See `docs/contributors.md`. +- **Agents working for a contributor:** when you prepare a PR, check whether your human's GitHub + username has a `[people.]` entry in `contributors/people.toml`. If not, ask them once + whether they want to be credited by more than their username: a real name, a display name, and/or + their public GitHub profile name (`sync_github_name = true`). If yes, add **only their own** entry + (copy the template at the top of the file, or run + `python3 ../../craftrules/scripts/contributors.py --add-me . --real-name "…" --sync-github-name`) + and include it in their PR, committed as them. If no, change nothing: they are credited as + `@username` anyway. +- Never add, edit, guess or copy anyone else's entry or name (not from git config, commit authors or + GitHub profiles). Never hand-edit `contributors.json`. +- Maintainers refresh the stats with `python3 ../../craftrules/scripts/contributors.py .` (it also + re-verifies who wrote each `people.toml` entry; `--check` only verifies). diff --git a/Cargo.lock b/Cargo.lock index 980737ae..6af8dbc2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1624,6 +1624,7 @@ dependencies = [ "rayon", "serde", "serde_json", + "toml", "web-time", ] diff --git a/contributors/contributors.json b/contributors/contributors.json new file mode 100644 index 00000000..a8c5d00c --- /dev/null +++ b/contributors/contributors.json @@ -0,0 +1,179 @@ +{ + "schema": 1, + "repo": "storytold/effectcraft", + "branch": "main", + "head": "e38a92e792c07f1c57c5dcfcab37d91932b9e2b8", + "head_date": "2026-10-07T22:33:04Z", + "commits": 493, + "unattributed_commits": 0, + "contributors": [ + { + "login": "echelon", + "people_entry": true, + "github_name": null, + "prs": 32, + "commits": 349, + "lines_added": 326318, + "lines_deleted": 14226, + "binary_added": 96, + "binary_deleted": 0, + "first_commit": "2026-10-01T16:48:39Z", + "last_commit": "2026-10-07T19:37:26Z" + }, + { + "login": "storybored379", + "people_entry": false, + "github_name": null, + "prs": 6, + "commits": 6, + "lines_added": 102, + "lines_deleted": 6, + "binary_added": 0, + "binary_deleted": 0, + "first_commit": "2026-10-03T16:31:41Z", + "last_commit": "2026-10-06T16:58:59Z" + }, + { + "login": "bflatastic", + "people_entry": false, + "github_name": null, + "prs": 63, + "commits": 110, + "lines_added": 17161, + "lines_deleted": 2309, + "binary_added": 0, + "binary_deleted": 0, + "first_commit": "2026-10-03T17:19:22Z", + "last_commit": "2026-10-07T13:29:29Z" + }, + { + "login": "jonassneu", + "people_entry": false, + "github_name": null, + "prs": 3, + "commits": 3, + "lines_added": 463, + "lines_deleted": 19, + "binary_added": 0, + "binary_deleted": 0, + "first_commit": "2026-10-05T16:01:41Z", + "last_commit": "2026-10-06T23:43:57Z" + }, + { + "login": "fortesnow", + "people_entry": false, + "github_name": null, + "prs": 1, + "commits": 1, + "lines_added": 258, + "lines_deleted": 7, + "binary_added": 0, + "binary_deleted": 0, + "first_commit": "2026-10-06T01:36:48Z", + "last_commit": "2026-10-06T01:36:48Z" + }, + { + "login": "dexterlabs1", + "people_entry": false, + "github_name": null, + "prs": 3, + "commits": 4, + "lines_added": 3693, + "lines_deleted": 691, + "binary_added": 0, + "binary_deleted": 0, + "first_commit": "2026-10-06T05:00:31Z", + "last_commit": "2026-10-06T23:54:13Z" + }, + { + "login": "midasdf", + "people_entry": false, + "github_name": null, + "prs": 1, + "commits": 1, + "lines_added": 868, + "lines_deleted": 9, + "binary_added": 0, + "binary_deleted": 0, + "first_commit": "2026-10-06T07:22:23Z", + "last_commit": "2026-10-06T07:22:23Z" + }, + { + "login": "EthanSuquet", + "people_entry": false, + "github_name": null, + "prs": 1, + "commits": 1, + "lines_added": 1, + "lines_deleted": 538, + "binary_added": 0, + "binary_deleted": 67, + "first_commit": "2026-10-06T19:02:20Z", + "last_commit": "2026-10-06T19:02:20Z" + }, + { + "login": "coygeek", + "people_entry": false, + "github_name": null, + "prs": 1, + "commits": 1, + "lines_added": 4, + "lines_deleted": 0, + "binary_added": 0, + "binary_deleted": 0, + "first_commit": "2026-10-07T02:36:22Z", + "last_commit": "2026-10-07T02:36:22Z" + }, + { + "login": "Luskish", + "people_entry": false, + "github_name": null, + "prs": 1, + "commits": 1, + "lines_added": 252, + "lines_deleted": 32, + "binary_added": 0, + "binary_deleted": 0, + "first_commit": "2026-10-07T02:51:59Z", + "last_commit": "2026-10-07T02:51:59Z" + } + ], + "models": [ + { + "id": "anthropic/claude-opus/5.5", + "company": "Anthropic", + "model": "Claude Opus", + "version": "5.5", + "commits": 468, + "lines_added": 341908, + "lines_deleted": 17067 + }, + { + "id": "anthropic/claude", + "company": "Anthropic", + "model": "Claude", + "version": "", + "commits": 16, + "lines_added": 1577, + "lines_deleted": 146 + }, + { + "id": "anthropic/claude-opus/4.8", + "company": "Anthropic", + "model": "Claude Opus", + "version": "4.8", + "commits": 1, + "lines_added": 1632, + "lines_deleted": 3 + }, + { + "id": "openai/codex", + "company": "OpenAI", + "model": "Codex", + "version": "", + "commits": 1, + "lines_added": 14, + "lines_deleted": 1 + } + ] +} diff --git a/contributors/people.toml b/contributors/people.toml new file mode 100644 index 00000000..89c6db20 --- /dev/null +++ b/contributors/people.toml @@ -0,0 +1,23 @@ +# Contributor names for the About window (craftrules standards/contributors.md). +# +# Everyone who contributes is credited by GitHub username automatically. Anything more is up to +# you: add YOUR OWN entry below, in your own PR (commit it yourself). Never add someone else; a +# maintainer may add a person only when that person asked, recording where in consent_source. +# +# Easiest: python3 ../../craftrules/scripts/contributors.py --add-me . \ +# [--real-name "Ada Lovelace"] [--display-name "Ada"] [--sync-github-name] +# +# Or copy this block, replacing your-github-username (every field is optional): +# +# [people.your-github-username] +# real_name = "Your Name" # shown when the viewer picks "Real name" +# display_name = "Nickname" # shown when the viewer picks "Display name" +# sync_github_name = true # or: use the name on your public GitHub profile as display name +# +# To remove your names, delete your entry (or set fields empty) in a PR. The next +# contributors.py run, and the next build, drop them. + +[people.echelon] +real_name = "Brandon Thomas" +display_name = "Brandon Thomas" +sync_github_name = false diff --git a/crates/ui-egui/Cargo.toml b/crates/ui-egui/Cargo.toml index beaae6be..5bdfbf4f 100644 --- a/crates/ui-egui/Cargo.toml +++ b/crates/ui-egui/Cargo.toml @@ -34,3 +34,7 @@ image = { workspace = true } egui_kittest = { workspace = true, features = ["eframe", "wgpu"] } pollster = "0.4" effectcraft-host = { workspace = true } + +[build-dependencies] +serde_json = { workspace = true } +toml = "1" diff --git a/crates/ui-egui/build.rs b/crates/ui-egui/build.rs new file mode 100644 index 00000000..c5276ebf --- /dev/null +++ b/crates/ui-egui/build.rs @@ -0,0 +1,102 @@ +//! Bake the contributor credits into the binary as static Rust tables (craftrules +//! standards/contributors.md). Nothing is read at run time. +//! +//! - contributors/contributors.json: commit stats per GitHub username, generated by craftrules +//! scripts/contributors.py, which also marks whose people.toml entry it verified. +//! - contributors/people.toml: the names people chose for themselves. A name is used only when the +//! JSON says the entry was verified (`people_entry`). +//! +//! A missing or malformed file gives empty tables (or no names) and a warning. + +use std::fmt::Write as _; + +use serde_json::Value; + +fn main() { + let dir = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../../contributors"); + let json = read(&dir.join("contributors.json"), "the About window shows no contributors", |t| serde_json::from_str::(t).map_err(|e| e.to_string())) + .unwrap_or(Value::Null); + let people = + read(&dir.join("people.toml"), "contributors are shown by username only", |t| t.parse::().map_err(|e| e.to_string())).unwrap_or_default(); + let out = std::path::PathBuf::from(std::env::var_os("OUT_DIR").unwrap_or_default()).join("credits.rs"); + if let Err(e) = std::fs::write(&out, generate(&json, &people)) { + println!("cargo::warning=writing {}: {e}", out.display()); + } +} + +fn read(path: &std::path::Path, fallback: &str, parse: impl Fn(&str) -> Result) -> Option { + println!("cargo::rerun-if-changed={}", path.display()); + let r = std::fs::read_to_string(path).map_err(|e| e.to_string()).and_then(|t| parse(&t)); + if let Err(e) = &r { + println!("cargo::warning={}: {e}; {fallback}", path.display()); + } + r.ok() +} + +/// A non-empty string field of someone's people.toml entry, as a Rust `Option<&str>` literal. +fn name(v: Option<&str>) -> String { + match v.map(str::trim).filter(|s| !s.is_empty()) { + Some(x) => format!("Some({x:?})"), + None => "None".into(), + } +} + +fn s(v: &Value, k: &str) -> String { + format!("{:?}", v.get(k).and_then(Value::as_str).unwrap_or("")) +} + +fn n(v: &Value, k: &str) -> u64 { + v.get(k).and_then(Value::as_u64).unwrap_or(0) +} + +fn rows(json: &Value, k: &str) -> Vec { + json.get(k).and_then(Value::as_array).cloned().unwrap_or_default() +} + +fn generate(json: &Value, people: &toml::Table) -> String { + let mut o = String::new(); + let _ = writeln!(o, "pub static TOTAL_COMMITS: u64 = {};", n(json, "commits")); + let _ = writeln!(o, "pub static CONTRIBUTORS: &[Contributor] = &["); + for c in rows(json, "contributors") { + let login = c.get("login").and_then(Value::as_str).unwrap_or(""); + if login.is_empty() { + continue; + } + // Names only from a verified, self-chosen people.toml entry. + let entry = people.get("people").and_then(|p| p.get(login)).filter(|_| c.get("people_entry").and_then(Value::as_bool) == Some(true)); + let field = |k: &str| entry.and_then(|e| e.get(k)).and_then(toml::Value::as_str); + let synced = entry.and_then(|e| e.get("sync_github_name")).and_then(toml::Value::as_bool) == Some(true); + let display = + field("display_name").filter(|s| !s.trim().is_empty()).or_else(|| if synced { c.get("github_name").and_then(Value::as_str) } else { None }); + let _ = writeln!( + o, + " Contributor {{ login: {login:?}, display_name: {}, real_name: {}, prs: {}, commits: {}, lines_added: {}, lines_deleted: {}, binary_added: {}, binary_deleted: {}, first_commit: {}, last_commit: {} }},", + name(display), + name(field("real_name")), + n(&c, "prs"), + n(&c, "commits"), + n(&c, "lines_added"), + n(&c, "lines_deleted"), + n(&c, "binary_added"), + n(&c, "binary_deleted"), + s(&c, "first_commit"), + s(&c, "last_commit"), + ); + } + let _ = writeln!(o, "];"); + let _ = writeln!(o, "pub static MODELS: &[Model] = &["); + for m in rows(json, "models") { + let _ = writeln!( + o, + " Model {{ company: {}, model: {}, version: {}, commits: {}, lines_added: {}, lines_deleted: {} }},", + s(&m, "company"), + s(&m, "model"), + s(&m, "version"), + n(&m, "commits"), + n(&m, "lines_added"), + n(&m, "lines_deleted"), + ); + } + let _ = writeln!(o, "];"); + o +} diff --git a/crates/ui-egui/src/credits.rs b/crates/ui-egui/src/credits.rs new file mode 100644 index 00000000..442edb8c --- /dev/null +++ b/crates/ui-egui/src/credits.rs @@ -0,0 +1,435 @@ +//! The About window's credits: every contributor (GitHub login always; display and real names only +//! with recorded consent) and the AI models that helped. The tables are baked into the binary by +//! build.rs from contributors/contributors.json (craftrules standards/contributors.md); nothing is +//! read at run time. + +use std::cmp::Ordering; + +use egui::RichText; + +use crate::automation::Registry; + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub struct Contributor { + pub login: &'static str, + pub display_name: Option<&'static str>, + pub real_name: Option<&'static str>, + pub prs: u64, + pub commits: u64, + pub lines_added: u64, + pub lines_deleted: u64, + pub binary_added: u64, + pub binary_deleted: u64, + /// ISO 8601 UTC; empty for someone credited only through a merged PR. + pub first_commit: &'static str, + pub last_commit: &'static str, +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub struct Model { + pub company: &'static str, + pub model: &'static str, + pub version: &'static str, + pub commits: u64, + pub lines_added: u64, + pub lines_deleted: u64, +} + +include!(concat!(env!("OUT_DIR"), "/credits.rs")); + +/// Which name to show. Display and real names fall back to the `@username` when not given. +#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)] +pub enum NameMode { + #[default] + Username, + DisplayName, + RealName, +} + +impl NameMode { + pub const ALL: [NameMode; 3] = [NameMode::Username, NameMode::DisplayName, NameMode::RealName]; + + pub fn label(self) -> &'static str { + match self { + NameMode::Username => "Username", + NameMode::DisplayName => "Display name", + NameMode::RealName => "Real name", + } + } + + /// Automation id suffix. + pub fn id(self) -> &'static str { + match self { + NameMode::Username => "username", + NameMode::DisplayName => "displayName", + NameMode::RealName => "realName", + } + } +} + +#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)] +pub enum SortKey { + Name, + Prs, + Commits, + LinesAdded, + LinesDeleted, + LinesDelta, + BinaryAdded, + BinaryDeleted, + #[default] + FirstCommit, + LastCommit, +} + +impl SortKey { + pub const ALL: [SortKey; 10] = [ + SortKey::Name, + SortKey::Prs, + SortKey::Commits, + SortKey::LinesAdded, + SortKey::LinesDeleted, + SortKey::LinesDelta, + SortKey::BinaryAdded, + SortKey::BinaryDeleted, + SortKey::FirstCommit, + SortKey::LastCommit, + ]; + + /// Menu label and table header. + pub fn label(self) -> (&'static str, &'static str) { + match self { + SortKey::Name => ("Name (A–Z)", "Name"), + SortKey::Prs => ("Merged PRs", "PRs"), + SortKey::Commits => ("Commits", "Commits"), + SortKey::LinesAdded => ("Lines added", "+LOC"), + SortKey::LinesDeleted => ("Lines deleted", "−LOC"), + SortKey::LinesDelta => ("Line delta", "ΔLOC"), + SortKey::BinaryAdded => ("Binary assets added", "+Bin"), + SortKey::BinaryDeleted => ("Binary assets removed", "−Bin"), + SortKey::FirstCommit => ("First commit", "First"), + SortKey::LastCommit => ("Last commit", "Last"), + } + } + + /// Automation id suffix. + pub fn id(self) -> &'static str { + match self { + SortKey::Name => "name", + SortKey::Prs => "prs", + SortKey::Commits => "commits", + SortKey::LinesAdded => "linesAdded", + SortKey::LinesDeleted => "linesDeleted", + SortKey::LinesDelta => "linesDelta", + SortKey::BinaryAdded => "binaryAdded", + SortKey::BinaryDeleted => "binaryDeleted", + SortKey::FirstCommit => "firstCommit", + SortKey::LastCommit => "lastCommit", + } + } + + /// Names and dates read naturally oldest/A first; counts read biggest first. + pub fn default_ascending(self) -> bool { + matches!(self, SortKey::Name | SortKey::FirstCommit | SortKey::LastCommit) + } +} + +impl Contributor { + pub fn name(&self, mode: NameMode) -> String { + let chosen = match mode { + NameMode::Username => None, + NameMode::DisplayName => self.display_name, + NameMode::RealName => self.real_name, + }; + chosen.map_or_else(|| format!("@{}", self.login), str::to_string) + } + + pub fn lines_delta(&self) -> i128 { + i128::from(self.lines_added) - i128::from(self.lines_deleted) + } + + /// One line with everything we know, for tooltips. + pub fn summary(&self) -> String { + format!( + "@{}: {} PRs, {} commits, +{} / −{} lines (Δ {}), +{} / −{} binary assets, {} – {}", + self.login, + self.prs, + self.commits, + group(self.lines_added), + group(self.lines_deleted), + signed(self.lines_delta()), + self.binary_added, + self.binary_deleted, + day(self.first_commit), + day(self.last_commit), + ) + } +} + +/// Alphabetical key: case-insensitive, ignoring the `@` of usernames. +fn name_key(name: &str) -> String { + name.trim_start_matches('@').to_lowercase() +} + +fn compare(a: &Contributor, b: &Contributor, mode: NameMode, key: SortKey) -> Ordering { + match key { + SortKey::Name => name_key(&a.name(mode)).cmp(&name_key(&b.name(mode))), + SortKey::Prs => a.prs.cmp(&b.prs), + SortKey::Commits => a.commits.cmp(&b.commits), + SortKey::LinesAdded => a.lines_added.cmp(&b.lines_added), + SortKey::LinesDeleted => a.lines_deleted.cmp(&b.lines_deleted), + SortKey::LinesDelta => a.lines_delta().cmp(&b.lines_delta()), + SortKey::BinaryAdded => a.binary_added.cmp(&b.binary_added), + SortKey::BinaryDeleted => a.binary_deleted.cmp(&b.binary_deleted), + // A PR-only contributor (no commit date) sorts after everyone with a date. + SortKey::FirstCommit => dated(a.first_commit).cmp(&dated(b.first_commit)), + SortKey::LastCommit => dated(a.last_commit).cmp(&dated(b.last_commit)), + } +} + +fn dated(d: &str) -> (bool, &str) { + (d.is_empty(), d) +} + +/// Contributors in display order. Ties fall back to the name (A–Z) so the order is stable. +pub fn sorted(list: &[Contributor], mode: NameMode, key: SortKey, ascending: bool) -> Vec<&Contributor> { + let mut v: Vec<&Contributor> = list.iter().collect(); + v.sort_by(|a, b| { + let o = compare(a, b, mode, key); + let o = if ascending { o } else { o.reverse() }; + o.then_with(|| compare(a, b, mode, SortKey::Name)).then_with(|| a.login.cmp(b.login)) + }); + v +} + +fn group(n: u64) -> String { + let s = n.to_string(); + let mut out = String::with_capacity(s.len() + s.len() / 3); + for (i, ch) in s.chars().enumerate() { + if i > 0 && (s.len() - i).is_multiple_of(3) { + out.push(','); + } + out.push(ch); + } + out +} + +fn signed(n: i128) -> String { + let g = group(u64::try_from(n.unsigned_abs()).unwrap_or(u64::MAX)); + if n < 0 { format!("−{g}") } else { format!("+{g}") } +} + +fn day(iso: &str) -> &str { + if iso.is_empty() { "—" } else { iso.get(..10).unwrap_or(iso) } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +struct View { + names: NameMode, + key: SortKey, + ascending: bool, + table: bool, +} + +impl Default for View { + fn default() -> Self { + View { names: NameMode::Username, key: SortKey::FirstCommit, ascending: true, table: false } + } +} + +/// About ▸ Contributors: a name toggle, a sort, and the list as a grab bag or a table. Every +/// control registers an automation id under `about.credits.`. +pub fn contributors_ui(ui: &mut egui::Ui, auto: &mut Registry) { + let id = egui::Id::new("credits_view"); + let mut v = ui.data_mut(|d| d.get_temp::(id)).unwrap_or_default(); + ui.horizontal_wrapped(|ui| { + ui.label("Show"); + for m in NameMode::ALL { + let r = ui.selectable_label(v.names == m, m.label()); + auto.add(&format!("about.credits.show.{}", m.id()), r.rect, m.label()); + if r.clicked() { + v.names = m; + } + } + ui.separator(); + ui.label("Sort"); + let combo = egui::ComboBox::from_id_salt("credits_sort").selected_text(v.key.label().0).show_ui(ui, |ui| { + for k in SortKey::ALL { + let r = ui.selectable_label(v.key == k, k.label().0); + auto.add(&format!("about.credits.sort.{}", k.id()), r.rect, k.label().0); + if r.clicked() { + v.key = k; + v.ascending = k.default_ascending(); + } + } + }); + auto.add("about.credits.sort", combo.response.rect, "Sort"); + let r = ui.button(if v.ascending { "▲" } else { "▼" }).on_hover_text("Reverse the order"); + auto.add("about.credits.reverse", r.rect, "Reverse the order"); + if r.clicked() { + v.ascending = !v.ascending; + } + ui.separator(); + let r = ui.selectable_label(!v.table, "Grab bag"); + auto.add("about.credits.view.grabBag", r.rect, "Grab bag"); + if r.clicked() { + v.table = false; + } + let r = ui.selectable_label(v.table, "Table"); + auto.add("about.credits.view.table", r.rect, "Table"); + if r.clicked() { + v.table = true; + } + }); + let list = sorted(CONTRIBUTORS, v.names, v.key, v.ascending); + ui.label(RichText::new(format!("{} contributors · {} commits", list.len(), group(TOTAL_COMMITS))).small().weak()); + ui.separator(); + egui::ScrollArea::both().auto_shrink([false, false]).show(ui, |ui| { + if list.is_empty() { + ui.label("No contributor data was built into this copy."); + } else if v.table { + table(ui, &list, &mut v, auto); + } else { + ui.horizontal_wrapped(|ui| { + for (i, c) in list.iter().enumerate() { + if i > 0 { + ui.label(RichText::new("·").weak()); + } + let r = ui.hyperlink_to(c.name(v.names), format!("https://github.com/{}", c.login)).on_hover_text(c.summary()); + auto.add(&format!("about.credits.contributor.{}", c.login), r.rect, &c.name(v.names)); + } + }); + } + }); + ui.data_mut(|d| d.insert_temp(id, v)); +} + +fn table(ui: &mut egui::Ui, list: &[&Contributor], v: &mut View, auto: &mut Registry) { + egui::Grid::new("credits_table").striped(true).num_columns(SortKey::ALL.len()).show(ui, |ui| { + for k in SortKey::ALL { + let arrow = if v.key == k { if v.ascending { " ▲" } else { " ▼" } } else { "" }; + let r = ui.button(RichText::new(format!("{}{arrow}", k.label().1)).strong()).on_hover_text(k.label().0); + auto.add(&format!("about.credits.header.{}", k.id()), r.rect, k.label().0); + if r.clicked() { + if v.key == k { + v.ascending = !v.ascending; + } else { + v.key = k; + v.ascending = k.default_ascending(); + } + } + } + ui.end_row(); + for c in list { + let r = ui.hyperlink_to(c.name(v.names), format!("https://github.com/{}", c.login)).on_hover_text(c.summary()); + auto.add(&format!("about.credits.contributor.{}", c.login), r.rect, &c.name(v.names)); + ui.label(group(c.prs)); + ui.label(group(c.commits)); + ui.label(group(c.lines_added)); + ui.label(group(c.lines_deleted)); + ui.label(signed(c.lines_delta())); + ui.label(group(c.binary_added)); + ui.label(group(c.binary_deleted)); + ui.label(day(c.first_commit)); + ui.label(day(c.last_commit)); + ui.end_row(); + } + }); +} + +/// About ▸ Models: AI models credited in Co-Authored-By trailers. +pub fn models_ui(ui: &mut egui::Ui) { + if MODELS.is_empty() { + ui.label("No model credits were built into this copy."); + return; + } + let assisted: u64 = MODELS.iter().map(|m| m.commits).max().unwrap_or(0).max(1); + egui::ScrollArea::both().auto_shrink([false, false]).show(ui, |ui| { + egui::Grid::new("credits_models").striped(true).num_columns(6).show(ui, |ui| { + for h in ["Company", "Model", "Version", "Commits", "% of all commits", "Lines +/−"] { + ui.label(RichText::new(h).strong()); + } + ui.end_row(); + for m in MODELS { + ui.label(m.company); + ui.label(m.model); + ui.label(m.version); + ui.label(group(m.commits)); + ui.label(format!("{:.0}%", 100.0 * m.commits as f64 / TOTAL_COMMITS.max(assisted) as f64)); + ui.label(format!("+{} / −{}", group(m.lines_added), group(m.lines_deleted))); + ui.end_row(); + } + }); + }); +} + +#[cfg(test)] +mod tests { + use super::*; + + fn c(login: &'static str, display: Option<&'static str>, real: Option<&'static str>, added: u64, deleted: u64, first: &'static str) -> Contributor { + Contributor { + login, + display_name: display, + real_name: real, + prs: 0, + commits: 1, + lines_added: added, + lines_deleted: deleted, + binary_added: 0, + binary_deleted: 0, + first_commit: first, + last_commit: first, + } + } + + fn people() -> [Contributor; 4] { + [ + c("zed", None, None, 5, 50, "2026-01-02T00:00:00Z"), + c("Bob", Some("Ann"), None, 10, 0, "2026-01-01T00:00:00Z"), + c("alice", None, None, 7, 1, ""), + c("carol", None, Some("Dana"), 1, 0, "2026-01-03T00:00:00Z"), + ] + } + + fn logins(v: &[&Contributor]) -> Vec<&'static str> { + v.iter().map(|c| c.login).collect() + } + + #[test] + fn names_fall_back_to_the_username() { + let p = c("bob", Some("Bobby"), None, 0, 0, ""); + assert_eq!(p.name(NameMode::Username), "@bob"); + assert_eq!(p.name(NameMode::DisplayName), "Bobby"); + assert_eq!(p.name(NameMode::RealName), "@bob"); + } + + #[test] + fn alphabetical_ignores_at_and_case() { + let all = people(); + let v = sorted(&all, NameMode::Username, SortKey::Name, true); + assert_eq!(logins(&v), ["alice", "Bob", "carol", "zed"]); + let v = sorted(&all, NameMode::DisplayName, SortKey::Name, true); + assert_eq!(logins(&v), ["alice", "Bob", "carol", "zed"]); // "Ann" sorts with the @usernames + let v = sorted(&all, NameMode::RealName, SortKey::Name, false); + assert_eq!(logins(&v), ["zed", "carol", "Bob", "alice"]); // "Dana" between bob and zed + } + + #[test] + fn delta_and_dates() { + let all = people(); + let v = sorted(&all, NameMode::Username, SortKey::LinesDelta, false); + assert_eq!(logins(&v), ["Bob", "alice", "carol", "zed"]); + let v = sorted(&all, NameMode::Username, SortKey::FirstCommit, true); + assert_eq!(logins(&v), ["Bob", "zed", "carol", "alice"]); // undated last + } + + #[test] + fn formatting() { + assert_eq!(group(1234567), "1,234,567"); + assert_eq!(group(12), "12"); + assert_eq!(signed(-1000), "−1,000"); + assert_eq!(day("2026-10-07T18:45:23Z"), "2026-10-07"); + assert_eq!(day(""), "—"); + } +} diff --git a/crates/ui-egui/src/lib.rs b/crates/ui-egui/src/lib.rs index 358cc0f3..699d5893 100644 --- a/crates/ui-egui/src/lib.rs +++ b/crates/ui-egui/src/lib.rs @@ -11,6 +11,7 @@ pub mod audio; pub mod automation; pub mod bench; pub mod control; +pub mod credits; pub mod dock; pub mod dock_ui; pub mod frames; diff --git a/crates/ui-egui/src/panels/dialogs.rs b/crates/ui-egui/src/panels/dialogs.rs index 9ea0e780..80a3e88c 100644 --- a/crates/ui-egui/src/panels/dialogs.rs +++ b/crates/ui-egui/src/panels/dialogs.rs @@ -1,5 +1,5 @@ -//! Modal dialogs: About (with community links), New Composition / Composition Settings, Solid -//! Settings and the command palette (Camera/Light Settings live in `dialogs_3d`). +//! Modal dialogs: About (community links, Contributors and Models credits), New Composition / +//! Composition Settings, Solid Settings and the command palette (Camera/Light Settings live in `dialogs_3d`). use effectcraft_engine::project::{ItemId, ItemKind, LayerId, LayerSource}; use egui::{Align2, Color32, Rect, Sense, pos2, vec2}; @@ -194,67 +194,49 @@ pub fn show(app: &mut EffectcraftApp, ctx: &egui::Context) { } } +/// About tabs: About · Contributors · Models. +const ABOUT_TABS: [(&str, &str); 3] = [("About", "about"), ("Contributors", "contributors"), ("Models", "models")]; +/// Height of the Contributors / Models tab bodies (they scroll inside it). +const CREDITS_HEIGHT: f32 = 380.0; + fn about(app: &mut EffectcraftApp, ctx: &egui::Context, t: &Tokens) { let mut close = false; let mut cmd: Option<&str> = None; - modal(ctx, "About EffectCraft", vec2(520.0, 400.0), t, |ui| { - let (r, _) = ui.allocate_exact_size(vec2(ui.available_width(), 96.0), Sense::hover()); - let p = ui.painter(); - p.rect_filled(r, 10.0, Color32::from_rgb(0x1b, 0x22, 0x3c)); - crate::header::paint_logo(p, Rect::from_min_size(r.min + vec2(18.0, 20.0), vec2(56.0, 56.0))); - p.text(r.min + vec2(90.0, 34.0), Align2::LEFT_CENTER, "EffectCraft", Tokens::semibold(24.0), Color32::WHITE); - p.text( - r.min + vec2(90.0, 62.0), - Align2::LEFT_CENTER, - format!("Version {} • Motion graphics & VFX in pure Rust", env!("CARGO_PKG_VERSION")), - Tokens::ui(12.0), - t.text_dim, - ); - ui.add_space(12.0); - ui.label("A clean-room, open-source compositor for motion graphics and visual effects: native on macOS, Windows and Linux, and in the browser. Part of the ArtCraft family of creative apps."); - ui.add_space(14.0); - let links: [(Icon, &str, &str, &str); 4] = [ - (Icon::Chat, "Join the ArtCraft Discord", effectcraft_engine::links::DISCORD, "help.discord"), - (Icon::Globe, "ArtCraft website", effectcraft_engine::links::WEBSITE, "help.website"), - (Icon::Sparkle, "EffectCraft home page", effectcraft_engine::links::APP_PAGE, "help.appPage"), - (Icon::Code, "Source code on GitHub", effectcraft_engine::links::GITHUB, "help.github"), - ]; - for (icon, label, url, c) in links { - let (r, resp) = ui.allocate_exact_size(vec2(ui.available_width(), 30.0), Sense::click()); - let p = ui.painter(); - let discord = c == "help.discord"; - p.rect_filled( - r, - 6.0, - if discord { - Color32::from_rgb(0x58, 0x65, 0xf2) - } else if resp.hovered() { - t.hover - } else { - t.field_bg - }, - ); - let foreground = if discord { Color32::WHITE } else { t.text }; - icons::paint(p, Rect::from_center_size(pos2(r.min.x + 18.0, r.center().y), vec2(15.0, 15.0)), icon, foreground); - p.text(pos2(r.min.x + 36.0, r.center().y), Align2::LEFT_CENTER, label, Tokens::medium(12.5), foreground); - p.text( - pos2(r.max.x - 12.0, r.center().y), - Align2::RIGHT_CENTER, - url, - Tokens::ui(11.0), - if discord { Color32::from_white_alpha(200) } else { t.text_dim }, - ); - app.auto.add(&format!("about.{c}"), r, label); - if resp.clicked() { - cmd = Some(c); + let tab_id = egui::Id::new("about_tab"); + modal(ctx, "About EffectCraft", vec2(680.0, 520.0), t, |ui| { + let mut tab = ui.data_mut(|d| d.get_temp::(tab_id)).unwrap_or(0); + ui.horizontal(|ui| { + for (i, (label, id)) in ABOUT_TABS.iter().enumerate() { + let r = ui.selectable_label(tab == i, *label); + app.auto.add(&format!("about.tab.{id}"), r.rect, label); + if r.clicked() { + tab = i; + } } - ui.add_space(4.0); + }); + ui.data_mut(|d| d.insert_temp(tab_id, tab)); + ui.separator(); + match tab { + 1 | 2 => { + let h = CREDITS_HEIGHT.min(ui.available_height().max(120.0)); + ui.allocate_ui(vec2(ui.available_width(), h), |ui| { + ui.set_max_height(h); + if tab == 1 { + crate::credits::contributors_ui(ui, &mut app.auto); + } else { + crate::credits::models_ui(ui); + } + }); + } + _ => about_main(app, ui, t, &mut cmd), } ui.add_space(8.0); ui.horizontal(|ui| { ui.label(egui::RichText::new("MIT OR Apache-2.0 • Fonts: Inter, JetBrains Mono (OFL)").small().color(t.text_faint)); ui.with_layout(egui::Layout::right_to_left(egui::Align::Center), |ui| { - if ui.button("Close").clicked() { + let r = ui.button("Close"); + app.auto.add("about.close", r.rect, "Close"); + if r.clicked() { close = true; } }); @@ -268,6 +250,62 @@ fn about(app: &mut EffectcraftApp, ctx: &egui::Context, t: &Tokens) { } } +/// The About tab: logo, version, blurb and community links. +fn about_main(app: &mut EffectcraftApp, ui: &mut egui::Ui, t: &Tokens, cmd: &mut Option<&'static str>) { + let (r, _) = ui.allocate_exact_size(vec2(ui.available_width(), 96.0), Sense::hover()); + let p = ui.painter(); + p.rect_filled(r, 10.0, Color32::from_rgb(0x1b, 0x22, 0x3c)); + crate::header::paint_logo(p, Rect::from_min_size(r.min + vec2(18.0, 20.0), vec2(56.0, 56.0))); + p.text(r.min + vec2(90.0, 34.0), Align2::LEFT_CENTER, "EffectCraft", Tokens::semibold(24.0), Color32::WHITE); + p.text( + r.min + vec2(90.0, 62.0), + Align2::LEFT_CENTER, + format!("Version {} • Motion graphics & VFX in pure Rust", env!("CARGO_PKG_VERSION")), + Tokens::ui(12.0), + t.text_dim, + ); + ui.add_space(12.0); + ui.label("A clean-room, open-source compositor for motion graphics and visual effects: native on macOS, Windows and Linux, and in the browser. Part of the ArtCraft family of creative apps."); + ui.add_space(14.0); + let links: [(Icon, &str, &str, &'static str); 4] = [ + (Icon::Chat, "Join the ArtCraft Discord", effectcraft_engine::links::DISCORD, "help.discord"), + (Icon::Globe, "ArtCraft website", effectcraft_engine::links::WEBSITE, "help.website"), + (Icon::Sparkle, "EffectCraft home page", effectcraft_engine::links::APP_PAGE, "help.appPage"), + (Icon::Code, "Source code on GitHub", effectcraft_engine::links::GITHUB, "help.github"), + ]; + for (icon, label, url, c) in links { + let (r, resp) = ui.allocate_exact_size(vec2(ui.available_width(), 30.0), Sense::click()); + let p = ui.painter(); + let discord = c == "help.discord"; + p.rect_filled( + r, + 6.0, + if discord { + Color32::from_rgb(0x58, 0x65, 0xf2) + } else if resp.hovered() { + t.hover + } else { + t.field_bg + }, + ); + let foreground = if discord { Color32::WHITE } else { t.text }; + icons::paint(p, Rect::from_center_size(pos2(r.min.x + 18.0, r.center().y), vec2(15.0, 15.0)), icon, foreground); + p.text(pos2(r.min.x + 36.0, r.center().y), Align2::LEFT_CENTER, label, Tokens::medium(12.5), foreground); + p.text( + pos2(r.max.x - 12.0, r.center().y), + Align2::RIGHT_CENTER, + url, + Tokens::ui(11.0), + if discord { Color32::from_white_alpha(200) } else { t.text_dim }, + ); + app.auto.add(&format!("about.{c}"), r, label); + if resp.clicked() { + *cmd = Some(c); + } + ui.add_space(4.0); + } +} + fn comp_settings(app: &mut EffectcraftApp, ctx: &egui::Context, t: &Tokens, existing: bool) { let mut d = app.dialog_state.comp.clone(); let mut result = None; diff --git a/docs/contributors.md b/docs/contributors.md new file mode 100644 index 00000000..6b8a81e0 --- /dev/null +++ b/docs/contributors.md @@ -0,0 +1,55 @@ +# Contributors in the About window + +**About ▸ Contributors** credits everyone who contributed to EffectCraft, and **About ▸ Models** credits +the AI models named in `Co-Authored-By` trailers. This follows the shared craftrules standard +[`standards/contributors.md`](https://github.com/storytold/craftrules/blob/main/standards/contributors.md); +this page is the local copy of the decision. + +## Decision + +- Two files, both **compiled into the binary** by the UI crate's `build.rs` (nothing is read from + disk or the network at run time; the web build has them too): + - [`contributors/contributors.json`](../contributors/contributors.json): commit stats per GitHub + username. **Generated** by `craftrules/scripts/contributors.py`; never hand-edit. + - [`contributors/people.toml`](../contributors/people.toml): the names people chose for + themselves. **Each contributor adds only their own entry**, in their own PR. +- Each contributor gets one line: GitHub username (always), display name (opt-in, or their synced + GitHub profile name), real name (only if they told us), merged PRs, commits, lines added, lines + deleted, binary assets added, binary assets removed, first and last commit date. +- The list is shown as a **grab bag** (names flowing as text) or a **table**, in the same order. It + sorts by name, PRs, commits, lines added, lines deleted, line delta, binary assets added/removed, + first or last commit date. The name toggle cycles **Username → Display name → Real name**; a + missing name falls back to `@username`. Alphabetical sorting is case-insensitive and ignores the `@`. + +## In EffectCraft + +- The About window is `about()` in `crates/ui-egui/src/panels/dialogs.rs` (`app.about`, or click the header logo); automation ids `about.tab.*` and `about.credits.*`. + +## Credit yourself + +Add your entry to `contributors/people.toml` in a PR you commit yourself (every field optional): + +```toml +[people.your-github-username] +real_name = "Your Name" +display_name = "Nickname" +sync_github_name = true # use the name on your public GitHub profile as display name +``` + +or, with craftrules checked out next to `craft-apps/`: + +```sh +python3 ../../craftrules/scripts/contributors.py --add-me . --real-name "Your Name" --sync-github-name +``` + +Names show after the next refresh: the script checks that each entry was committed by its own +user (or by a maintainer with a `consent_source`). Delete your entry to remove your names. + +## Refreshing (maintainers) + +```sh +python3 ../../craftrules/scripts/contributors.py . # regenerate + verify; needs git, Python 3.11+, gh +python3 ../../craftrules/scripts/contributors.py --check . # verify people.toml only +``` + +Commit the updated `contributors/contributors.json`. Git author names and emails are never recorded.