Skip to content
hridaya423Public

About

Your KiCad board, as a launch film. silk reel turns a .kicad_pcb into a 12-second film of its real copper and parts.

Topics

Resources

Stars

50 stars

Watchers

0 watching

Forks

Repository files navigation

silk reel: KiCad board in, launch film out. Glasgow's real copper routes out of its iCE40 and powers on.

Your KiCad board, as a launch film.
A command-line tool and a browser studio that turn a .kicad_pcb into a 12-second film of that exact board, with sound.

License: Apache 2.0 Input: .kicad_pcb Output: MP4, GIF, WebM, ProRes

Try it on your board  ·  Docs  ·  Website

You spent months on the board. It deserves better than a phone photo on a desk.

silk reel reads the board file and films it. The copper routes out of your main chip. The mask goes on. Every part lands on its pads. Then the board powers on, and the camera holds on a poster frame with the board's name. Nothing is stock footage. Every trace, pad and label in the film is in your file.

Glasgow's trace film: bare copper, mask, parts, power-on, and a held poster frame on its iCE40 FPGA

The Glasgow interface explorer, from its board file alone. On the website it plays with its score.

One file in, one film out

Left: the Glasgow board in KiCad's layer view. Right: the last frame of its silk reel film, the iCE40 under the name GLASGOW REV C3.

The film is 360 frames on a 24-beat grid. Each beat comes from your board:

+-[ glasgow.mp4 ]----------------------+
|                                      |
|  ●   0.0 s  Copper leaves the chip   |
|  │                                   |
|  ●   2.5 s  Mask covers the copper   |
|  │                                   |
|  ●   3.5 s  Silkscreen prints        |
|  │                                   |
|  ●   3.7 s  Parts land, once         |
|  │                                   |
|  ●   6.0 s  Power on                 |
|  │                                   |
|  ○  10.0 s  The poster frame holds   |
|                                      |
+--------------------------------------+

silk reel picks the main chip itself: the IC that carries the most signals. Name another with --hero U3.

Four looks

Trace Montage
Glasgow as a trace film Glasgow as a montage film
The lit board. A studio floor, real part models, one power-on. The trailer cut. Build, stop, release, poster. Add your own lines with --line.
Glyph Plot
Glasgow as a glyph film Glasgow as a blueprint plot film
Parts as type. The board's own parts and words, set as glyphs, ending on its name. A blueprint. The board drafted in pale ink on navy, ending on a title sheet.

Every look renders at 4:5, 1:1, 9:16 or 16:9, so one board gives you the post, the story and the banner. Each look has its own score: CC0 music by human artists, cut so its biggest moment lands on the film's turn.

Any board

Six KiCad boards, each filmed by silk reel: iCEBreaker, Glasgow, StickHub, an ECC83 preamp, a ColdFire dev kit and a video board

iCEBreaker · Glasgow · StickHub
ECC83 preamp · ColdFire dev kit · KiCad video board

An FPGA board, a USB hub, a valve preamp and a 312 mm PCI card. Each film came from its board file. The only flags were --title and --aspect. silk reel uses each part's own 3D model when KiCad can find it.

Quick start

Install Node.js 22 or later, and put ffmpeg and ffprobe on your PATH.

git clone https://github.com/hridaya423/silkreel
cd silkreel
npm ci
npm run reel -- path/to/your-board.kicad_pcb --title "Your Board" --version v1.0

The film lands beside your board as <board>-trace-4x5.mp4, with <name>.poster.png, its last frame, for a cover image. The first render downloads a headless Chrome. Later renders reuse it.

If your machine has no GPU, put SILK_REEL_GL=swangle in front of the command. silk reel reads KiCad 4 and later. It does not read Gerber, Eagle or Altium files.

Options

flag values default
--style trace · montage · glyph · plot trace
--aspect 4:5 · 1:1 · 9:16 · 16:9 4:5
--format mp4 · gif · webm-alpha · prores-alpha mp4
--title, --version the board's name and revision on the title card the silkscreen, else the title block
--hero the part the film is about, e.g. U3 the chip that carries the most signals
--mask green · black · white · blue · red · yellow · purple (trace and montage) the board file's, else green
--accent one highlight colour: the light on trace, the chip's lit edge on montage, the main chip on glyph, the signal on plot the palette's own
--palette copper · mono · blueprint · phosphor · paper · cyanotype per style
--line up to three lines of your own in the montage's build none
--ending glyph's last shot: parts or routes parts
--music your own track, cut to the film the style's score
--no-audio a silent film off
--seed any number; each one gives a different variation 42
--credit a 1.5 s "made with silk reel" card after the film off

Run npm run reel -- --help for every flag. The alpha formats have a transparent background, so you can put the film over your own footage. The same board and flags always render the same film.

Part models

A trace film shows each part's own 3D model when it finds the STEP file. It reads the model paths in your board the way KiCad does. Add more folders with --models DIR. A part without a model keeps an estimated body, and the CLI lists it.

Share your film

Post the MP4 as it is, or use <name>.poster.png as the cover. To credit the tool, add --credit. The film plays whole, then ends on a 1.5 s card: the silk reel mark, "made with silk reel" and the address. The poster PNG stays the film's own last frame. The studio has the same switch. It is off by default.

Studio

The browser studio previews every look for your own board. The tab reads your board file and does not upload it. It records WebM, saves stills, and writes the CLI command for the other formats.

To render every format from a queue, run the studio and the render API on your machine. The studio shows a Render button while the API answers:

npm run start --workspace=@silk-reel/render-api   # render API on :3102
npm run dev --workspace=@silk-reel/site           # studio at http://localhost:4321/studio/

How it works

  1. ingest parses the .kicad_pcb: outline, copper on every layer, pads, vias, zones, footprints and silkscreen.
  2. choreo compiles the board into a timeline. It picks the main chip and solves the shot list for each board and each aspect.
  3. render draws each frame. Trace uses WebGL2 with depth of field, HDR bloom and motion blur.
  4. render-api encodes the frames with Remotion and ffmpeg, and adds the score, mastered to −14 LUFS.

cli, site and metrics hold the CLI, the website with its studio, and the video probes. The banner at the top of this page is Glasgow's front copper, drawn by .github/assets/banner.mts.

Development

npx tsc --noEmit         # typecheck
npx vitest run           # tests
npx eslint packages      # lint

Every change to how a film looks goes through a full-video review. AGENTS.md has the commands and the rubric.

Credits

  • Sample boards: iCEBreaker © 2019 1BitSquared, CC BY-SA 4.0. Glasgow rev C3, Glasgow Embedded, 0BSD. StickHub, the ECC83 preamp, the ColdFire dev kit and the video board are KiCad demo projects.
  • Sound: CC0 recordings and music from Freesound, OpenGameArt and the Free Music Archive, listed in CREDITS.md.
  • STEP reading: occt-import-js and Open CASCADE Technology, both LGPL 2.1, used unmodified as an npm dependency.
  • Type: title cards use JetBrains Mono Medium and Bold, v2.304 from the official release (SIL Open Font License 1.1, OFL.txt), bundled so renders match on every machine.
  • Drafting type: the blueprint film letters its callouts, panel titles and title block in Silk Draft, a modified version of Routed Gothic by Darren Embry (the regular weight from the author's repository, SIL Open Font License 1.1, OFL-RoutedGothic.txt). Silk Draft gives the 1 a flag and a foot and slashes the 0, so designators never read as I and O; scripts/silk-draft-font.py builds it from the original, and it is renamed because "Routed Gothic" is a Reserved Font Name.
  • Wordmark type: Martian Mono by Evil Martians (SIL Open Font License 1.1, OFL-MartianMono.txt), the website's own typeface, on the banner and the --credit end card.

License

silk reel is licensed under the Apache License 2.0. The sample boards, the sound recordings and the fonts keep their own licenses, listed under Credits.

About

Your KiCad board, as a launch film. silk reel turns a .kicad_pcb into a 12-second film of its real copper and parts.

Topics

Resources

Stars

50 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages