mirror of https://github.com/storytold/effectcraft.git synced 2026-10-30 13:08:07 -06:00

Files

T

Kaedo17 ac0188f315 ci: name the missing ALSA package instead of dying at link time

When the ALSA development package is missing, `cargo xtask ci`'s audio
stage failed at link time with a bare linker error. The check now says
which package installs ALSA's contents on each supported distro, the
missing one is named in the error, and the stage's own tests pin both
the present-ALSA pass and the per-distro message.

2026-10-30 01:30:50 +08:00

2.9 KiB

Raw Blame History

Contributing to EffectCraft

Thanks for helping. Please read AGENTS.md first: its rules on assets and clean-room work apply to everyone, people and AI agents alike, and they are not negotiable.

Setup

You need Rust 1.95 or newer.

On Linux the desktop app plays preview sound through cpal, so the build also needs the ALSA development headers. Without them alsa-sys fails at link time with an unrelated-looking error; cargo xtask ci checks for them up front and names the package:

sudo dnf install alsa-lib-devel        # Fedora
sudo apt install libasound2-dev        # Debian / Ubuntu
sudo pacman -S alsa-lib                # Arch

If you cannot install the package, point PKG_CONFIG_PATH at a directory holding an alsa.pc whose Libs line names your system's libasound (usually libasound.so.2); every CI run needs that variable set.

cargo run -p effectcraft -- --demo       # the desktop app, with the demo project
cargo test --workspace
cargo xtask ci                           # what every commit must pass

Ground rules

Clean room. Work from After Effects' public documentation and its observable behaviour only. Never use Adobe artwork, presets or code, and never copy GPL/LGPL/AGPL code.
Every asset is attributed. Add a .attribution sidecar and an ATTRIBUTION.md row; cargo xtask assets checks it.
Layering. Nothing below the interface layer depends on UI or OS crates; see docs/architecture.md.
Everything is a command. New features are engine commands with an id, label, menu path, shortcut and parameters, so the UI, the CLI and the MCP server get them at once. Interactive widgets register an automation id.
Never crash. Non-test code returns errors instead of panicking: no unwrap(), expect(), panic!, unreachable!, todo!, unimplemented! or unsafe, checked indexing and arithmetic on input-derived values, and a regression test with every crash fix. See the "Never crash" section of AGENTS.md.
Tests with every change, and green cargo xtask ci before every commit. One task per commit.

How to add…

An effect: add an EffectSpec in crates/effects (AE display name, category, parameters with AE's names, defaults and ranges) and its render function, with a determinism test and a behaviour test. If it reads the clock directly, add it to TIME_DEPENDENT.
A command: register it with cmd! in crates/engine/src/commands/, place it in the menu tree in crates/engine/src/menus.rs, and test it including undo.
A panel or dialog: crates/ui-egui/src/panels/; look at the result with the headless snapshot tool described in docs/testing.md.

Talk to us

Questions, ideas and bug reports are welcome on Discord and in GitHub issues.