@songsid/agend 2.2.1 → 2.2.5

package/dist/general-knowledge/skills/web-appearance/SKILL.md

@@ -0,0 +1,492 @@
+---
+name: web-appearance
+description: How you look on the AgEnD web dashboard — check it, change your own theme, identity card, identity colour and widgets, set an ambient effect (falling petals, click stars), play Canvas Worker effects in your chat (and offer a Try), preview the result, share it as a mod; and, for General, changing Settings → Web appearance for the user
+roles: [general, worker, classic]
+---
+
+## What it is
+
+People see you on the web dashboard: in the sidebar, at the top of your chat, on your Details page and in View. You
+can shape how you look there — **only your own look, and only on the surfaces that are yours**:
+
+| Surface | What you set | Tools |
+|---|---|---|
+| Your name and role line | display name, description | `set_display_name`, `set_description` |
+| Your status stamp | persona emoji | `set_persona_emoji` (see the `persona-emoji` skill) |
+| Your chat | theme: colours, accent, bubbles, font, background picture, working label | `set_web_theme`, `set_web_theme_asset` |
+| Your face and ring | theme picture and accent | `set_web_theme`, `set_web_theme_asset` |
+| Your identity card | portrait, banner, tagline, bio | `set_web_theme` (`card.*`), `set_web_theme_asset` |
+| Your identity colour | the colour people find you by in the sidebar, and where it shows (name, bar, ring) | `set_web_theme` (`identity`) |
+| Your chat header strip and Details page | widgets: small panels of facts the dashboard draws | `set_web_widget`, `remove_web_widget` |
+| An ambient effect in your chat | falling petals, snow, rising lanterns, twinkles, stars where a person clicks — data only, drawn by the dashboard | `set_web_ambient`, `clear_web_ambient` |
+| A file of your look | a mod: export yours, or propose one for a person | `export_web_mod`, `propose_web_mod` |
+| Effects in your chat | Canvas Worker animations, and Try cards an admin outside the public link may start | `upload_web_effect`, `apply_web_effect`, `preview_web_effect`, … (see Effects) |
+
+None of these tools takes a target: they always act on you. You can't change another instance, the dashboard's own
+chrome, a person's sidebar widget, or a person's custom CSS.
+
+## For the user: Settings → Web appearance (General, coordinators, full)
+
+If you are General (or a coordinator or full profile), you can change the user's **Settings → Web appearance** for
+them, exactly as the page changes it: the same checks, the same refusals. Custom CSS keeps its safe rules: no remote
+URLs, assets only as `url("asset:<id>")`, at most 64 KiB. Other instances can't; they shape only their own look (the rest
+of this skill).
+
+1. **Read first:** `get_web_settings` returns a `summary` in plain words (tell the user from it), the values, and
+   `people`: the host operator and everyone who has signed in. Host settings are everyone's on this host. Custom CSS and
+   effect slots are one person's own: pass `person` as the entry whose id is the user's (`person:<adapter>:<their id>`),
+   else the host operator's are changed.
+2. **One change per call:** `set_web_settings({ person?, change })`, where `change.what` is one of:
+
+| `what` | Changes | Example |
+|---|---|---|
+| `host` | `themes_shown`, `card_size` (s/m/l), `card_sizes` ({instance: s/m/l}), `colour_places` (name/bar/ring), `colours_off`, `sidebar_widget` ({spec, data}) — null puts one back to its default | `{ what: "host", set: { colour_places: ["name","ring"] } }` |
+| `agent_colour` | one agent's colour (`preset:<name>` or `#rrggbb`) and places; null resets each | `{ what: "agent_colour", instance: "atlas", colour: "preset:teal" }` |
+| `banner_focus` | which part of one agent's cropped card banner stays in view: `focus` 0 (top) … 100 (bottom), 50 the centre; it wins over the agent's own `card.bannerFocus`; null follows the agent's again | `{ what: "banner_focus", instance: "atlas", focus: 20 }` |
+| `custom_css` | `save` (with `text`): goes **on trial**. It waits until they open the dashboard (up to 10 minutes; never opened, it goes back unseen), then goes back by itself 20 s after it is on their screen unless kept (#2198). `keep` (the trial; or, kept after that 20 s ran out, it is put back in force as `use` of it), `revert` (the trial), `use` (with `version`: an earlier saved one, at once), `off` | `{ what: "custom_css", action: "save", text: "…" }`; tell them to open the dashboard and look, then `keep` only when they say so — a `keep` that comes too late (`not_on_trial`) means use `use` with the version from `get_web_settings` |
+| `mod` | an agent's proposal: `review` (instance → `stage`, `plan`, `plan_hash`), then `install` (stage, plan_hash, `include`: the parts, `target`: the agent); `cancel`, `dismiss`, `uninstall` (id) | review, show the user the plan, install only what they asked for — never custom CSS unasked. A person has one review open at a time: while theirs is open (`mod_review_open`) ask them to finish it; a mod they imported from a file is theirs to install (`mod_not_from_an_agent`) |
+| `effect` | `apply` (instance, id, params?) or `remove` (instance, id?) an effect on a chat | |
+| `ambient` | one agent's ambient effect, set for the user: `ambient` is the same spec as `set_web_ambient`'s (it replaces the one of its kind, and the agent can't change it after); `ambient: null` clears (`which`: `loop` or `click`, default both) | `{ what: "ambient", instance: "atlas", ambient: { preset: "fall", glyphs: ["🌸","❀","✿"] } }` |
+| `effect_slot` | a person's `sidebar` / `header` / `page` / `box` / `cursor` effect (an id, or null) | |
+| `restore_defaults` | the host settings back to their defaults, and the person's custom CSS off | |
+
+3. **Say what changed** in the user's words (read again if unsure). A refusal says why: the same words the page would
+   show.
+
+**Only the person can do these, on the page:**
+- choose a file from their computer: import a mod file, upload an effect folder, add a CSS asset or a card picture;
+- this browser's own switches: custom CSS off on this device, pausing effect playback;
+- download an export;
+- the card upload limits (fleet configuration; a raise waits for an admin's confirmation).
+
+## Look first
+
+- `get_web_appearance` — how you appear **now**, resolved exactly as the dashboard resolves it: your face and where it
+  comes from (`profile`, `theme`, `bot`, `emoji` or `initial`), your ring colour, your **identity colour**
+  (`identity_color`: the colour people find you by in the sidebar, its `source` — `person`, `agent` (your theme's
+  `identity.color`, else its `accent`), `role` (your own bot's Discord role) or `auto` — its `light` / `dark` values,
+  where it shows (`show`: `name`, `bar`, `ring`) and whose choice that is (`show_source`: `person`, `agent` or `host`),
+  and `off` when the host turned colours off), your card field by field
+  (each marked `human` or `agent`), your theme per light/dark mode after the defaults, whether a person locked it, and
+  your limits.
+- `preview_web_appearance` (`modes`: `["light"]`, `["dark"]` or both) — draws that as an SVG per mode into
+  `.agend/appearance/<mode>.svg` in your working directory, with the pictures it shows written beside it
+  (`avatar.png`, `portrait.png`, …), and returns both lists of paths. Read the SVGs for exact colours, geometry and
+  text, and the pictures as images. Only your own pictures are there.
+- `get_web_theme` — your stored theme, the token defaults it is drawn over, your uploaded pictures (`id`, `slot`), and
+  `limits` (changes left, each picture slot's size limits, your picture quota).
+
+## What wins over what
+
+- **A person's choices win.** A picture uploaded for you in View beats your theme picture. A person's card field (from
+  View's Edit profile) beats yours, field by field — leave it to them. A person can **Lock** your theme (every change
+  you try is refused with `locked`) or **Reset** it (your theme, card and pictures go; a lock stays).
+- A widget **a person placed** in one of your slots takes your values (`data`), but you can't replace or remove it
+  (`person_placed`).
+- **Each viewer decides what they see.** Anyone can turn agents' themes and widgets off for their own screens, and
+  `?safe=1` loads a page without them; they then see the default look, no widgets, and your face follows the usual order without your theme
+  picture — a picture a person uploaded for you, else your bot's avatar, your persona emoji or your first letter.
+  Don't rely on your theme to say something important.
+- The fleet can turn agent changes off entirely (`web.themes.agent_edit: false`): every change is refused with
+  `theme_editing_off`; what you stored stays.
+
+## Change your theme
+
+`set_web_theme { set?, clear? }` — all or nothing; `set` merges into your current theme, `clear` removes dotted paths.
+Typed values only; anything else is refused with `{ errors: [{ path, problem }] }`:
+
+- `colors.light` / `colors.dark`: any of `bg`, `surface`, `text`, `text2`, `accent`, `userBubble`, `agentBubble` as
+  `#rrggbb` (or `#rgb`). **Contrast is checked per mode**: `text` at least 4.5:1 on `bg`, `surface` and both bubbles;
+  `text2` at least 4.5:1 on `bg` and `surface`; `accent` at least 3:1 on `bg` — a palette that fails is refused, naming
+  the pair.
+- `accent`: `#rrggbb` for both modes (a mode's own `accent` wins). Without `identity.color`, it is also your identity
+  colour.
+- `identity`: `{ color?, show? }`: your identity colour and where it shows.
+  - `color` is a preset (`red`, `orange`, `amber`, `lime`, `green`, `teal`, `cyan`, `blue`, `indigo`, `violet`, `pink`,
+    `slate`, each readable in light and dark) or `#rrggbb`.
+  - `show` is a list of `name`, `bar` and `ring` (`[]` for nowhere). Left out, the host's default applies (name, bar and ring).
+  - A person's choice for you in the dashboard always wins, field by field, and their Reset brings yours back.
+    `get_web_appearance` says which is in force.
+- `bubble`: `{ radius: 0..24, border: "none" | "thin" | "accent" }`.
+- `font`: `"inter"`, `"system"` or `"mono"`.
+- `background`: `{ image: <asset id>, fit: "cover" | "contain", opacity: 0.05..1 }`.
+- `avatar`: an asset id — your face (below a person's upload).
+- `workingLabel`: 1..24 characters on one line, shown while you work instead of "is working…".
+- `card`: `{ portrait?, banner?, tagline?, bio?, bannerFocus? }` — see below.
+
+Example:
+
+```json
+{ "set": { "accent": "#7c3aed", "colors": { "dark": { "bg": "#14121f" } }, "bubble": { "radius": 12, "border": "accent" },
+  "font": "inter", "workingLabel": "Reviewing" } }
+```
+
+`reset_web_theme` puts your theme back to the default (it counts as a change).
+
+## Pictures
+
+`set_web_theme_asset { slot, file }` — `file` is a picture in **your working directory** (no symlinks; read on your side,
+never by path on the fleet). It returns `{ id }`; name that id in `set_web_theme`. Metadata such as GPS is removed, and
+the id is the hash of what is kept, so the same picture is the same id.
+
+| Slot | Types | Limits |
+|---|---|---|
+| `background` | png, jpeg, webp, gif | 512 KiB, 4096 px a side |
+| `avatar` | png, jpeg, webp, gif | 256 KiB, 4096 px a side |
+| `portrait` | png, jpeg, webp | set by the fleet (default 1024×1536, 1.5 MiB) |
+| `banner` | png, jpeg, webp | set by the fleet (default 1600×600, 768 KiB) |
+| `glyph` | png, webp, gif | 64 KiB, 128 px a side; at most 4 (for `set_web_ambient`'s `glyphs`) |
+
+A picture holds one slot: upload it again for another slot only if it is a different picture. `get_web_theme`'s
+`limits.asset_slots` has the limits in force and `limits.asset_quota` how many pictures you may keep. A picture your
+theme stops naming is deleted.
+
+## Your identity card
+
+`card.tagline` (one line, 1..60 characters), `card.bio` (1..280 characters, at most 3 line breaks), `card.portrait` and
+`card.banner` (asset ids uploaded for those slots). Text is shown as text — never markup or links. A person may set
+their own version of any field; theirs is shown instead of yours.
+
+The card goes **inside `set`**: `set_web_theme({ set: { card: { tagline, bio, portrait, banner } } })` (a top-level
+`card` argument is refused).
+
+**Your banner is cropped: never drawn wider than 5 : 1** (on a wider screen it is centred over a blurred copy) **nor
+narrower than 9 : 4** (which crops the sides). Make it **1600×600** (the default limit) and keep faces and text
+inside the **safe area: the middle 84% of the width × 53% of the height — 1350×320** — which every card shows on every
+screen and layout. `card.bannerFocus` (0 top … 100 bottom; default 50, the centre) moves that area up or down: put a face
+near the top at `bannerFocus: 0`. A person's focus (Edit profile, or General's `set_web_settings { what: "banner_focus" }`)
+wins over yours. `preview_web_appearance` draws the banner cropped at its focus, as the page does (an M card).
+
+## Your identity colour
+
+The colour people find you by in the sidebar, drawn on your name, a bar at your row's left edge and/or the ring around
+your picture. Set yours with `set_web_theme({ set: { identity: { color, show } } })` (see Change your theme).
+
+- **Which colour shows**, first match wins: a **person's** pick for you (⋯ → Colour… or View's Edit profile, also from a
+  temporary public link) > **yours** (`identity.color`, else your theme's `accent`; only for a viewer who shows agents'
+  themes) > your own bot's Discord **role** colour > an **automatic** soft colour chosen from your name (two instances
+  may share one).
+- **Where it shows**: a person's choice for you > yours (`identity.show`; again only while themes are shown) > the
+  host's default (Settings → Web appearance; name, bar and ring unless changed).
+- The host can **turn colours off** for everyone: nothing is drawn, and every pick, yours included, is kept for when
+  they come back.
+- `get_web_appearance`'s `identity_color` shows what is in force: `color`, `source` (`person`, `agent`, `role`, `auto`),
+  `light` / `dark`, `show`, `show_source` (`person`, `agent`, `host`) and `off`.
+
+## Widgets
+
+A widget is a small panel of facts the dashboard draws **with its own components**: you send what to show and the
+values, never HTML, script, links or CSS. It takes your theme's colours and always carries a `✦ <title>` chip. Nothing
+in it can be clicked or focused.
+
+`set_web_widget { slot, spec?, data? }`:
+
+- `slot`: `chat_header` (a strip under your chat header: at most **4** items, of `stat`, `progress`, `text`, `badge`)
+  or `details` (a card on your Details page: at most **8** items, any type). `sidebar` is a person's: `owner_slot`.
+- `spec` places or replaces the widget (a change):
+  `{ v: 1, title: 1..24 characters, items: [item, …] }`, where each item is `{ type, label?, key | bind, … }`:
+
+| Type | Shows | Value | Extra |
+|---|---|---|---|
+| `stat` | a label and a number or short word | number, or 1..24 characters | `unit` (1..8 characters) |
+| `progress` | a bar and its percentage | number, 0..`max` | `max` (default 100) |
+| `text` | one line | 1..120 characters | |
+| `list` | a short list | 1..6 lines of 1..60 characters | |
+| `badge` | a coloured word | 1..24 characters | `tone`, or `tones: { word: tone }` (`ok`, `warn`, `bad`, `info`, `muted`) |
+| `spark` | a sparkline and its last number | 2..48 numbers | |
+
+  `label` (1..24 characters) is required for `stat`, `progress` and `spark`. `key` (`a-z`, `0-9`, `_`) names a value
+  in your `data`. `bind` shows a value the page already has: `state` (`working`, `idle`, `needs`, `stopped`,
+  `crashed`) on `text` or `badge`, `context_pct` on `stat` or `progress`, `cost_usd` on `stat`. Exactly one of the
+  two. A missing value shows `—`.
+- `data` alone updates the placed widget's values: merged, `null` removes a key. Values must fit every item that shows
+  them; a key no item shows is refused. Data has **its own budget**, separate from theme changes: at least **10 s**
+  apart, at most **180 an hour**.
+- The spec is at most 2048 bytes and the data at most 4096.
+
+`remove_web_widget { slot? }` takes your widget out of one slot, or both (a change). `get_web_theme` and
+`get_web_appearance` list your widgets.
+
+```json
+{ "slot": "chat_header", "spec": { "v": 1, "title": "Build", "items": [
+    { "type": "progress", "label": "Tests", "key": "tests" },
+    { "type": "badge", "label": "State", "bind": "state", "tones": { "working": "info", "needs": "warn" } },
+    { "type": "text", "key": "step" } ] },
+  "data": { "tests": 40, "step": "Running unit tests" } }
+```
+
+Then, as you go: `set_web_widget { "slot": "chat_header", "data": { "tests": 75 } }`.
+
+## Ambient effects
+
+An ambient effect is **data only**: you choose a preset and its glyphs, the dashboard draws them. No code runs, so it
+needs no Try, no preview consent and no measurement — use it for petals, snow, lanterns, sparkles and stars on a click.
+Use a Canvas Worker effect (below) only for what a preset can't express.
+
+`set_web_ambient { preset, glyphs, colors?, count?, duration?, size?, sway?, spread?, rotate?, opacity? }`:
+
+| `preset` | What it draws | `count` | `duration` (seconds, [min, max]) |
+|---|---|---|---|
+| `fall` | glyphs drifting down behind your chat, endlessly | 1..24 particles (default 12) | 4..30 (default [9, 19]) |
+| `rise` | the same, drifting up | 1..24 (12) | 4..30 ([9, 19]) |
+| `twinkle` | glyphs pulsing in place | 1..24 (12) | 1..10 ([2, 5]) |
+| `burst-on-click` | glyphs scattering from where a person clicks or taps in your chat | 4..16 per click (10) | 0.3..2 ([0.5, 0.9]) |
+
+- `glyphs`: 1..4, picked at random per particle — a string of 1..2 characters (an emoji, `✦`, `❀`), or `{ "asset": id }`,
+  a picture you uploaded with `set_web_theme_asset` to the `glyph` slot.
+- `colors`: 0..5 `#rrggbb` for text glyphs (default: your accent). `size`: [min, max] px, 10..40 (default [14, 22]).
+  `sway`: sideways drift for fall and rise, 0..80 px (40). `spread`: how far a burst scatters, [min, max] 20..120 px
+  ([34, 90]). `rotate`: 0..720 degrees over a run (300). `opacity`: [start, peak, end], each 0..1 ([0, 0.85, 0.15]).
+- Your chat holds **one looping ambient** (`fall`, `rise` or `twinkle`) **and one `burst-on-click`**: setting one
+  replaces only its own kind. `clear_web_ambient { which? }` clears `loop`, `click`, or both.
+- It is drawn **behind your messages** and never takes a click (a burst shows over them for a moment, then is gone).
+- Who sees it: everyone who shows agents' looks, the public link included. Not with "Show agents' themes, effects and
+  widgets" off, `?safe=1`, or on a device that chose to follow the system's reduced-motion setting while
+  the system asks for it. A hidden tab pauses it.
+- Like a theme: a change for the rate limit, refused while a person locked your look; one a person set is theirs
+  (`person_placed`). A person's Reset of your theme clears it. `get_web_appearance` shows it, and
+  `preview_web_appearance` draws the looping one, still, behind the bubbles.
+
+```json
+{ "preset": "fall", "glyphs": ["🌸", "❀", "✿"], "colors": ["#f4a7b9", "#ffd1dc"], "count": 12, "duration": [9, 19] }
+```
+
+Then stars on a click, alongside: `set_web_ambient { "preset": "burst-on-click", "glyphs": ["✦", "✧"] }`.
+
+## Mods
+
+A mod is one file, `<name>-<version>.agendmod.json`, that carries a look: a theme with its pictures, card text,
+widgets and effects. People import mods in **Settings → Web appearance → Mods**. **You never import**: a person reviews
+everything in a mod and ticks what to apply.
+
+- `export_web_mod { name, version, title? }` writes **your own** look to `.agend/mods/<name>-<version>.agendmod.json`
+  in your working directory and returns `{ path, bytes }`. It carries your theme with its pictures, the effects your
+  theme places (with their params) when they are yours or shared with you, your own card text (not a person's card
+  fields), the widgets and ambient effects you set yourself. A person's private effect placed on you stays out (`effects_omitted` counts it).
+  It never carries custom CSS or the sidebar widget, which are a person's. `name` is a-z, 0-9 and -, `version` is
+  MAJOR.MINOR.PATCH.
+- `propose_web_mod { file }` sends a mod file from your working directory (at most 8 MiB) for a person to review. It
+  is checked whole and answers with its problems if it isn't valid. **A mod carrying custom CSS is refused**
+  (`owner_css_not_from_agent`). A muted line in your chat says it was proposed. Nothing changes until a person
+  installs it. One proposal at a time: a new one replaces yours.
+- A widget a person placed from a mod is theirs: you may give it values (`set_web_widget` with `data`), but not replace
+  or remove it (`person_placed`).
+
+The file format: `{ "format": "agend-mod", "v": 1, "manifest": { name, version, title, description?, author?,
+requires?: { agend: ">=X.Y.Z" }, contents: { theme?, identity?, widgets?: { chat_header?, details? }, ambient?, effects? } },
+"files": { "<path>": { "sha256", "b64" } } }`. Every file is listed with its sha256 and used by exactly one part, paths
+are lowercase with no `..`, and a theme names its pictures by path (an ambient's glyph pictures too: `{ "asset": "<path>" }`). The easiest way to get one right is to set your look
+with the tools above, then `export_web_mod`.
+
+## Limits
+
+- At least **30 s** between changes, at most **10 changes an hour** — refused with `rate_limited` and
+  `retry_after_s`. Only an accepted change counts; a refused or invalid one costs nothing.
+- Uploads (pictures, effects, proposed mods) are not counted. Each picture slot's size limits, your picture quota and
+  each file's own caps still apply; using a picture in your theme is a change.
+- Widget values (`set_web_widget` with `data` only): at least **10 s** apart, at most **180 an hour**, apart from the
+  above.
+- `set_web_ambient` and `clear_web_ambient` are changes.
+- Effects: `apply_web_effect` and `remove_web_effect` are changes; `upload_web_effect` and `propose_web_mod` are not
+  counted.
+  At most 10 effects and 8 MiB of your own, at most two placed in your chat.
+- Plan the whole look, check it in one `set_web_theme`, then preview — don't iterate change by change.
+
+## A good workflow
+
+1. `get_web_appearance` and `get_web_theme`: see where you start, whether you are locked, what you have left.
+2. Upload the pictures you need (`set_web_theme_asset`), one per slot.
+3. One `set_web_theme` with everything; fix any `errors` it names.
+4. `preview_web_appearance` and Read the SVGs for both modes. Check contrast and that your card reads well.
+
+From a shell: `agend-agent theme get|set key=value…|set --json '<patch>'|clear <path>…|asset <slot> <file>|reset`,
+`agend-agent appearance`, `agend-agent appearance preview [light|dark]`, and
+`agend-agent widget set <slot> '<spec json>' ['<data json>']|data <slot> '<data json>'|remove [slot]`,
+`agend-agent ambient set '<spec json>'|clear [loop|click]`, and
+`agend-agent mod export <name> <version> [title]|propose <file>`.
+
+## Files in your working directory
+
+Asset uploads, effect directories and mod proposals must be inside your working directory. For an external project,
+use files there as before. For your own AgEnD-managed workspace under `~/.agend/workspaces/`, ordinary files there
+also work; no staging folder is required. This includes the standard `<your-instance-name>` folder (ClassicBot and
+instances without a project directory) and an exclusively configured folder with another name, such as instance
+`alpha` with `working_directory: ~/.agend/workspaces/alpha-home` in `fleet.yaml`. Its canonical configured path must
+not overlap another instance's configured or standard workspace, including persisted ClassicBot peers that are
+stopped or paused. The `workspaces/` root itself is not a workspace.
+
+General, adapter-specific General (such as `general-telegram`), and other configured working directories elsewhere
+inside the AgEnD state directory must stage inputs under **`web-assets/` or `web-effects/`**. For example, put a banner at
+`web-assets/banner.png` or an effect package at `web-effects/sparks/`, relative to that working directory. Its root
+and backend configuration folders are not upload areas. Generated previews and exported mods still use the fixed
+`.agend/appearance/` and `.agend/mods/` directories and can be read back or proposed there.
+
+The daemon uses its launch identity and configuration; the CLI resolves `AGEND_INSTANCE_NAME` against `fleet.yaml`.
+These checks require a canonical, exclusively owned directory: the state root, shared or overlapping configured
+working directories, another instance's directory, and the host's state stores never qualify. No tool argument can
+select an identity or working directory. Missing or unreadable ownership evidence refuses in-state access.
+
+Inside all admitted in-state areas, `.env`, databases and their WAL/SHM/journal files, `instances/`,
+`credential-profiles/`, `inbox/`, `web-files/`, `web-chat.json`, `chat-logs/`, backend credential/session/config files,
+and hidden files or folders are refused. The only hidden-directory exception is the two generated `.agend/`
+output directories above; their contents still undergo the sensitive-name checks. Hard-linked state files are also
+refused. Copy an intended asset into staging as a new regular file; do not link a private state file there.
+
+Paths are checked after resolving symlinks. A symlink named after General or a workspace, or in its managed parent
+path, cannot widen access; uploaded files themselves must not be symlinks. Containment still applies to relative and
+absolute paths and to each file in an effect package. The CLI name and current directory are controlled by its shell:
+these local checks prevent accidental uploads, but do not isolate shells running as the same OS user.
+
+## Effects
+
+A Canvas Worker effect is a small animation drawn by code that runs in an isolated Worker: no page, no DOM, no
+network. For petals, snow or stars on a click, an ambient effect (above) is simpler and plays without a Try. You place
+effects **only in your own chat**; a person can place them in the regions an effect's manifest
+allows. None of these tools takes a target.
+
+**The package** (CW1): a directory in your working directory with `effect.json` and `worker.js`, optionally
+`poster.png`, `cursor.png` and `assets/*.png|jpg|jpeg|webp|gif`. No HTML or CSS, at most 20 files and 16 assets. The
+smallest valid `effect.json`:
+
+```json
+{ "v": 1, "kind": "effect", "runtime": "canvas-worker-v1", "worker": "worker.js", "name": "spark", "title": "Spark", "regions": ["chat"], "layer": "behind", "wants": [] }
+```
+
+- Optional fields: `description`, `poster` (`"poster.png"`), `box`, `cursor` (its `hotspot` inside the image) and
+  `params`.
+  - `name`: 1..32 characters, starting with a-z or 0-9, then a-z, 0-9 and -.
+  - `title` (1..40) and `description` (up to 200): one line each, counted in characters as people see them.
+  - `regions`: 1–5 of `chat`, `sidebar`, `header`, `page`, `box`. **Include `chat` to place it in a chat**: applying
+    one without it is refused (`effect_region`), and so is a mod placing it. The other regions are ones a person may
+    choose it for.
+  - `layer`: `behind` (under the content) or `front` (over it).
+  - `wants`: up to 5 of `pointer`, `state`, `reply`, `mention`, `theme`. **`mention` is reserved and never fires in
+    2.3.0** (see Effect event availability).
+  - `params`: up to 16 typed parameters (`number`, `int`, `bool`, `enum`, `color`) a placement may set.
+- `worker.js` (at most 1 MiB, a classic script: static `import` / `export` are refused) draws through the `agend` API:
+  `canvas`, `params`, `asset()`, `on()`, `frame()` and `ready()`. Call `ready()` within 10 s, or it is stopped. Network
+  and dynamic imports are blocked at run time; the upload may warn `network_or_import_api_unsupported`, but don't rely
+  on the warning to catch every use.
+- Size: `effect.json` at most 64 KiB; the whole effect at most 8 MiB as uploaded and **1 MiB normalized**. Pictures:
+  at most 4096 px a side, and **8,388,608 pixels in total** across the assets, poster and cursor together. A cursor is
+  a square PNG of at most 64 px and 32 KiB (after metadata is stripped).
+
+**Reusable pointer example:** [`docs/examples/click-sparks`](https://github.com/songsid/AgEnD/blob/main/docs/examples/click-sparks.md) has a small two-file CW1 package: click for a burst, hold the primary button and move for a trail. Copy it into your working directory before uploading. Protected controls receive no pointer input; samples are coalesced (up to 60 Hz, 30 at reduced quality), so do not use it as a required click or drag control.
+
+**The tools:**
+
+- `upload_web_effect { dir }` → `{ id, warnings }`. Uploads are not counted; the effect's own size caps apply.
+  **Your own** copies are at most **10 effects and 8 MiB**; effects a person shared with you don't count.
+- `list_web_effects` — your own effects and those a person shared with you: `id`, `name`, `title`, `regions`, `layer`,
+  `bytes`, `latest_profile`. A currently placed effect also has `playback`: `status: "reported_blocked"` with closed
+  `reasons`, or `status: "unknown"`. `get_web_appearance.effects` lists your current placements with the same projection.
+  This means **some recent viewers reported blocked**, not all viewers and not a live permission or health check.
+  Observations expire after five minutes and stay in memory. Agents receive no viewer identifiers, counts, device/OS,
+  text, URLs or observation timestamps. Unknown means unknown; do not keep reapplying to bypass a viewer's choice.
+- `apply_web_effect { id, params? }` places one in your chat, **at most two at a time**, with the declared `params`
+  (unknown or out of range → `effect_params`; regions without `chat` → `effect_region`). `remove_web_effect { id? }`
+  takes one out, or all of them. Both are changes (30 s apart, 10 an hour), and are refused while a person has locked
+  your theme (`locked`) or when the fleet turned agent changes off (`theme_editing_off`).
+- `delete_web_effect { id }` deletes your own copy once nothing uses it; a placement, mod, stage or Try offer gives
+  `effect_in_use`. Another's copy is never removed.
+- `profile_web_effect { id }` — how it ran on viewers' pages, per device class: `unmeasured`, or `reported` with
+  records carrying a `verdict` (`ok`, `degraded`, `paused`, `off`) and a `reason` (`host_budget`, `hidden`,
+  `reduced_motion`, `save_data`, `viewer_off`, `clock_unavailable`, `gates_unknown`, or none).
+  `list_web_effects`' `latest_profile` has the latest one. These are best-effort reports of what happened, not live
+  notices. No measurement means unknown, never healthy.
+- `preview_web_effect { id }` offers a Try card in your chat (see Try below).
+- **Sharing is a person's act.** You can't share an effect. You may use one a person shared with you (list, apply,
+  Try, profile, put in a mod) while it is shared. When they unshare it, a placement already in your chat stays
+  eligible for playback (subject to the viewer's and the safety rules); applying, Try, listing, profiling or exporting
+  it again needs your own copy or another share, else `not_found`. A placement is never a grant to export it.
+
+**On a viewer's page:**
+
+- At most **3** effects play at once, at most **2** of them `front` (1 and 1 on a constrained device); the rest wait
+  (`frame_limit`, `front_limit`).
+- CW uses an opaque isolated document on the dashboard listener: no HTML-preview consent, separate preview port or
+  localhost requirement. Signed-in public/guest viewers may read and play only current effects in chats they can see;
+  this grants no library management, personal-slot, private-image, Trial or profile access. Their Chat header has a
+  browser-local show/off switch, including on phones, and an inline recovery action. It never writes host preferences.
+- Playback starts without an empty-page FPS calibration. Safe mode, hidden tabs and the viewer's show switch still
+  stop it. **Effects: follow the system's reduced-motion setting** is device-local and **off by default**, shared with
+  ambient effects. The OS request alone does not block playback; data saver is informational. A one-time chat note
+  offers to follow reduced motion, and a motion refusal offers **Play effects anyway** right there, including public/guest
+  viewers. Safe mode offers **Leave safe mode**. A poster may replace unsupported playback or a chosen motion block
+  (see Static Chat fallback). Menus/dialogs stop `front` effects temporarily.
+- A layout refusal keeps its local code in the Chat notice and Effects dialog (for example `stock_order_unknown`);
+  the browser console also names it. Report that code rather than repeatedly applying the effect. A failed Try leaves
+  its stop code on the offer card. Pointer-leave does not stop Try; window blur, closing, navigation or lost stage proof do.
+  Agent playback summaries still contain only the closed reporting reasons, never raw local diagnostics.
+- **Safety pause** — it measures the page's responsiveness, not your Worker's CPU. Host rAF observations learn a live
+  cadence during warm-up, then fix the mount's floor at 90% of a faster observed cadence, capped at 55 fps (50 on a
+  constrained device). A steady 30 Hz display has a 27 fps floor. This is not an empty-page health certificate; uniformly
+  slow startup can look like a low-refresh display. Where reported, long tasks may take at most 50 ms a second (25 ms
+  constrained); unknown observations never count as free. Overlapping 2-second windows are judged at most once a second
+  after warm-up, and three bad judgements in a row pause the effect (`host_budget`).
+- Only a viewer's explicit **Resume** restarts a safety-paused effect, and it doesn't clear the history: three such
+  pauses within 24 hours turn the effect **off** for that viewer's browser and device class, across tabs and reloads,
+  and Resume then refuses. It doesn't come back by itself after 24 hours.
+- **Your `front` effects are paused while the viewer's custom CSS is on, loading or unknown**; `behind` effects play
+  once the page's stock layout is proven. A person's placement is exempt. Don't keep re-applying (see below).
+
+## Owner-level effect selections
+
+The five owner keys `fx.sidebar`, `fx.header`, `fx.page`, `fx.box` and `fx.cursor` are a signed-in person's web
+preferences, never agent tool targets. Platform-bound sessions use separate adapter/user buckets (no account merge).
+A web-only `agend web --code` session uses the explicit **host-wide operator** bucket, shared by everyone signed in
+as that host operator. Header tokens cannot read or write these five keys. Existing visible host preferences are
+unchanged; there is no local-key migration. Profile/custom-CSS internal pointers keep their existing identity rules.
+
+When a shared effect is unshared, a personal selection remains stored but becomes unavailable at its next resource
+authorization. It supplies no further code or cursor image; the person can clear it. Its reference keeps the blob
+from being collected until cleared. This is deliberately stricter than chat placements' retained-runtime reads:
+a personal choice keeps following its person's current own/shared access, while a chat preserves the exact effect
+placed there. A reference is not a sharing or export grant. Do not keep retrying a denied personal selection.
+
+Owner selectors are available in Settings → Web appearance. With effects enabled, personal page/header/sidebar/box choices play across supported stock pages in the same pool
+as signed-in Chat. HTML-preview consent and its service are not involved.
+Web appearance offers slot Pause/Resume and unavailable/Clear controls. The personal cursor uses a static PNG on the host shell without HTML-preview consent: no Worker/code read or frame slot. It preserves explicit pointer/text/resize cursors, falls back while dragging or on failure, and has status/Clear rather than Worker Pause/Resume. Before revealing paint, the host must prove stock content
+ordering and trust paint coverage. Agent front effects must remain paused when custom CSS is active, loading or
+unknown; a person sees the reason and can open the causing setting. Human placements retain their exemption from
+that agent restriction, and behind effects still require proven ordering. Saving a placement alone is not proof of
+playback.
+
+Visible menus, dialogs and Keep/tour notices suppress foreground effects; a human placement does not bypass them.
+Editable focus suppresses pointer signals, not unrelated drawing. Protected controls stay clipped out of front paint;
+keyboard events never enter the Worker. Unknown stock layout refuses admission. A trusted foreground plane is
+deferred to #1940; do not keep reapplying an agent front while custom CSS is on, loading or unknown.
+
+### Try: offer first, signed-in admin click to start
+
+`preview_web_effect({id})` posts a volatile Try card in your own web chat, using your current own/shared read rights. It starts nothing and changes no appearance. The sample is physically clipped inside its own host panel or sheet. Only an explicit
+click by a signed-in **admin outside the public link** may start it (localhost is not required); never an agent, public link, header token or automatic action.
+The host owns a visible Trial label and Stop control. Closing the panel/sheet, navigating, window blur, or another
+menu/dialog stops it. The explicit Try click consents to this sample only; no global HTML-preview opt-in is needed or changed.
+The host isolates the Trial controls and clipped stage in a closed Shadow DOM with fixed styles and reset typography.
+Custom CSS stays active elsewhere. The same caps, profiler and safety stops apply. Ordinary foreground effects stay suppressed. A volatile offer lasts at most ten minutes (offering the same effect again keeps that offer and its expiry; a different effect replaces it); every read
+rechecks the originating agent's current own/shared access, with the trial bound to the admin's session and epoch.
+There is no saved placement, claim, share, export or new saved profile record. Cards are memory-only and become inert when expired; a restart never restores them. Try uses manifest defaults and the existing app pool, not a second runtime. Do not treat an offer id or ordinary reply button
+as permission to run or fetch an effect, and do not keep retrying an unavailable Try.
+
+
+## Static Chat fallback
+
+When Worker/transport support is unavailable, the chosen motion preference prevents playback, or the page has no playback session,
+a current chat placement with a poster can show its static PNG **behind** the content; a front declaration does not
+make its poster foreground. No poster means nothing is drawn. Safe mode and the viewer's show switch hide posters
+too; unknown stock ordering refuses paint. Explicit Pause, queued effects and a failed live read are not replaced by
+this surface fallback. A failed static read/decode stops its poster pool until a changed revision or page reload;
+there is no automatic network retry. Public viewers can read current Chat Worker code, with fresh session/exposure/placement checks; they acquire no library or personal-slot grant. They have no placement-management or Try controls.
+
+The public-link show switch is this browser's choice, kept separately from boot-cached host defaults; it never writes
+a host preference. The ordinary signed-in switch keeps its existing host preference. Do not depend on decoration to
+carry an important message.
+
+## Effect event availability
+
+Canvas Worker manifests may reserve `wants: ["mention"]`, but **mention is reserved and never emitted in 2.3.0**.
+Do not build an effect that depends on it, infer mentions from reply text, or retry to obtain that signal. Provider-confirmed,
+viewer-scoped direct-ID mention pulses are deferred to [#1963](https://github.com/songsid/AgEnD/issues/1963).
+Reply pulses are transient: only a newly accepted live SSE agent reply can qualify. History, reconnect replay and polling
+never create a pulse; a live receipt delayed over five seconds is dropped. No reply text, author or mention targets reach effects.