Bevy Inspection - VSCode Extension

Runtime Monitoring & Modification Tool for Bevy Engine in VSCode extension.

⚠️ Warning

• Not Official: This is a community-driven project, not affiliated with the official Bevy Engine team.
• Early Development: Currently in alpha stage - expect bugs and missing features. Contributions welcome!

✨ Features

• Review hierarchy of all entities in your scene
• Rename and destroy entities
• Review and modify components of entities in real time

📅 Upcoming Features

v0.1.3 - Core Functionality

Focus: Critical inspector capabilities

• Component modification
• Collection modification
• Enum modification

v0.1.4 - UX Improvements

Focus: Quality-of-life improvements

• Collapse/expand all components with one-click toggles
• Custom UI adapters for Transform and Vec3 types
• Redesign of number inputs with drag-to-adjust functionality
• Redesign of selection state
• Redesign of buttons

v0.1.5 - Entity Management

Focus: Scene composition tools

• Visualize entity tree in real-time
• Spawn new entities
• Drag-and-drop reparenting of entities

📐 Supported Versions

Built on Bevy Remote Protocol via JSON-RPC 2.0 over HTTP.

📗 Getting Started

Configure Bevy Project

1. Add required dependencies to your Cargo.toml:

[dependencies]
bevy = { version = "0.16", features = ["bevy_remote"] }

2. Initialize plugins in your Bevy App:

fn main() {
    App::new()
        .add_plugins(RemotePlugin::default()) // Core remote protocol
        .add_plugins(RemoteHttpPlugin::default()) // Enable HTTP transport
        // ...other plugins
        .run();
}

3. Launch your game and connect from VSCode using the extension.

Custom Components

For built-in Bevy components (with Reflect trait), inspection works automatically. For custom components:

#[derive(Component, Reflect, Default)] // Derive `Reflect` trait:
#[reflect(Component, Default)] // 'Component' is required for recognition
struct SimpleWeapon {
    #[reflect(ignore)] // Optional: hide sensitive fields
    secret_code: String,
    damage: f32,
    charge_time: f32,
}

fn main() {
    App::new()
        // ...other plugins
        .register_type::<SimpleWeapon>() // Register type
        // ...other registrations
        .run();
}

Custom Resources

Resource inspection not supported - work in progress

Examples

Refer to the examples directory for fully functional Bevy applications demonstrating correct configuration.

🔍 Related Documentation

• Reflection - https://docs.rs/bevy/latest/bevy/reflect/index.html
• RemoteHttpPlugin - https://docs.rs/bevy/latest/bevy/remote/http/struct.RemoteHttpPlugin.html

⭐ Support

As a solo developer, I'm passionate about creating tools that empower the Bevy community. To keep pushing new features and improvements, I need your help to gauge interest and prioritize efforts. Here's how you can contribute:

• Star the Repository - Show that this tool matters and help others discover this tool.
• Share ideas & feedback - Even simple comments in Issues guide prioritization.
• Sponsor development - Funds development efforts, ensuring long-term updates and maintenance.

Your engagement keeps Bevy Inspection thriving. Thank you!

🌐 Alternative Solutions

• splo/bevy-inspector-vscode - vscode extension
• Lommix/bevy_inspector.nvim - nvim extension
• jakobhellermann/bevy_editor_pls - bevy plugin
• jakobhellermann/bevy-inspector-egui - bevy plugin
• idanarye/bevy-yoleck - development kit
• reneeichhorn/bevy-remote-devtools - software (last update in 2022)