Refactor UI into widgets, add panels for diagnostics and resources

Author: Davier

Cargo.toml

@@ -4,8 +4,19 @@ version = "0.1.0"
 authors = ["Brice DAVIER <bricedavier@gmail.com>"]
 edition = "2018"
 
+[features]
+# default = ["extra"]
+default = []
+extra = []
+
 [dependencies]
-bevy = "0.4.0"
+bevy = { version = "0.4.0", default-features = false }
 ron = "0.6.4"
 serde = "1.0"
-interpolation = "0.2.0"
+interpolation = "0.2.0"
+# bevy_system_diagnostics = { path = "../bevy_system_diagnostics" }
+wgpu = "0.6"
+image = "0.23.12"
+
+[patch.crates-io]
+bevy = { path = "../bevy/" } # FIXME

README.md

@@ -1,36 +1,46 @@
 # Bevy Debug Menu
 
-This crate adds a debug menu to your [Bevy](https://bevyengine.org) game that can show and edit all the current entities.
+This crate adds a debug menu to your [Bevy](https://bevyengine.org) game. It can show your diagnostics, and explore and edit the current entities and resources.
 
-Usage:
+## Usage
+
+* make sure you are using `bevy` from a recent `master` branch
+* add dependency in `Cargo.toml`:
+```toml
+[dependencies]
+bevy_debug_menu = { git = "https://github.com/Davier/bevy_debug_menu" }
+```
+* add the `DebugMenuPlugin` to your bevy app
+* launch the app and press `F10` to show or hide the menu
 
-* add the [DebugMenuPlugin] to your bevy app
-* add the [DebugMenuFont] resource (and the font file to your `assets/` folder)
-* optional: adapt your game to stop processing keyboard inputs by listening to [FocusedEvent] and [UnfocusedEvent]
-* press F10 to show or hide the menu
- 
-## Warnings
 
-You need to compile in release mode to have descent frame rate. 
+## Optional setup
 
-This contains unsafe code that needs reviewing.
+* derive `Reflect`, `ReflectComponent` and `ReflectResource` on your types
+* adapt your game to stop processing keyboard inputs when editing entities by listening to `FocusedEvent` and `UnfocusedEvent`
 
-The debug menu will push the rest of your UI elements even when hidden. A PR is being made to bevy to fix that.
+## Warnings
 
-This is a prototype.
+* you need to compile in release mode to have descent frame rate
+* with default features, the debug menu will push the rest of your UI elements even when hidden (see [#1211](https://github.com/bevyengine/bevy/pull/1211))
+* with default features, the "Resource" panel is disabled (see [#1260](https://github.com/bevyengine/bevy/pull/1260))
+* both issues can be fixed by using a bevy fork and enabling the `extra` feature in `Cargo.toml`:
+```toml
+[dependencies]
+bevy_debug_menu = { git = "https://github.com/Davier/bevy_debug_menu", features = ["extra"] }
+[patch.crates-io]
+bevy = { git = "https://github.com/Davier/bevy", branch = "extra" }
+```
 
 ## Example
 
-```
+```rust
 use bevy::prelude::*;
 
 fn main() {
     App::build()
         .add_plugins(DefaultPlugins)
         .add_plugin(bevy_debug_menu::DebugMenuPlugin)
-        .add_resource(bevy_debug_menu::DebugMenuFont{
-            path: "your_font.ttf"
-        })
         // This is unnecessary if you already initialize the UI camera in your game
         .add_startup_system(bevy_debug_menu::setup_ui_camera.system())
         .run();
@@ -39,11 +49,9 @@ fn main() {
 
 ## TODO
 
-* filtering for components
-* remove entities/components
-* improve the edit box widget
-* always draw over other UI elements
-* specialized widgets to edit some types (e.g. bool, ints, floats)
-* implement reflection for enums
+* search by resource type, component type, entity Name and entity Label
+* remove resource, entity, component
+* load/save scene
+* list and spawn loaded scenes
 * integration with bevy_mod_picking
-
+* implement reflection for enums

assets/FiraMono-Bold.ttf

@@ -0,0 +1,3 @@
+# Icons
+
+`chevron-up.svg` and `chevron-down.svg` are from https://github.com/twbs/icons under MIT license.