OXYGENHUB
# f993f792537e oxygenhub / docs / backgrounds.md
12.4 KiB · Markdown · last changed feat(web): the mark, ripples, the swarm and adrift (closes #167) 22 days ago renderedsource blame history raw
1
# Backdrops: living backgrounds for OxygenHub
2
3
Status: every scene in §2 is built (2026-10-13): Your sky (oxygenhub#157),
4
the hub's sky (#165), and the mark, ripples, the swarm and adrift (#167).
5
6
## 1. What a backdrop is
7
8
A backdrop is a quiet, moving picture behind a page's content: a field of
9
small marks that drift slowly and respond a little to the cursor. It
10
gives the hub a sense of motion and depth without asking for attention.
11
12
Three rules shape everything else:
13
14
1. **True, not invented.** The footer says "nothing here is inferred:
15
   what a page says, the object store says". A backdrop keeps that
16
   promise. Every mark stands for something real the viewer may see: one
17
   of their repositories, a change, a push, a runner. Nothing is made-up
18
   decoration that only looks like data, such as fake chunks or fake
19
   peers.
20
2. **Behind, never in the way.** Content is opaque cards on top. A
21
   backdrop shows only in the margins and the gaps between cards. It never
22
   takes a click, never moves the layout, and is never needed to read or
23
   use the page.
24
3. **Cheap and polite.** It costs well under a millisecond a frame. It
25
   stops when the tab is hidden, and it is still for people who ask for
26
   reduced motion. Anyone can turn it off.
27
28
## 2. Which pages
29
30
| Page | Scene | Shows |
31
|---|---|---|
32
| Dashboard | **Your sky** (§5) | Your repositories as clusters; their activity in the last 30 days as the marks around them |
33
| Signed-out home, Explore | **The hub's sky** | The same scene from the public repositories listed, up to 40, the most recently active; a filter narrows it. Never a private repository, whoever looks |
34
| Sign in, register, device sign-in | **The mark** | The Oxygen mark's two rings with marks orbiting them; brand only, no data |
35
| A repository's Diffusion tab | **Ripples** | The upstream and its consumers as the Diffusion mark draws them: a pulse goes out on a bump, green or red as its run ends |
36
| Admin › Runners › Images | **The swarm** | Runners as nodes; chunks moving between them while an image is fetched, from the swarm tracker's live state |
37
| Not found, server error | **Adrift** | One mark drifting away from the rest |
38
39
**Never:** code, file, blame, diff, conflict and proposal pages, the
40
editor, issues and proposals while being written, settings and admin
41
tables. Those pages are for reading closely, and motion behind them
42
costs attention. Repository overviews have none for the same reason;
43
their README is the picture.
44
45
Each scene is its own issue, done one at a time, the dashboard first.
46
47
## 3. Colours
48
49
A backdrop takes its colours from the page's own tokens, so it is right in
50
both looks (GitHub, the default, and classic) and in both themes (light,
51
the default, and dark), and it follows a theme switch at once. Three new
52
tokens join each look's light and dark sets:
53
54
| Token | Use | GitHub light | GitHub dark | Classic (dark) |
55
|---|---|---|---|---|
56
| `--bd-mark` | a resting mark | `--mute` at 16% | `--mute` at 14% | `--acc` at 12% |
57
| `--bd-lit` | a mark near the cursor | `--acc` (#0969da) at 70% | brand cyan #00F0FF at 75% | #00F0FF at 85% |
58
| `--bd-link` | a line between lit marks | `--acc` at 22% | #00F0FF at 28% | #00F0FF at 35% |
59
60
Two more colour rules:
61
62
- **The brand gradient (#00F0FF → #0072FF)** is kept for moments: a new
63
  push arriving, the mark scene. A whole field in it would shout.
64
- **Status colours are used only where the data has a status:** the
65
  Diffusion pill's green, amber and red, and a run's outcome. They never
66
  appear as decoration.
67
68
In light mode a backdrop must be barely there: if you notice it before the
69
content, it is too strong. The contrast test (`tests/contrast.rs`) gains a
70
check that `--bd-mark` stays under 1.3:1 against `--bg`.
71
72
## 4. Motion and the cursor
73
74
- **Drift.** Marks move slowly, at most 12 px a second, along gentle
75
  streams around their cluster. Two streams can cross: their marks pass
76
  each other without touching, and the change in order means nothing.
77
  That is how Oxygen's changes behave, which is where this comes from.
78
- **The cursor lights, it does not pull.** Marks within about 140 px of
79
  the cursor light up in `--bd-lit`, ramping in over 150 ms and fading
80
  out over 600 ms. Nothing is attracted or pushed, so the cursor never
81
  rearranges the picture.
82
- **Lines mean something.** Among the lit marks, a faint line joins two
83
  marks only when they belong together in the data: events of the same
84
  repository that happened one after another and sit within 70 px of
85
  each other, so a busy repository reads as a constellation, not a
86
  scribble. Lines fade as the cursor moves on or rests for 2 s.
87
- **Labels, sparingly.** When the cursor rests near a cluster, its name
88
  fades in just above the cluster's outer ring in `--mute`, small. This is the only text a backdrop
89
  draws, and it is never a link; the dashboard's own list is the link.
90
- **Parallax.** Three depth layers shift by at most 6 px, 3 px and 1 px
91
  against the cursor's offset from the page's centre. That gives a little
92
  depth with no feeling of motion sickness.
93
- **Streams.** Where a scene shows something travelling (Diffusion's
94
  changes, the swarm's chunks), dots move along a gentle arc at 40 px a
95
  second, faster than drift, fading in and out at the ends.
96
- **Arrivals.** When the page learns of new activity, its mark appears
97
  with one soft ring in the brand gradient that widens and fades over
98
  1.2 s. This is the one moment a backdrop may draw the eye, and only
99
  briefly.
100
101
## 5. The dashboard: Your sky
102
103
**Data.** The dashboard handler already loads your repositories and the
104
activity feed from the database. The backdrop needs a little more of the
105
same:
106
107
- the repositories in Your repositories, by name;
108
- up to 1,500 events from the last 30 days across them (pushes,
109
  proposal and issue events, releases, Flow runs), each with its
110
  repository, kind and time, and for a push the number of changes it
111
  brought. A push draws one dot for each change, up to 40, and the sky
112
  draws up to 3,000 marks.
113
114
The handler embeds these as JSON in the page (`<script
115
type="application/json" id="backdrop">`), so the backdrop costs no
116
second request and never reads a repository's store. That matters:
117
some stores are slow, such as GCS-backed ones. Private repositories
118
appear only for viewers who may see them, exactly as the list beside
119
them does.
120
121
**Layout.**
122
123
- Each repository is a cluster. The clusters fill the margins beside the
124
  content column, which the page marks with `data-backdrop-avoid`: in the
125
  order of their names' hashes, split between the two sides by their
126
  widths, each side a staggered grid from top to bottom. The same
127
  repositories in the same window always land in the same places. Where
128
  a margin is under 180 px, they sit on a ring around the page instead.
129
- Marks and orbits are drawn at 1.4 times their first size, with orbit
130
  lanes close together, so each repository is a tight knot (Andy,
131
  2026-10-13).
132
- The most active repositories sit in the front layer and the quiet ones
133
  further back.
134
- A cluster's events are its marks: today's are brightest and a month
135
  old are faint.
136
- Kinds differ by shape, not colour: a change pushed is a dot, a
137
  proposal event a small diamond, an issue event a ring, a release a
138
  four-point star, a Flow run a small square, and the repository itself a
139
  thin ring at the cluster's core.
140
- A busy repository gets more orbit lanes (6 to 14), so its marks spread
141
  out instead of piling up.
142
143
**Live.** When the page learns of new activity (it already polls for the
144
notification count), the event joins its cluster with an arrival ring
145
(§4). Nothing reloads.
146
147
## 5.1 The other scenes
148
149
- **The mark** (sign in, register, device sign-in): 560 dots on the
150
  Oxygen mark's two rings, centred on the page, turning opposite ways at
151
  9 px a second at the rim, so the stream runs through the middle like
152
  the mark's infinity; each ring has its core. Each ring's dots are
153
  linked in the order round it. Nothing is named.
154
- **Ripples** (a repository's Diffusion tab): the repository in the left
155
  margin with its upstreams beside it, its consumers in the right margin,
156
  each a ring of 18 dots about a thin-ring core in the tone of its
157
  Diffusion pill (the upstream's half for an upstream, the consumer's own
158
  half for a consumer). Ten dots a stream flow from each upstream to the
159
  repository and from it to each consumer, in the stream's tone, and a
160
  ring of 40 dots widens from the repository every 5 s over 3.2 s (never
161
  when still). Names: every repository.
162
- **The swarm** (Admin › Runners › Images, now in the standard width so it
163
  has margins): the hub in the left margin, the runners in the right,
164
  each ringed by a dot for every image it holds; while a runner fetches
165
  an image, 8 small squares a stream (chunks) flow to it from every
166
  holder, the hub's streams bowed one way and peers' the other, up to 40
167
  streams. Names: the hub and each runner.
168
- **Adrift** (not found, and server errors; never a refusal or a bad
169
  request): a cluster of 70 dots in the left margin and one larger mark
170
  leaving it up and to the right at 7 px a second, fading after 70 s and
171
  setting out again.
172
173
Every scene is a `Scene` (`crates/backdrop/src/scene.rs`); all but the
174
sky share `field.rs`: dots placed by their scene each frame, lit by the
175
cursor, joined within a group, named on rest, coloured from the backdrop
176
tokens or, where the data has a status, the page's `--ok`, `--warn` and
177
`--bad`. The page names its scene in `#backdrop-data`
178
(`{"scene": "mark"}`); none means Your sky.
179
180
## 6. Engine
181
182
The engine is Rust compiled to WebAssembly (Andy's choice, 2026-10-13):
183
`crates/backdrop`, a workspace of its own outside the hub's. `sky.rs` is
184
the scene with no browser in it, tested natively; `gl.rs` draws it;
185
`lib.rs` is the browser glue. `make backdrop` builds it for
186
`wasm32-unknown-unknown` and runs `wasm-bindgen --target web` into
187
`assets/backdrop/` (about 288 KB of wasm, 84 KB gzipped, with every scene, and the glue),
188
which is committed and embedded in the hub, as `make ts` commits the API
189
types, so neither the hub build nor its offline CI needs the wasm
190
toolchain. `make backdrop-check` runs its fmt, clippy (wasm32) and tests.
191
192
- **Drawing.** WebGL2 with instanced quads for marks (one draw for all,
193
  each shape a signed distance in the fragment shader) and one line
194
  buffer for links. Without WebGL2 there is no backdrop, and nothing
195
  breaks.
196
- **The canvas.** One fixed full-viewport `<canvas aria-hidden="true">`
197
  behind `main`, with `pointer-events: none`. Its device pixel ratio is
198
  capped at 1.5.
199
- **Frame rate.** It runs at 60 fps while the cursor moves, eases to
200
  30 fps when the cursor is still, and pauses on `visibilitychange`.
201
  After 2 minutes without input it draws one last frame and stops until
202
  the next movement.
203
- **Reduced motion.** With `prefers-reduced-motion: reduce` it draws one
204
  still frame with no drift, parallax or arrival rings; lit marks still
205
  respond, instantly.
206
- **Budget.** Under 1 ms of script a frame on a 2020 laptop, checked
207
  with the browser's performance panel before each scene ships.
208
- **Scenes are data.** A scene is a preset of layout, shapes, counts and
209
  which data it reads; the engine is shared.
210
211
**Why Rust and WASM.** A small script would have done for a few hundred
212
marks; Rust keeps the whole of Oxygen in one language, lets the scene be
213
tested like the rest, and is ready for scenes with heavy layout (a
214
repository's full change graph) where sharing oxy-core's own types would
215
pay. The cost is kept out of the hub's build by committing the output.
216
217
## 7. The viewer's choice
218
219
Settings › Appearance gains **Background: Moving (default), Still, Off**,
220
kept in a `backdrop` cookie read before first paint, like the theme
221
cookie, so a page never flashes a backdrop it should not have. Still draws
222
the reduced-motion frame. `Save-Data: on` and a pointer that is coarse
223
only (a phone) default to Still.
224
225
## 8. Order of work
226
227
1. The engine and the dashboard's Your sky, with the tokens, the
228
   setting and the contrast check (the next issue).
229
2. Signed-out home and Explore (the same scene, public data).
230
3. Sign in and register (the mark).
231
4. Diffusion ripples.
232
5. The swarm on Admin › Runners › Images.
233
6. Adrift on error pages.
234
235
## 9. Open questions
236
237
- Should a cluster's lit marks show the event's title on rest, as a
238
  tooltip would? It is useful, but it is more text in the background.
239
  For now, no: the activity list beside them has the titles.
240
- Organisation pages could have their own sky (the organisation's
241
  repositories). That is cheap once Your sky exists.