Jannis Braun
6b71aecc28
The SpaceSidebar's home tile is a 40×40 rounded-[20px] squircle with object-cover. The original spec assumed the sidebar provides "the colour-circle frame," so logo.png shipped as the bare gradient B on transparent. In practice the tile is a transparent slot — the bare mark touched the squircle edges (no internal padding), conflicted with the active-state ring, and read as poorly-integrated. Switching to the full badge (Element 1 / app-icon.svg): the badge's own dark squircle bg fills the tile, its internal padding around the mark keeps the gradient off the edges, and the result reads as a clean Discord-style "home space" tile alongside the user's other spaces. Only logo.png regenerated; remaining 21 outputs byte-identical (determinism gate verified). Spec output matrix and generator README updated to reflect the corrected source mapping.
47 lines
2.0 KiB
Markdown
47 lines
2.0 KiB
Markdown
# Icon Generator
|
|
|
|
Regenerates every brand artefact from `assets/brand/*.svg`:
|
|
|
|
- macOS `.icns`, Windows `.ico`, Linux per-size PNGs (`packages/desktop/build/`)
|
|
- Tray icons for all three platforms (`packages/desktop/resources/`)
|
|
- Web favicons, PWA manifest icons, maskable, in-app `logo.png` (`packages/web/public/icons/`)
|
|
|
|
## When to run
|
|
|
|
After changing any file under `assets/brand/`, **or** after bumping `sharp`,
|
|
`png-to-ico`, or `png2icons` in the root `package.json`. Commit the diff in
|
|
the same PR.
|
|
|
|
```bash
|
|
pnpm gen-icons
|
|
git status # review which files changed
|
|
git add packages/desktop/build/ packages/desktop/resources/ packages/web/public/icons/
|
|
git commit -m "chore: regenerate brand icons"
|
|
```
|
|
|
|
(Stage explicit paths rather than `git add -A` — the generator only writes to those three directories, and an unrelated working-tree change shouldn't accidentally land in a "regenerate icons" commit.)
|
|
|
|
## Determinism
|
|
|
|
Output is byte-stable for a given lockfile. The same SVGs in produce the
|
|
same PNG/ICO/ICNS bytes out, every time, on every OS — Sharp uses resvg
|
|
internally and writes deterministic PNGs, png-to-ico and png2icons don't
|
|
embed timestamps.
|
|
|
|
**Caveat:** byte-stability is *not* guaranteed across version bumps of
|
|
the three encoder deps. After a Renovate / dependabot PR upgrades any of
|
|
them, run `pnpm gen-icons` once and commit the resulting diff inside the
|
|
same PR. That follow-up commit isn't an artwork change — it's encoder
|
|
output drift, and gating it inside the dep PR keeps the artwork-change
|
|
git history clean.
|
|
|
|
## Source SVGs
|
|
|
|
| Brand source | Drives |
|
|
|---------------------------------|-----------------------------------------------|
|
|
| `assets/brand/app-icon.svg` | Every full app icon, all favicons, PWA, in-app `logo.png` |
|
|
| `assets/brand/mark.svg` | Win/Linux tray, PWA maskable inner mark |
|
|
| `assets/brand/mark-mono-dark.svg` | macOS menu-bar template (alpha + black) |
|
|
|
|
`Artworks-Backspace/` is the design archive — never read by this script.
|