Crate bevy_console

bevy_console

A simple Half-Life inspired console with support for argument parsing powered by clap.

Usage

Add ConsolePlugin and optionally the resource ConsoleConfiguration.

use bevy::prelude::*;
use bevy_console::{ConsoleConfiguration, ConsolePlugin};

fn main() {
    App::new()
        .add_plugins((DefaultPlugins, ConsolePlugin))
        .insert_resource(ConsoleConfiguration {
            // override config here
            ..Default::default()
        });
}

Create a console command struct and system and add it to your app with .add_console_command. Commands are created like clap commands with an additional CommandName trait derived via the ConsoleCommand derive.

Add doc comments to your command to provide help information in the console.

use bevy::prelude::*;
use bevy_console::{reply, AddConsoleCommand, ConsoleCommand, ConsolePlugin};
use clap::Parser;

fn main() {
    App::new()
        .add_plugins((DefaultPlugins, ConsolePlugin))
        .add_console_command::<ExampleCommand, _>(example_command);
}

/// Example command
#[derive(Parser, ConsoleCommand)]
#[command(name = "example")]
struct ExampleCommand {
    /// Some message
    msg: String,
}

fn example_command(mut log: ConsoleCommand<ExampleCommand>) {
    if let Some(Ok(ExampleCommand { msg })) = log.take() {
        // handle command
    }
}

Examples can be found in the /examples directory.

cargo run --example log_command

• log_command
• raw_commands
• write_to_console
• change_console_key

wasm

Should work in wasm, but you need to disable default features.

Re-exports

• pub use clap;

Macros

• reply
  Reply with the format! syntax.
• reply_failed
  Reply with the format! syntax followed by [failed].
• reply_ok
  Reply with the format! syntax followed by [ok].

Structs

• ConsoleCommand
  Executed parsed console command.
• ConsoleCommandEntered
  Parsed raw console command into command and args.
• ConsoleConfiguration
  Console configuration
• ConsoleOpen
  Console open state
• ConsolePlugin
  Console plugin.
• PrintConsoleLine
  Events to print to the console.

Enums

• ConsoleSet
  The SystemSet for console/command related systems

Traits

• AddConsoleCommand
  Add a console commands to Bevy app.
• Command
  A super-trait for command like structures
• NamedCommand
  Trait used to allow uniquely identifying commands at compile time

Derive Macros

• ConsoleCommand