bevy_local_commands

Crates.iobevy_local_commands
lib.rsbevy_local_commands
version0.5.0
sourcesrc
created_at2023-12-21 16:09:00.149076
updated_at2024-02-18 20:03:11.294323
descriptionSimple local shell commands for the Bevy game engine
homepage
repositoryhttps://github.com/edouardpoitras/bevy_local_commands
max_upload_size
id1077152
size135,984
Edouard Poitras (edouardpoitras)

documentation

README

Bevy Local Commands

Bevy Local Commands Latest version Documentation MIT Apache

Bevy plugin to manage local shell commands.

Usage

Add the plugin:

// ...
.add_plugins(BevyLocalCommandsPlugin)
// ...

Run shell commands:

fn run_command(mut commands: Commands) {
    commands.spawn(LocalCommand::new("bash").args(["-c", "sleep 1 && echo slept"]));
}

See commands started and kill running commands:

fn kill_started_command(mut active_processes: Query<&mut Process>) {
    for mut process in active_processes.iter_mut() {
        warn!("Killing process {}", process.id());
        process.kill().unwrap();
    }
}

Receive command output:

fn get_command_output(mut process_output_event: EventReader<ProcessOutput>) {
    for output in process_output_event.read() {
        info!("Output for command {:?}", output.entity);

        for line in output.lines() {
            info!("Line Output: {}", line);
        }
    }
}

Send command input:

fn send_command_input(
    mut process_output_event: EventReader<ProcessOutput>,
    mut active_processes: Query<&mut Process>,
) {
    for output in process_output_event.read() {
        for line in output.lines() {
            if line.ends_with("Prompt String: ") {
                let mut process = active_processes.get_mut(output.entity).unwrap();
                process.println("Text to send").expect("Failed to write to process");
            }
        }
    }
}

See commands completed:

fn get_completed(mut process_completed_event: EventReader<ProcessCompleted>) {
    for completed in process_completed_event.read() {
        info!(
            "Command completed (Entity - {}, Success - {})",
            completed.entity,
            completed.exit_status.success()
        );
    }
}

Customize commands behaviour:

fn cleanup_on_completion(mut commands: Commands) {
    commands.spawn((
        LocalCommand::new("bash").args(["-c", "sleep 1 && echo slept"]),
        // Also, Cleanup::RemoveComponent to remove Process and Cleanup components upon completion.
        Cleanup::DespawnEntity
    ));
}

Todo

  • Mac testing (not sure if it works yet)

Bevy Compatilibity

bevy bevy_local_commands
0.13 0.5
0.12 0.4
0.11 0.1
Commit count: 24

cargo fmt