Skip to content

macOS DMG: branded window background and icon layout - #21

Merged
echelon merged 1 commit into
storytold:mainfrom
XusBadia:dmg-background
Oct 9, 2026
Merged

echelon merged 1 commit into
storytold:mainfrom
XusBadia:dmg-background

Conversation

@XusBadia

@XusBadia XusBadia commented Oct 8, 2026 •

Copy link
Copy Markdown

What

The macOS DMG opened as a plain white Finder window. It now opens like this:

WordCraft DMG window in Finder

The icon's figure as a cover on the WordCraft colour field, WordCraft.app and the Applications link side by side on Paper, and a small WordCraft-specific touch: the arrow and the mono line under the title come from the app's craft. Ink, Paper and the app colour only; Inter and JetBrains Mono.

How

Same approach as PhotoCraft's and VectorCraft's, which have landed (storytold/photocraft#1201, storytold/vectorcraft#493):

  • packaging/macos/dmg/background.svg: the source. Its text is outlined, so rendering it needs no fonts, and the figure is an <image> of the existing icon in assets/app-icon/.
  • background.tiff: 1x 660×400 + 2x 1320×800 in one HiDPI TIFF (16-colour palette, Deflate, sRGB; 23 KB). No paper grain: noise doesn't compress, and this keeps the binary small.
  • dmg-layout.DS_Store: Finder's view settings (window 660×400 content, icon size 128, WordCraft.app at (326, 205), Applications at (574, 205), the background). It's named so it isn't mistaken for, or ignored like, a Finder-generated .DS_Store.
  • generate.py: writes both from the SVG on any OS (pip install 'pillow>=12' ds_store==1.3.3 mac_alias==2.2.3, resvg on PATH). The output is byte-for-byte reproducible and carries nothing from the machine that ran it: no paths, users, disk names or volume UUIDs.
  • package.sh copies the TIFF and the layout into the staging folder. The image is still built with hdiutil makehybrid, and nothing extra runs in the signing job.

One behaviour change: the volume name drops the version

.DS_Store points at the background through an alias that includes the volume name. With WordCraft <version> Finder kept the window and icon positions but lost the background (tested). So the mounted volume is now called WordCraft; the DMG file name still carries the version.

Tested

  • Built the image with the exact package.sh steps (staging folder, makehybrid, UDZO) around a stub WordCraft.app with the real icon, mounted it and opened it in Finder on macOS: the screenshot above is that DMG.
  • Finder draws icon labels in black in both light and dark appearance when the window has a background (checked in both), so the label area stays light.
  • Margin check: no artwork within 10 pt of either 128 pt icon box or of the label strips (pixel diff of the background against the same background without artwork).
  • shellcheck clean; cargo xtask assets passes where the repo has it; generate.py reproduces the committed files byte for byte (6 runs).
  • Not run: a full signed and notarized release build (needs the Developer ID secrets).

Across the suite

Matching PRs for every Crafting App, same layout, each with its own figure and colour:

Crafting Apps DMG windows

🤖 Generated with Claude Code

The DMG opened as a plain Finder window. It now shows the app icon's figure on
the WordCraft colour, with WordCraft.app and the Applications link side by side.
Same approach as PhotoCraft's and VectorCraft's (storytold/photocraft#1201,
storytold/vectorcraft#493).

- packaging/macos/dmg/: background.svg (source; text outlined, no paper grain,
  the figure an <image> of assets/app-icon), background.tiff (1x + 2x HiDPI,
  16-colour palette, Deflate, sRGB; ~23 KB)
  and dmg-layout.DS_Store (Finder view settings: window, icon size 128,
  positions, background).
- generate.py writes the TIFF and the layout on any OS, byte-for-byte
  reproducible, with nothing from the machine that ran it (no paths, users,
  disk names or volume UUIDs).
- package.sh copies them into the staging folder; the image is still built with
  hdiutil makehybrid. Nothing extra runs in the signing job.
- The volume name drops the version: the layout finds the background through
  an alias that includes the volume name. The DMG file name keeps the version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@echelon
echelon merged commit 09f6b37 into storytold:main Oct 9, 2026
@echelon

echelon commented Oct 9, 2026

Copy link
Copy Markdown
Member

Lovely, reproducible DMG window. Byte-for-byte reproducibility and the scrubbed alias are exactly what we want for a committed binary. Merged! We'll check that the background shows up on the next signed and notarized release.

Thank you for contributing to WordCraft! If you haven't already, please join our Discord: https://discord.gg/artcraft

matstrange added a commit to matstrange/wordcraft that referenced this pull request Oct 21, 2026
The ids the main document refers to are the ones it names in a relationship
attribute (`r:id`, VML's `o:relid`) — the same rule the embedded objects
use. The reader has already parsed the main document, so the ids are taken
from that tree: no search over the part at all, and no second parse.

An id that only appears as text is not a reference. The text names no part,
and treating it as one lost the part on save: the relationship was skipped
as "already referred to", so its target was carried neither by the element
that names it nor as an unmodelled part.

The ranked gap list held two rows each for storytold#19, storytold#20 and storytold#21; the stale
copies are gone, and the kept rows carry the measured figures. The layout
parity table now carries the benchmark's numbers for the word beside a
float, and the commit they were measured on.

storytold#3411
matstrange added a commit to matstrange/wordcraft that referenced this pull request Oct 22, 2026
main moved 553 commits ahead (e05b7fe..8e98636), so the branch no longer
merged cleanly. The conflicts were ROADMAP.md, docs/file-format-parity.md,
docs/layout-parity.md and docs/gaps.md; the code merged on its own.

Each of the four documents carries the branch's change in front of main's,
with both sides kept: the status line lists the branch's item first and
main's list after it as "previously trivial: ", and the progress log and
the revision history take the branch's entry first, then main's.

docs/gaps.md also holds the ranked gap table. main carried two rows each
for storytold#19, storytold#20 and storytold#21; the branch had already dropped the stale copies, so
the table has one row per gap now, and each row keeps both sides' text:
main's screen-reader entry in storytold#18, its content-control saving figure and
its ODT table column widths in storytold#19 and storytold#20, and the branch's storytold#3411 and
storytold#3412 figures in storytold#20.

Co-Authored-By: opencode <noreply@opencode.ai>
daghantektepe added a commit to daghantektepe/wordcraft that referenced this pull request Nov 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants