3 releases (breaking)
0.5.0 | Jan 9, 2023 |
---|---|
0.4.0 | Dec 20, 2022 |
0.3.0 | Feb 27, 2022 |
#144 in #clap
236 downloads per month
Used in 3 crates
(via bevy_console)
6KB
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)
.add_plugin(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)
.add_plugin(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
wasm
Should work in wasm, but you need to disable default features.
Dependencies
~1.5MB
~39K SLoC