bevy-agent-feedback-plugin 0.3.2

Let AI coding agents see and control your Bevy app: input injection, labeled screenshots, and frame-synced feedback over a JSON-lines TCP protocol.
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
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
use std::{
    ffi::OsString,
    path::PathBuf,
    time::{Duration, SystemTime, UNIX_EPOCH},
};

#[derive(Debug, PartialEq, Eq)]
pub(crate) struct RunArgs {
    pub(crate) protocol_file: PathBuf,
    pub(crate) artifacts: PathBuf,
    pub(crate) ready_timeout: Duration,
    pub(crate) shutdown_timeout: Duration,
    pub(crate) driver_timeout: Duration,
    pub(crate) game: Vec<String>,
    pub(crate) driver: Option<Vec<String>>,
}

#[derive(Debug, PartialEq, Eq)]
pub(crate) struct DoctorArgs {
    pub(crate) protocol_file: PathBuf,
}

#[derive(Debug, PartialEq, Eq)]
pub(crate) enum Command {
    Help,
    Version,
    Run(RunArgs),
    Doctor(DoctorArgs),
}

pub(crate) fn parse_args(args: &[String]) -> Result<Command, String> {
    parse_args_with_env(args, |name| std::env::var_os(name))
}

pub(crate) fn version() -> String {
    format!("bevy-feedback {}", env!("CARGO_PKG_VERSION"))
}

pub(crate) fn usage() -> String {
    "usage:
  bevy-feedback --help
  bevy-feedback --version
  bevy-feedback doctor [--protocol FILE]
  bevy-feedback run [--protocol FILE] [--artifacts DIR] [--ready-timeout MS] [--driver-timeout MS] [--shutdown-timeout MS] -- <game command...>
  bevy-feedback run [--protocol FILE] [--artifacts DIR] [--ready-timeout MS] [--driver-timeout MS] [--shutdown-timeout MS] --game <game...> --driver <driver...>

env:
  BEVY_FEEDBACK_PROTOCOL            protocol file (default target/agent-feedback/agent-feedback.json)
  BEVY_FEEDBACK_ARTIFACTS           artifact dir (default target/agent-feedback/artifacts/run-<unix-ms>)
  BEVY_FEEDBACK_READY_TIMEOUT_MS    readiness timeout in milliseconds (default 60000)
  BEVY_FEEDBACK_DRIVER_TIMEOUT_MS   driver timeout in milliseconds (default 300000)
  BEVY_FEEDBACK_SHUTDOWN_TIMEOUT_MS shutdown timeout in milliseconds (default 5000)
  BEVY_FEEDBACK_CAPTURE_DIR         exported to game/driver as the capture dir
  BEVY_FEEDBACK_TRANSCRIPT          exported to game/driver as transcript.jsonl

timeouts:
  readiness 60s, driver 300s, shutdown 5s

artifacts:
  successful runs print artifacts=<dir> and copy captured PNGs to <dir>/screenshots/
  live captures remain in the protocol file's capture_dir during the run

examples:
  bevy-feedback --version
  bevy-feedback doctor
  bevy-feedback run -- cargo run --example minimal
  bevy-feedback run --ready-timeout 180000 --game cargo run --features agent --driver python3 tests/drive_camera.py

note:
  Protocol ready means the automation socket exists, not that assets are loaded. Wait for a stable frame before capturing.
  Do not quote the whole game or driver command; pass each argv word separately."
        .to_string()
}

pub(crate) fn parse_args_with_env(
    args: &[String],
    get_env: impl Fn(&str) -> Option<OsString>,
) -> Result<Command, String> {
    match args {
        [arg] if arg == "--help" || arg == "-h" => Ok(Command::Help),
        [arg] if arg == "--version" || arg == "-V" => Ok(Command::Version),
        [] => Err(
            "missing command; expected 'run' or 'doctor' (see 'bevy-feedback --help')".to_string(),
        ),
        [command, ..] if command == "run" => parse_run_args(&args[1..], &get_env),
        [command, ..] if command == "doctor" => parse_doctor_args(&args[1..], &get_env),
        [option, ..] if option.starts_with('-') => Err(format!(
            "unknown option '{option}' (see 'bevy-feedback --help')"
        )),
        [command, ..] => Err(format!(
            "unknown command '{command}'; expected 'run' or 'doctor' (see 'bevy-feedback --help')"
        )),
    }
}

fn parse_run_args(
    args: &[String],
    get_env: &impl Fn(&str) -> Option<OsString>,
) -> Result<Command, String> {
    if matches!(args, [arg] if arg == "--help" || arg == "-h") {
        return Ok(Command::Help);
    }
    if matches!(args, [arg] if arg == "--version" || arg == "-V") {
        return Ok(Command::Version);
    }

    let mut protocol_file = default_protocol_file(get_env);
    let mut artifacts = get_env("BEVY_FEEDBACK_ARTIFACTS")
        .map(PathBuf::from)
        .unwrap_or_else(|| {
            PathBuf::from(format!("target/agent-feedback/artifacts/run-{}", unix_ms()))
        });
    let mut ready_timeout = default_timeout(
        "ready timeout",
        "BEVY_FEEDBACK_READY_TIMEOUT_MS",
        60_000,
        get_env,
    )?;
    let mut driver_timeout = default_timeout(
        "driver timeout",
        "BEVY_FEEDBACK_DRIVER_TIMEOUT_MS",
        300_000,
        get_env,
    )?;
    let mut shutdown_timeout = default_timeout(
        "shutdown timeout",
        "BEVY_FEEDBACK_SHUTDOWN_TIMEOUT_MS",
        5_000,
        get_env,
    )?;

    let mut index = 0;
    while index < args.len() {
        match args[index].as_str() {
            "--protocol" => {
                let value = option_value(args, index, "--protocol")?;
                protocol_file = PathBuf::from(value);
                index += 2;
            }
            "--artifacts" => {
                let value = option_value(args, index, "--artifacts")?;
                artifacts = PathBuf::from(value);
                index += 2;
            }
            "--ready-timeout" => {
                let value = option_value(args, index, "--ready-timeout")?;
                ready_timeout = parse_timeout_ms(value, "ready timeout")?;
                index += 2;
            }
            "--driver-timeout" => {
                let value = option_value(args, index, "--driver-timeout")?;
                driver_timeout = parse_timeout_ms(value, "driver timeout")?;
                index += 2;
            }
            "--shutdown-timeout" => {
                let value = option_value(args, index, "--shutdown-timeout")?;
                shutdown_timeout = parse_timeout_ms(value, "shutdown timeout")?;
                index += 2;
            }
            "--game" => {
                return parse_game_driver(
                    &args[index + 1..],
                    protocol_file,
                    artifacts,
                    ready_timeout,
                    shutdown_timeout,
                    driver_timeout,
                );
            }
            "--" => {
                let game = args[index + 1..].to_vec();
                if game.is_empty() {
                    return Err(missing_game());
                }
                return Ok(Command::Run(RunArgs {
                    protocol_file,
                    artifacts,
                    ready_timeout,
                    shutdown_timeout,
                    driver_timeout,
                    game,
                    driver: None,
                }));
            }
            option if option.starts_with('-') => {
                return Err(format!(
                    "unknown option '{option}' (see 'bevy-feedback run --help')"
                ));
            }
            _ => return Err(missing_game()),
        }
    }
    Err(missing_game())
}

fn parse_doctor_args(
    args: &[String],
    get_env: &impl Fn(&str) -> Option<OsString>,
) -> Result<Command, String> {
    if matches!(args, [arg] if arg == "--help" || arg == "-h") {
        return Ok(Command::Help);
    }
    if matches!(args, [arg] if arg == "--version" || arg == "-V") {
        return Ok(Command::Version);
    }

    let mut protocol_file = default_protocol_file(get_env);
    let mut index = 0;
    while index < args.len() {
        match args[index].as_str() {
            "--protocol" => {
                let value = option_value(args, index, "--protocol")?;
                protocol_file = PathBuf::from(value);
                index += 2;
            }
            option if option.starts_with('-') => {
                return Err(format!(
                    "unknown option '{option}' (see 'bevy-feedback doctor --help')"
                ));
            }
            value => {
                return Err(format!(
                    "unexpected argument '{value}' (see 'bevy-feedback doctor --help')"
                ));
            }
        }
    }
    Ok(Command::Doctor(DoctorArgs { protocol_file }))
}

fn option_value<'a>(args: &'a [String], index: usize, option: &str) -> Result<&'a str, String> {
    let Some(value) = args.get(index + 1) else {
        return Err(format!("option '{option}' requires a value"));
    };
    if value == "--" || value.starts_with("--") {
        return Err(format!("option '{option}' requires a value"));
    }
    Ok(value)
}

fn parse_timeout_ms(value: &str, name: &str) -> Result<Duration, String> {
    let milliseconds = value
        .parse::<u64>()
        .ok()
        .filter(|milliseconds| *milliseconds > 0)
        .ok_or_else(|| format!("{name} must be a positive integer number of milliseconds"))?;
    Ok(Duration::from_millis(milliseconds))
}

fn default_timeout(
    name: &str,
    env_name: &str,
    default_ms: u64,
    get_env: &impl Fn(&str) -> Option<OsString>,
) -> Result<Duration, String> {
    let Some(value) = get_env(env_name) else {
        return Ok(Duration::from_millis(default_ms));
    };
    let value = value
        .into_string()
        .map_err(|_| format!("{env_name} must be valid UTF-8"))?;
    parse_timeout_ms(&value, name)
}

fn default_protocol_file(get_env: &impl Fn(&str) -> Option<OsString>) -> PathBuf {
    get_env("BEVY_FEEDBACK_PROTOCOL")
        .map(PathBuf::from)
        .unwrap_or_else(|| PathBuf::from("target/agent-feedback/agent-feedback.json"))
}

fn parse_game_driver(
    args: &[String],
    protocol_file: PathBuf,
    artifacts: PathBuf,
    ready_timeout: Duration,
    shutdown_timeout: Duration,
    driver_timeout: Duration,
) -> Result<Command, String> {
    let driver_index = args.iter().position(|arg| arg == "--driver");
    let (game, driver) = match driver_index {
        Some(index) => (&args[..index], Some(args[index + 1..].to_vec())),
        None => (args, None),
    };
    if game.is_empty() {
        return Err(missing_game());
    }
    if driver.as_ref().is_some_and(Vec::is_empty) {
        return Err("missing driver command after '--driver'".to_string());
    }
    Ok(Command::Run(RunArgs {
        protocol_file,
        artifacts,
        ready_timeout,
        shutdown_timeout,
        driver_timeout,
        game: game.to_vec(),
        driver,
    }))
}

fn missing_game() -> String {
    "missing game command; use '-- <game...>' or '--game <game...>'".to_string()
}

fn unix_ms() -> u128 {
    SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap_or_default()
        .as_millis()
}

#[cfg(test)]
mod tests {
    use super::*;

    fn run_args(command: Command) -> RunArgs {
        match command {
            Command::Run(args) => args,
            other => panic!("expected run args, got {other:?}"),
        }
    }

    #[test]
    fn parses_game_only_command() {
        let args = run_args(
            parse_args(&[
                "run".into(),
                "--".into(),
                "cargo".into(),
                "run".into(),
                "--example".into(),
                "minimal".into(),
            ])
            .expect("args"),
        );

        assert_eq!(args.game, ["cargo", "run", "--example", "minimal"]);
        assert_eq!(args.driver, None);
    }

    #[test]
    fn parses_game_and_driver_command() {
        let args = run_args(
            parse_args(&[
                "run".into(),
                "--protocol".into(),
                "target/agent.json".into(),
                "--game".into(),
                "cargo".into(),
                "run".into(),
                "--driver".into(),
                "python3".into(),
                "drive.py".into(),
            ])
            .expect("args"),
        );

        assert_eq!(args.protocol_file, PathBuf::from("target/agent.json"));
        assert_eq!(args.game, ["cargo", "run"]);
        assert_eq!(args.driver, Some(vec!["python3".into(), "drive.py".into()]));
    }

    #[test]
    fn parses_timeout_flags_for_game_only_command() {
        let args = run_args(
            parse_args(&[
                "run".into(),
                "--ready-timeout".into(),
                "120000".into(),
                "--driver-timeout".into(),
                "400000".into(),
                "--shutdown-timeout".into(),
                "9000".into(),
                "--".into(),
                "cargo".into(),
                "run".into(),
            ])
            .expect("args"),
        );

        assert_eq!(args.ready_timeout, Duration::from_millis(120_000));
        assert_eq!(args.driver_timeout, Duration::from_millis(400_000));
        assert_eq!(args.shutdown_timeout, Duration::from_millis(9_000));
    }

    #[test]
    fn parses_timeout_flags_for_game_and_driver_command() {
        let args = run_args(
            parse_args(&[
                "run".into(),
                "--ready-timeout".into(),
                "120000".into(),
                "--driver-timeout".into(),
                "400000".into(),
                "--shutdown-timeout".into(),
                "9000".into(),
                "--game".into(),
                "cargo".into(),
                "run".into(),
                "--driver".into(),
                "python3".into(),
                "drive.py".into(),
            ])
            .expect("args"),
        );

        assert_eq!(args.ready_timeout, Duration::from_millis(120_000));
        assert_eq!(args.driver_timeout, Duration::from_millis(400_000));
        assert_eq!(args.shutdown_timeout, Duration::from_millis(9_000));
        assert_eq!(args.game, ["cargo", "run"]);
        assert_eq!(args.driver, Some(vec!["python3".into(), "drive.py".into()]));
    }

    #[test]
    fn rejects_zero_timeout() {
        let error = parse_args(&[
            "run".into(),
            "--ready-timeout".into(),
            "0".into(),
            "--".into(),
            "cargo".into(),
            "run".into(),
        ])
        .expect_err("zero timeout should be rejected");

        assert!(error.contains("ready timeout must be a positive integer number of milliseconds"));
    }

    #[test]
    fn uses_timeout_env_defaults() {
        let args = run_args(
            parse_args_with_env(
                &["run".into(), "--".into(), "cargo".into(), "run".into()],
                |name| match name {
                    "BEVY_FEEDBACK_READY_TIMEOUT_MS" => Some(OsString::from("120000")),
                    "BEVY_FEEDBACK_DRIVER_TIMEOUT_MS" => Some(OsString::from("400000")),
                    "BEVY_FEEDBACK_SHUTDOWN_TIMEOUT_MS" => Some(OsString::from("9000")),
                    _ => None,
                },
            )
            .expect("args"),
        );

        assert_eq!(args.ready_timeout, Duration::from_millis(120_000));
        assert_eq!(args.driver_timeout, Duration::from_millis(400_000));
        assert_eq!(args.shutdown_timeout, Duration::from_millis(9_000));
    }

    #[test]
    fn parses_run_help() {
        assert_eq!(
            parse_args(&["run".into(), "--help".into()]).expect("help"),
            Command::Help
        );
        assert_eq!(
            parse_args(&["run".into(), "-h".into()]).expect("help"),
            Command::Help
        );
    }

    #[test]
    fn parses_global_help() {
        assert_eq!(parse_args(&["--help".into()]).expect("help"), Command::Help);
        assert_eq!(parse_args(&["-h".into()]).expect("help"), Command::Help);
    }

    #[test]
    fn help_does_not_read_timeout_env() {
        assert_eq!(
            parse_args_with_env(&["run".into(), "--help".into()], |name| {
                panic!("help should not read env {name}")
            })
            .expect("help"),
            Command::Help
        );
    }

    #[test]
    fn does_not_consume_help_after_separator() {
        let args =
            run_args(parse_args(&["run".into(), "--".into(), "--help".into()]).expect("args"));

        assert_eq!(args.game, ["--help"]);
    }

    #[test]
    fn parses_separator_game_path_with_spaces() {
        let args = run_args(
            parse_args(&["run".into(), "--".into(), "/tmp/My Game/game".into()]).expect("args"),
        );

        assert_eq!(args.game, ["/tmp/My Game/game"]);
        assert_eq!(args.driver, None);
    }

    #[test]
    fn parses_game_and_driver_paths_with_spaces() {
        let args = run_args(
            parse_args(&[
                "run".into(),
                "--game".into(),
                "/tmp/My Game/game".into(),
                "--driver".into(),
                "/tmp/My Driver/driver.py".into(),
            ])
            .expect("args"),
        );

        assert_eq!(args.game, ["/tmp/My Game/game"]);
        assert_eq!(args.driver, Some(vec!["/tmp/My Driver/driver.py".into()]));
    }

    #[test]
    fn parses_global_version() {
        assert_eq!(
            parse_args(&["--version".into()]).expect("version"),
            Command::Version
        );
        assert_eq!(
            parse_args(&["-V".into()]).expect("version"),
            Command::Version
        );
    }

    #[test]
    fn parses_run_version() {
        assert_eq!(
            parse_args(&["run".into(), "--version".into()]).expect("version"),
            Command::Version
        );
        assert_eq!(
            parse_args(&["run".into(), "-V".into()]).expect("version"),
            Command::Version
        );
    }

    #[test]
    fn parses_doctor_protocol() {
        assert_eq!(
            parse_args(&[
                "doctor".into(),
                "--protocol".into(),
                "target/custom.json".into()
            ])
            .expect("doctor"),
            Command::Doctor(DoctorArgs {
                protocol_file: PathBuf::from("target/custom.json")
            })
        );
    }

    #[test]
    fn rejects_unknown_command_precisely() {
        let error = parse_args(&["bad".into()]).expect_err("unknown command");
        assert_eq!(
            error,
            "unknown command 'bad'; expected 'run' or 'doctor' (see 'bevy-feedback --help')"
        );
    }

    #[test]
    fn rejects_unknown_run_option_precisely() {
        let error = parse_args(&["run".into(), "--bad".into()]).expect_err("unknown option");
        assert_eq!(
            error,
            "unknown option '--bad' (see 'bevy-feedback run --help')"
        );
    }

    #[test]
    fn rejects_missing_value_precisely() {
        let error = parse_args(&["run".into(), "--protocol".into()]).expect_err("missing value");
        assert_eq!(error, "option '--protocol' requires a value");
    }

    #[test]
    fn rejects_missing_game_precisely() {
        let error = parse_args(&["run".into()]).expect_err("missing game");
        assert_eq!(
            error,
            "missing game command; use '-- <game...>' or '--game <game...>'"
        );
    }

    #[test]
    fn usage_shows_cargo_driver_argv_example() {
        let usage = usage();

        assert!(
            usage.contains(
                "--game cargo run --features agent --driver python3 tests/drive_camera.py"
            )
        );
        assert!(usage.contains("Do not quote the whole game or driver command"));
        assert!(usage.contains("doctor"));
        assert!(usage.contains("--version"));
        assert!(usage.contains("screenshots"));
    }
}