jomala / bevy_screen_diags Goto Github PK

@jomala

I think we should update the crates.io version to reflect the new changes along with making it obvious which version of bevy is tied to which version of the crate, like what other crates do.

Hi am curious on how i would change the location of the fps display and how i would get it to always display on the highest layer.
an image of the layering issue is pictured in the bottom left corner of this screenshot
the app is basically this with the screen_diags plug added in before .run
https://github.com/nicopap/ui-navigation/blob/v0.13.1/examples/ultimate_menu_navigation.rs

You don't seem to be that active that much and I was wondering if I can just become the maintainer of this crate as I'm interested in doing that.

Update the documentation here to make it more clear:
https://github.com/jomala/bevy_screen_diags/blob/master/src/lib.rs#L22-L26

Update the documentation here to make more of a distinction between the other type: https://github.com/jomala/bevy_screen_diags/blob/master/src/lib.rs#L38-L41

Hello,
When I try to add bevy_screen_diags to the Cargo.toml of a fresh Bevy 0.6 project I get an error message from Cargo.
This is my Cargo.toml:

[package]
name = "beatbot"
version = "0.1.0"
edition = "2021"

[dependencies]
# Remove `dynamic` when building the game executable
# Otherwise, it can't be run standalone
bevy = { version = "0.6.0", features = ["dynamic"]}
bevy_screen_diags = "*"

And this is the error output after I added bevy_screen_diags = "*" to it:

Execution failed (exit code 101).
/Users/bastien/.cargo/bin/cargo metadata --verbose --format-version 1 --all-features
stdout :     Updating crates.io index
error: failed to select a version for `web-sys`.
    ... required by package `wgpu v0.12.0`
    ... which satisfies dependency `wgpu = "^0.12.0"` of package `bevy_render v0.6.0`
    ... which satisfies dependency `bevy_render = "^0.6.0"` of package `bevy_core_pipeline v0.6.0`
    ... which satisfies dependency `bevy_core_pipeline = "^0.6.0"` of package `bevy_internal v0.6.0`
    ... which satisfies dependency `bevy_internal = "^0.6.0"` of package `bevy v0.6.0`
    ... which satisfies dependency `bevy = "^0.6.0"` of package `beatbot v0.1.0 (/Users/bastien/Documents/PGRM_Projects/RUST/beatbot)`
versions that meet the requirements `^0.3.53` are: 0.3.56, 0.3.55, 0.3.54, 0.3.53

all possible versions conflict with previously selected packages.

  previously selected package `web-sys v0.3.39`
    ... which satisfies dependency `web-sys = "^0.3.39"` of package `wgpu v0.6.0`
    ... which satisfies dependency `wgpu = "^0.6"` of package `bevy_wgpu v0.4.0`
    ... which satisfies dependency `bevy_wgpu = "^0.4.0"` of package `bevy_internal v0.4.0`
    ... which satisfies dependency `bevy_internal = "^0.4.0"` of package `bevy v0.4.0`
    ... which satisfies dependency `bevy = "^0.4"` of package `bevy_screen_diags v0.1.0`
    ... which satisfies dependency `bevy_screen_diags = "*"` of package `beatbot v0.1.0 (/Users/bastien/Documents/PGRM_Projects/RUST/beatbot)`

failed to select a version for `web-sys` which could resolve this conflict

stderr : 

I am pretty new to this therefore I hope I don't waste your time

It's a little inconvenient (and not particularly intuitive) to control whether or not the overlay is disabled via pausing/unpausing a timer.

I propose enabling & disabling could be handled via a boolean within either a Resource or a Component struct - users would mutably query this, and set the boolean to true to display the overlay, or false to hide it. This would also greatly simplify the internal logic within the update system - basically entailing a complete re-write.

This would be a breaking change as it would likely remove the need for the ScreenDiagsTimer marker struct, which would mean the current method of enabling & disabling would no longer work.

Happy to work on an implementation of this, @jomala - your call on whether or not this makes sense for the library.

Should we use the smaller internal bevy crates because they're smaller?

Or should we just disable all the default bevy features and enable the ones we need to make the crate smaller.

Have the option to use Bevy's builtin font. I'm building for web and i don't want to be bothered with having a font avaiable at /assets

As a user of this crate, it would be really nice to have control over (at a minimum) the font path, font size, text color, and update interval of the timer.

The Bevy way to do this seems to be using a Resource to control these values. This feature could be implemented in a backwards-compatible way by making use of a Default impl for the Resource struct that end-users can simply override. Would need some docs updates and maybe an example of changing these values.

I'm happy to work on this - feel free to assign me to it (if that's possible?).