bevy_window_manager 0.20.1

Bevy plugin for primary window restoration and multi-monitor support
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
{
  "platform": "linux",
  "example_ron_path": "~/.config/bevy_window_manager/restore_window.ron",
  "test_ron_dir": "tests/config/ron/linux",

  "tests": [
    {
      "id": "wayland_size_restore_mon0",
      "description": "Size persistence on Monitor 0 (position not available on Wayland)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 0,
      "ron_file": "size_restore_mon0.ron",
      "mutation": {
        "target_monitor": 0,
        "size": [1200, 1000]
      },
      "windows": {
        "primary": {
          "validate": ["size", "mode", "monitor_index"]
        }
      }
    },
    {
      "id": "wayland_borderless_0_0",
      "description": "Borderless fullscreen restore to Monitor 0 (same monitor)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 0,
      "ron_file": "fullscreen_borderless_to_mon0.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "wayland_borderless_0_1",
      "description": "Borderless fullscreen restore to Monitor 1 (cross monitor)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 0,
      "ron_file": "fullscreen_borderless_to_mon1.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "wayland_exclusive_fallback_0_0",
      "description": "Exclusive fullscreen falls back to borderless on Wayland (same monitor)",
      "note": "Cross-monitor variant not needed - borderless cross-monitor already tested, and exclusive->borderless fallback is the same code path regardless of monitor",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 0,
      "ron_file": "fullscreen_exclusive_to_mon0.ron",
      "expected_log_warning": "Exclusive fullscreen is not supported on Wayland, restoring as BorderlessFullscreen",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"],
          "expected_mode": "BorderlessFullscreen"
        }
      }
    },

    {
      "id": "wayland_multi_window_0_0",
      "description": "Primary on Monitor 0, secondary on Monitor 0 (Wayland)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 0,
      "ron_file": "multi_window_0_0.ron",
      "windows": {
        "primary": {
          "validate": ["size", "monitor_index", "mode"]
        },
        "window-1": {
          "spawn_event": "restore_window::SpawnManagedWindow",
          "validate": ["size", "monitor_index", "mode"]
        }
      }
    },

    {
      "id": "wayland_persistence_remember_all",
      "description": "RememberAll mode preserves unspawned window entries in RON after shutdown (Wayland)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 0,
      "ron_file": "multi_window_0_0.ron",
      "windows": {
        "primary": {
          "validate": ["size", "monitor_index", "mode"]
        }
      },
      "persistence_validation": {
        "mode": "RememberAll",
        "expected_ron_keys": ["primary", "window-1"]
      }
    },

    {
      "id": "wayland_persistence_active_only",
      "description": "ActiveOnly mode prunes unspawned window entries from RON after shutdown (Wayland)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 0,
      "ron_file": "multi_window_0_0.ron",
      "windows": {
        "primary": {
          "validate": ["size", "monitor_index", "mode"]
        }
      },
      "persistence_validation": {
        "mode": "ActiveOnly",
        "expected_ron_keys": ["primary"],
        "unexpected_ron_keys": ["window-1"]
      }
    },
    {
      "id": "wayland_size_restore_mon1",
      "description": "Size persistence on Monitor 1 (position not available on Wayland)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 1,
      "ron_file": "size_restore_mon1.ron",
      "mutation": {
        "target_monitor": 1,
        "size": [1000, 700]
      },
      "windows": {
        "primary": {
          "validate": ["size", "mode", "monitor_index"]
        }
      }
    },
    {
      "id": "wayland_borderless_1_0",
      "description": "Borderless fullscreen restore to Monitor 0 (cross monitor)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 1,
      "ron_file": "fullscreen_borderless_to_mon0.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "wayland_borderless_1_1",
      "description": "Borderless fullscreen restore to Monitor 1 (same monitor)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 1,
      "ron_file": "fullscreen_borderless_to_mon1.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "wayland_exclusive_fallback_1_1",
      "description": "Exclusive fullscreen falls back to borderless on Wayland (same monitor)",
      "note": "Cross-monitor variant not needed - borderless cross-monitor already tested, and exclusive->borderless fallback is the same code path regardless of monitor",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 1,
      "ron_file": "fullscreen_exclusive_to_mon1.ron",
      "expected_log_warning": "Exclusive fullscreen is not supported on Wayland, restoring as BorderlessFullscreen",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"],
          "expected_mode": "BorderlessFullscreen"
        }
      }
    },

    {
      "id": "wayland_multi_window_1_1",
      "description": "Primary on Monitor 1, secondary on Monitor 1 (Wayland)",
      "automation": "full",
      "backend": "wayland",
      "launch_monitor": 1,
      "requires": {"min_monitors": 2},
      "ron_file": "multi_window_1_1.ron",
      "windows": {
        "primary": {
          "validate": ["size", "monitor_index", "mode"]
        },
        "window-1": {
          "spawn_event": "restore_window::SpawnManagedWindow",
          "validate": ["size", "monitor_index", "mode"]
        }
      }
    },
    {
      "id": "x11_pos_size_restore_mon0",
      "description": "Basic position/size persistence on Monitor 0 (eDP)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 0,
      "workaround_keys": ["W5", "W6"],
      "ron_file": "position_size_restore_mon0.ron",
      "mutation": {
        "target_monitor": 0,
        "position_offset": [300, 250],
        "size": [1200, 800]
      },
      "windows": {
        "primary": {
          "validate": ["position", "size", "mode", "monitor_index"]
        }
      },
      "workaround_validation": {
        "feature_flag": "workaround-winit-4445",
        "build_without": "--no-default-features --features workaround-winit-4440,workaround-winit-4443",
        "build_with": "",
        "without_behavior": "Position drifts by title bar height (~56px at scale 2) on save/restore",
        "with_behavior": "Position saved correctly with frame extent compensation"
      }
    },
    {
      "id": "x11_borderless_0_0",
      "description": "Borderless fullscreen restore to Monitor 0 (same monitor)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 0,
      "ron_file": "fullscreen_borderless_to_mon0.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "x11_borderless_0_1",
      "description": "Borderless fullscreen restore to Monitor 1 (cross monitor)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 0,
      "ron_file": "fullscreen_borderless_to_mon1.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "x11_exclusive_0_0",
      "description": "Exclusive fullscreen restore to Monitor 0 (same monitor)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 0,
      "ron_file": "fullscreen_exclusive_to_mon0.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "x11_exclusive_0_1",
      "description": "Exclusive fullscreen restore to Monitor 1 (cross monitor)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 0,
      "ron_file": "fullscreen_exclusive_to_mon1.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },

    {
      "id": "x11_multi_window_0_0",
      "description": "Primary on Monitor 0, secondary on Monitor 0 (X11)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 0,
      "ron_file": "multi_window_0_0.ron",
      "windows": {
        "primary": {
          "validate": ["position", "size", "monitor_index", "mode"]
        },
        "window-1": {
          "spawn_event": "restore_window::SpawnManagedWindow",
          "validate": ["position", "size", "monitor_index", "mode"]
        }
      }
    },

    {
      "id": "x11_persistence_remember_all",
      "description": "RememberAll mode preserves unspawned window entries in RON after shutdown (X11)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 0,
      "ron_file": "multi_window_0_0.ron",
      "windows": {
        "primary": {
          "validate": ["position", "size", "monitor_index", "mode"]
        }
      },
      "persistence_validation": {
        "mode": "RememberAll",
        "expected_ron_keys": ["primary", "window-1"]
      }
    },

    {
      "id": "x11_persistence_active_only",
      "description": "ActiveOnly mode prunes unspawned window entries from RON after shutdown (X11)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 0,
      "ron_file": "multi_window_0_0.ron",
      "windows": {
        "primary": {
          "validate": ["position", "size", "monitor_index", "mode"]
        }
      },
      "persistence_validation": {
        "mode": "ActiveOnly",
        "expected_ron_keys": ["primary"],
        "unexpected_ron_keys": ["window-1"]
      }
    },
    {
      "id": "x11_pos_size_restore_mon1",
      "description": "Basic position/size persistence on Monitor 1 (HDMI)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 1,
      "workaround_keys": ["W5", "W6"],
      "ron_file": "position_size_restore_mon1.ron",
      "mutation": {
        "target_monitor": 1,
        "position_offset": [200, 150],
        "size": [1000, 700]
      },
      "windows": {
        "primary": {
          "validate": ["position", "size", "mode", "monitor_index"]
        }
      },
      "workaround_validation": {
        "feature_flag": "workaround-winit-4445",
        "build_without": "--no-default-features --features workaround-winit-4440,workaround-winit-4443",
        "build_with": "",
        "without_behavior": "Position drifts by title bar height (~28px at scale 1) on save/restore",
        "with_behavior": "Position saved correctly with frame extent compensation"
      }
    },
    {
      "id": "x11_borderless_1_0",
      "description": "Borderless fullscreen restore to Monitor 0 (cross monitor)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 1,
      "ron_file": "fullscreen_borderless_to_mon0.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "x11_borderless_1_1",
      "description": "Borderless fullscreen restore to Monitor 1 (same monitor)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 1,
      "ron_file": "fullscreen_borderless_to_mon1.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "x11_exclusive_1_0",
      "description": "Exclusive fullscreen restore to Monitor 0 (cross monitor)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 1,
      "ron_file": "fullscreen_exclusive_to_mon0.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },
    {
      "id": "x11_exclusive_1_1",
      "description": "Exclusive fullscreen restore to Monitor 1 (same monitor)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 1,
      "ron_file": "fullscreen_exclusive_to_mon1.ron",
      "windows": {
        "primary": {
          "validate": ["mode", "monitor_index"]
        }
      }
    },

    {
      "id": "x11_multi_window_0_1",
      "description": "Primary on Monitor 0, secondary on Monitor 1 (X11)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 0,
      "requires": {"min_monitors": 2},
      "ron_file": "multi_window_0_1.ron",
      "windows": {
        "primary": {
          "validate": ["position", "size", "monitor_index", "mode"]
        },
        "window-1": {
          "spawn_event": "restore_window::SpawnManagedWindow",
          "validate": ["position", "size", "monitor_index", "mode"]
        }
      }
    },

    {
      "id": "x11_multi_window_1_0",
      "description": "Primary on Monitor 1, secondary on Monitor 0 (X11)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 1,
      "requires": {"min_monitors": 2},
      "ron_file": "multi_window_1_0.ron",
      "windows": {
        "primary": {
          "validate": ["position", "size", "monitor_index", "mode"]
        },
        "window-1": {
          "spawn_event": "restore_window::SpawnManagedWindow",
          "validate": ["position", "size", "monitor_index", "mode"]
        }
      }
    },

    {
      "id": "x11_multi_window_1_1",
      "description": "Primary on Monitor 1, secondary on Monitor 1 (X11)",
      "automation": "full",
      "backend": "x11",
      "launch_monitor": 1,
      "requires": {"min_monitors": 2},
      "ron_file": "multi_window_1_1.ron",
      "windows": {
        "primary": {
          "validate": ["position", "size", "monitor_index", "mode"]
        },
        "window-1": {
          "spawn_event": "restore_window::SpawnManagedWindow",
          "validate": ["position", "size", "monitor_index", "mode"]
        }
      }
    },
    {
      "id": "x11_keyboard_snap_W5",
      "description": "Position saved correctly after keyboard snap - tests workaround for winit #4443",
      "automation": "human_only",
      "backend": "x11",
      "launch_monitor": 1,
      "workaround_keys": ["W5"],
      "workaround_validation": {
        "feature_flag": "workaround-winit-4443",
        "build_without": "--no-default-features --features workaround-winit-4440",
        "build_with": "",
        "without_behavior": "Position not saved after keyboard snap (Meta+Arrow)",
        "with_behavior": "Position saved correctly after keyboard snap"
      },
      "ron_file": "keyboard_snap.ron",
      "instructions_without_workaround": [
        "## PHASE 1: Testing WITHOUT workaround (expect bug)",
        "1. App built WITHOUT workaround-winit-4443",
        "2. Use keyboard snap (Meta+Arrow) to tile the window",
        "3. Close the app",
        "4. Relaunch and check if position was restored",
        "5. **EXPECTED BUG**: Position NOT restored (only size)"
      ],
      "instructions_with_workaround": [
        "## PHASE 2: Testing WITH workaround (expect fix)",
        "1. App rebuilt WITH workaround-winit-4443",
        "2. Use keyboard snap (Meta+Arrow) to tile the window",
        "3. Close the app",
        "4. Relaunch and check if position was restored",
        "5. **EXPECTED**: Position IS restored correctly"
      ],
      "success_criteria_without": "Bug confirmed: Position not saved after keyboard snap",
      "success_criteria_with": "Fix confirmed: Position saved and restored after keyboard snap"
    },
    {
      "id": "x11_monitor_boundary",
      "description": "Verifies correct monitor is detected when window is positioned at the boundary between monitors",
      "automation": "human_assisted",
      "backend": "x11",
      "launch_monitor": 1,
      "ron_file": "monitor_boundary_detection.ron",
      "instructions": [
        "## Monitor Boundary Detection Test (X11)",
        "",
        "This test verifies that the correct monitor is detected when positioning",
        "a window right at the boundary between two monitors.",
        "",
        "### PHASE 1: Position at Boundary",
        "1. Drag the window so it straddles the boundary between Monitor 0 and Monitor 1",
        "2. Position it so ~60% is on Monitor 1, ~40% on Monitor 0",
        "3. **VERIFY**: The UI should show 'Monitor: 1' (center-based detection)",
        "4. Tell Claude when positioned",
        "",
        "### PHASE 2: Save and Verify",
        "5. Claude will close the app and copy the saved state",
        "6. Claude will relaunch and verify the monitor_index in saved state",
        "",
        "### PHASE 3: Restore Verification",
        "7. Claude will restore from the saved state",
        "8. **VERIFY**: Window should restore to the same visual position",
        "9. **VERIFY**: UI should still show 'Monitor: 1'"
      ],
      "validate": ["monitor_index", "position"],
      "success_criteria": "Monitor 1 detected when window center is on Monitor 1, even at boundary"
    },
    {
      "id": "wayland_monitor_boundary",
      "description": "Verifies correct monitor is detected on Wayland using winit current_monitor() when window is at monitor boundary",
      "automation": "human_assisted",
      "backend": "wayland",
      "launch_monitor": 1,
      "ron_file": "monitor_boundary_detection.ron",
      "instructions": [
        "## Monitor Boundary Detection Test (Wayland)",
        "",
        "This test verifies that the CurrentMonitor component correctly tracks",
        "the monitor on Wayland where position-based detection doesn't work.",
        "",
        "### PHASE 1: Position at Boundary",
        "1. Drag the window so it straddles the boundary between Monitor 0 and Monitor 1",
        "2. Keep dragging slowly across the boundary",
        "3. **OBSERVE**: The UI should update to show 'Monitor: 1' when window is fully on Monitor 1",
        "4. Note: On Wayland, monitor only updates when window is FULLY on the new monitor",
        "5. Tell Claude when positioned fully on Monitor 1",
        "",
        "### PHASE 2: Save and Verify",
        "6. Claude will close the app and check the saved state",
        "7. **VERIFY**: saved monitor_index should be 1",
        "",
        "### PHASE 3: Restore Verification",
        "8. Claude will relaunch the app",
        "9. **VERIFY**: UI should show 'Monitor: 1' after restore",
        "10. Note: Position won't restore on Wayland (expected), but monitor should be correct"
      ],
      "validate": ["monitor_index"],
      "wayland_notes": [
        "On Wayland, position is always (0,0) - this is expected",
        "Monitor detection uses winit's current_monitor() which updates when window is fully on new monitor",
        "The key validation is that monitor_index is saved and restored correctly"
      ],
      "success_criteria": "Monitor 1 detected and saved correctly when window is fully on Monitor 1"
    }
  ]
}