# WordPress.org plugin assets

Files in this directory are **not** shipped inside the plugin zip. The
`10up/action-wordpress-plugin-deploy` action (see `.github/workflows/deploy.yml`)
publishes them to the plugin's SVN `/assets/` directory, where WordPress.org reads
them for the public listing. `.distignore` already excludes `/.wordpress-org`.

Asset changes do **not** require a plugin version bump — they are picked up on the
next deploy.

## Required / supported files

| File | Size (px) | Purpose |
| --- | --- | --- |
| `icon-128x128.png` | 128×128 | Plugin icon (search results, plugin card). |
| `icon-256x256.png` | 256×256 | Hi-DPI / retina icon. |
| `banner-772x250.png` | 772×250 | Header banner on the plugin page. |
| `banner-1544x500.png` | 1544×500 | Hi-DPI / retina banner. |
| `screenshot-1.png` | any | Matches entry 1 under `== Screenshots ==` in `readme.txt`. |
| `screenshot-2.png` | any | Matches entry 2 under `== Screenshots ==` in `readme.txt`. |
| `screenshot-3.png` | any | Matches entry 3 under `== Screenshots ==` in `readme.txt`. |

Notes:
- An `icon.svg` may be supplied instead of the PNG icons (WordPress.org accepts SVG icons).
- Screenshot files must be named `screenshot-N.png`, and their order must match the
  numbered list under `== Screenshots ==` in `readme.txt` — that list provides the captions.
- Allowed formats: PNG, JPG/JPEG, GIF. Keep banners free of small text (they get scaled).

## Regenerating

- **Icons + banners** — rendered from the HTML sources in
  [`../wporg-assets-src/`](../wporg-assets-src/) (brand logo + Archivo,
  OFL-licensed, see `../wporg-assets-src/fonts/OFL.txt`) via headless Chromium:
  `npm install && npx playwright install chromium && npm run wporg:assets`.
  Output dimensions are self-asserted; a wrong-sized PNG fails the run.
- **Screenshots** — real captures of the staging WordPress box, taken by the e2e
  repo's `@screenshots` spec, which writes `screenshot-1..3.png` directly into
  this directory via the sibling checkout: from `e2e/browser`, run
  `npm run test:screenshots` (see `e2e/browser/flows/wordpress/README.md` for
  preconditions).