diff --git a/AGENTS.md b/AGENTS.md index 13ca7cbd..b7da426a 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -29,6 +29,10 @@ Outside the dev shell, such as in Pullfrog's job, which puts the shell's tools o `README.md` is the user guide. A change to what a user does (flags, panels, the scene file, outputs) updates it in the same PR. +Keep the window simple. +A PR that adds visible UI says in its body why most streamers need it. +A feature most won't use is a mod in Settings > Mods, off by default and absent from every page, menu, hotkey list, and the palette until enabled. + `just shots` renders named views of the window to PNG with no display, on Linux (the table in `rs/moq-studio/src/shots.rs`). A PR that changes what the window shows adds a view for each page or state it builds, and shows the views it changes in its body, beside the mock-up frames they implement. To host them, convert the views to lossy WebP (`cwebp -q 80`), commit them in a commit of their own, link them by that commit's SHA, and delete them in the next commit. diff --git a/quest/m0/ux/README.md b/quest/m0/ux/README.md index 4d277941..e8515657 100644 --- a/quest/m0/ux/README.md +++ b/quest/m0/ux/README.md @@ -90,6 +90,11 @@ shows those pictures beside the frames they implement. - **Milestones:** ✅ redesigning what exists is m0, here. Features that do not exist yet are [m1](/quest/m1/README.md), and three more are [m2](/quest/m2/README.md) (rejected: all in m0; all in m1). +- **Mods:** ✅ features most streamers never use are off until switched on + in Settings > Mods, and absent from every page until then: Both formats, + Studio mode, Multiview, Phone remote, Published scenes, and Scene graph + (rejected: leaving them on the pages and in Advanced). Decided 2026-11-20 + (maintainer, /quest-plan); see [Mods](/quest/m0/ux/mods.md). - **Dropped:** a rundown that fills overlays, one-click looks and a brand kit, active-speaker layouts, control surfaces, and a rehearsal mode. Not planned. @@ -106,7 +111,7 @@ program's card is the live picture. | Scene pads with live thumbnails | MIX: every strip, sends, filters, delay | Where the stream goes, keys, failover | | A meter and a mute for each sound on air | REVIEW: replay, clips, recordings | Recording folder and contents | | The live control, health dot, and record | Health details, from the health dot | Hotkeys, virtual camera, guests' room | -| The panic key | Guests, from Add | Effects, published scenes, the scene graph, edit history | +| The panic key | Guests, from Add | Edit history; Mods: both formats, Studio mode, multiview, phone remote, published scenes, the scene graph | ### The frames diff --git a/quest/m0/ux/effects-picker.md b/quest/m0/ux/effects-picker.md new file mode 100644 index 00000000..210bc475 --- /dev/null +++ b/quest/m0/ux/effects-picker.md @@ -0,0 +1,16 @@ +# [S] Delete the Effects picker + +## Goal + +The **Effects** setting (Full, Reduced, Off) in Settings > Advanced is gone. +The window's effects always follow the system's reduced-motion setting, as +they already do until a user picks one. The effects themselves stay. + +## Plan + +Decided 2026-11-20 with the maintainer (/quest-plan): ✅ delete it (rejected: +moving it to Mods). It's a setting nobody looks for, and the system setting +already covers reduced motion on macOS, Windows, and Linux. + +Remove the stored `"effects"` choice from app storage, the picker and its row, +and the README's sentence about it. diff --git a/quest/m0/ux/mods.md b/quest/m0/ux/mods.md new file mode 100644 index 00000000..d68fcb66 --- /dev/null +++ b/quest/m0/ux/mods.md @@ -0,0 +1,75 @@ +# [L] Mods: features most streamers never use, off until enabled + +## Goal + +A new Settings pane, **Mods**, lists features most streamers never use, each +off by default: Both formats, Studio mode, Multiview, Phone remote, Published +scenes, and Scene graph. While a mod is off, no page, toolbar, menu, hotkey +list, palette, or Settings pane shows it. Switching it on shows its UI at +once, with no restart. All six are compiled into the binary. A mod is not a +plugin: there is no plugin API, no cargo feature flags, and nothing to +install. + +Settings > Advanced is gone: Published scenes and Scene graph move to Mods, +the Virtual camera toggle moves to Settings > Stream, and the Effects picker is +deleted by [its own quest](/quest/m0/ux/effects-picker.md). + +## Plan + +Decided 2026-11-20 with the maintainer (/quest-plan). The goal is simplicity: +the window a new streamer sees holds only what most streamers use. + +- **Pane name:** ✅ Mods (rejected: Extras, Features). The maintainer's word, + even though these are built-in features rather than add-ons. +- **Which:** ✅ Both formats (portrait and dual format: the Format cards and + Both at once in Settings > Show, the format chips, and portrait + arrangements), Studio mode (the cue/take switch, NEXT, TAKE, AUTO, and their + hotkeys and palette entries), Multiview (the show-menu and palette entries + and the window), Phone remote (the Remote pane and the phone page), Published + scenes (scene sizes, publishing a scene or source as its own broadcast, the + inspector's Publish, and the per-scene virtual camera toggles), and Scene + graph (the window and its palette entry) (rejected: Keyframes and Keep out of + the way, which show only for a selected layer and cost nothing until used). +- **Storage:** ✅ per user, in the app storage beside hotkeys and Studio mode + (rejected: per show file, since Studio mode, Multiview, and Phone remote are + about how the operator works, not about the show; refusing a show that uses + a disabled mod). Opening a show that uses a disabled mod, such as one whose + scene file has portrait on or a published scene, switches that mod on, so a + mod's UI is never hidden while its feature affects the output. +- **Switching off:** ✅ switching off a mod turns its feature off (rejected: + refusing until the feature is off; only hiding the UI). Show edits, such as + Both formats dropping portrait-only layers or unpublishing a scene, go + through undo like the feature's own switch. Phone pairings are kept but stop + working until the mod is back on. On air, it asks what the feature's own + switch already asks, such as "Restart the video?", and adds no dialog of its + own (rejected: confirming every switch-off; no prompt even on air). An open + Multiview or graph window just closes. +- **Advanced:** ✅ the Virtual camera toggle moves to Settings > Stream and the + Advanced pane is deleted (rejected: Virtual camera as a seventh mod; keeping + Advanced for one row). +- **Shape:** one definition per mod (its name and help line), consulted where + each entry point is drawn. Keep it as small as a set of flags in app storage; + no registry or trait unless the code asks for one. + +Also in this PR: + +- `quest/m0/ux/mock/settings.html` gets a Mods pane in place of Advanced, and + its frames are re-rendered, as the [UX epic](/quest/m0/ux/README.md) + requires of a child that departs from a mock-up. +- `README.md` gains a Mods section and tells each mod's section to enable it + first; Settings > Advanced references move. +- `just shots` gains a view of the Mods pane, and the views of each mod's UI + enable that mod. +- The try quests that exercise a mod say to enable it first: + [dual format](/quest/m1/dual-format-check.md), + [multiview](/quest/m1/try-multiview.md), + [phone remote](/quest/m2/try-phone-remote.md), and the pane list in + [Try the Settings window](/quest/m0/ux/try-settings.md). + +## Required + +- [Delete the Effects picker](/quest/m0/ux/effects-picker.md) - empties Advanced of the row that has no other home + +## Related + +- [Broadcaster UX](/quest/m0/ux/README.md) - the "In Settings" column this changes