https://github.com/tobyselway/bevy-autoplay

Automated integration testing based on recorded play-testing sessions
https://github.com/tobyselway/bevy-autoplay

automated-testing bevy bevy-engine game-development gamedev integration-testing playtesting

Last synced: 2 months ago
JSON representation

Automated integration testing based on recorded play-testing sessions

• Host: GitHub
• URL: https://github.com/tobyselway/bevy-autoplay
• Owner: tobyselway
• License: apache-2.0
• Created: 2024-06-06T00:33:58.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2024-06-09T00:38:20.000Z (7 months ago)
• Last Synced: 2024-09-27T07:03:35.994Z (3 months ago)
• Topics: automated-testing, bevy, bevy-engine, game-development, gamedev, integration-testing, playtesting
• Language: Rust
• Homepage: https://crates.io/crates/bevy-autoplay
• Size: 105 KB
• Stars: 20
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# bevy-autoplay

![crates.io](https://img.shields.io/crates/v/bevy-autoplay.svg)

Automated integration testing based on recorded play-testing sessions.

## Recording Sessions

```rust

use bevy::{input::InputSystem, prelude::*};

use bevy_autoplay::{AutoplayPlugin, AutoplayState, AutoplaySystem, SaveToFile};

fn main() {

    App::new()

        .add_plugins((DefaultPlugins, AutoplayPlugin)) // Register the AutoplayPlugin

        .add_systems(

            PreUpdate,

            toggle_record.before(AutoplaySystem).after(InputSystem),

        )

        .add_systems(OnExit(AutoplayState::Recording), after_recording)

        .run();

}

// After recording finished, save the session to a file

fn after_recording(mut ev_save: EventWriter) {

    ev_save.send(SaveToFile("tests/sessions/my_session.gsi".into()));

}

// When F12 pressed, start/stop recording

fn toggle_record(

    mut keyboard_input: ResMut>,

    autoplay_state: Res>,

    mut next_autoplay_state: ResMut>,

) {

    // Clear in order to avoid the F12 keypress passing through to the recording

    keyboard_input.clear_just_released(KeyCode::F12);

    if !keyboard_input.clear_just_pressed(KeyCode::F12) {

        return;

    }

    // If stopped then record, and vice-versa

    if *autoplay_state.get() == AutoplayState::Stopped {

        next_autoplay_state.set(AutoplayState::Recording);

    } else {

        next_autoplay_state.set(AutoplayState::Stopped);

    }

}

```

## Writing Tests

```rust

use bevy::{

    app::{App, Update},

    prelude::*,

};

use bevy_autoplay::testing::{AutoplayTestPlugin, TestResult};

#[test]

fn player_must_press_f_key() {

    fn f_pressed(mut result: EventWriter, keyboard_input: Res>) {

        if keyboard_input.just_pressed(KeyCode::KeyF) { // When F key pressed

            result.send(TestResult::Success); // End test with success

        }

    }

    App::new()

        // Load recorded session

        .add_plugins(AutoplayTestPlugin("tests/sessions/press_f.gsi".into()))

        .add_systems(Update, f_pressed)

        .run();

}

```

## License

Licensed under either of

 * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.