7 releases (4 breaking)
0.5.1 | Dec 21, 2020 |
---|---|
0.5.0 | Dec 21, 2020 |
0.4.0 | Dec 20, 2020 |
0.3.1 | Dec 12, 2020 |
0.1.0 | Sep 5, 2020 |
#23 in #inspector
92KB
609 lines
bevy-contrib-inspector
This crate provides the ability to annotate structs with a #[derive(Inspectable)]
,
which opens a web interface (by default on port 5676) where you can visually edit the values of your struct live.
Your struct will then be available to you as a bevy resource.
Example
use bevy_contrib_inspector::Inspectable;
#[derive(Inspectable, Default)]
struct Data {
should_render: bool,
text: String,
#[inspectable(min = 42.0, max = 100.0)]
size: f32,
}
Add the InspectorPlugin
to your App.
use bevy_contrib_inspector::InspectorPlugin;
fn main() {
App::build()
.add_default_plugins()
.add_plugin(InspectorPlugin::<Data>::new())
.add_system(your_system.system())
// ...
.run();
}
fn your_system(data: ChangedRes<Data>, mut query: Query<...>) { /* */ }
To automatically open the webbrowser when starting, run your program using BEVY_INSPECTOR_OPEN=1 cargo run
.
Attributes
When deriving the Inspectable
trait, you can set options such like the port the server will run on like so:
#[derive(Inspectable, Default)]
#[inspectable(port = 1234)]
struct Data {
#[inspectable(a = 1, b = 2, c = 3)]
field: Type,
}
The attribute on the struct will accept fields of the type InspectableOptions
,
while the attributes on the fields accept those of their <Type as AsHtml>::Options
.
Features
native
: Instead of opening the inspector window in a browser, start a webkit2gtk window.
On ubuntu, the feature requires sudo apt install libwebkit2gtk-4.0-dev
Dependencies
~24–67MB
~659K SLoC