Crate bevy_inspector_egui[][src]

Expand description

This crate provides the ability to annotate structs with a #[derive(Inspectable)], which opens a debug interface using egui where you can visually edit the values of your struct live.

Your struct will then be available to you as a bevy resource.


use bevy_inspector_egui::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_inspector_egui::InspectorPlugin;

fn main() {

The list of built-in attributes is documented here.

World Inspector

If you want to display all world entities you can add the WorldInspectorPlugin:

use bevy::prelude::*;
use bevy_inspector_egui::WorldInspectorPlugin;

fn main() {

You can configure it by inserting the WorldInspectorParams resource.


  • clipboard (enabled by default): enables egui’s clipboard integratoin
  • rapier: adds support for bevy_rapier3d
  • rapier2d: adds support for bevy_rapier2d


pub use bevy_egui;
pub use bevy_egui::egui;


Attributes for the built-in Inspectable implementations

Internals for the inspector plugins

Inspectable implementation for foreign types implementing Reflect

Utitly types implementing Inspectable

Configuration for the WorldInspectorPlugin


The context passed to Inspectable::ui.

The InspectableRegistry can be used to tell the WorldInspectorPlugin how to display a type.

Bevy plugin for the inspector. See the crate-level docs for an example on how to use it.

Resource which controls the way the world inspector is shown.

Plugin for displaying an inspector window of all entites in the world and their components.


This trait describes how a struct should be displayed. It can be derived for structs and enums, see the crate-level docs for how to do that.

Derive Macros

Derives the Inspectable trait.