docs.rs failed to build bevy_screen_diags-0.4.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: bevy_screen_diags-0.7.0

Bevy diagnostics overlay

bevy_screen_diags adds a very simple frames-per-second (FPS) display to your screen in Bevy.

Usage

Put the crate into your Cargo.toml.

bevy_screen_diags = "*"

Include the plugin when you build your App.

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugin(bevy_screen_diags::ScreenDiagsPlugin)
        //If a UI camera is already in your game remove the next line
        .add_startup_system(|mut commands: Commands| {commands.spawn_bundle(UiCameraBundle::default());})
        :
        :
}

Put the font you want to use in assets/fonts/screen-diags-font.ttf. If you want, you can use the font at that path in this project (which is FiraSans-Bold).

Example screen showing the FPS

The basic example just shows the FPS count on a grey background, but you can click your mouse on the window to add or remove the display.

Contributions to the crate are welcome.

bevy_screen_diags 0.4.0

Bevy diagnostics overlay

Usage