Marsh Compass

A Bevy Plugin that draws a visualization of the auto directional navigation in Bevy's UI Framework.

Usage

Simply add the AutoNavVizPlugin plugin to your app that has auto directional navigation set up.

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            InputDispatchPlugin, // Needed for input focus
            DirectionalNavigationPlugin, // Needed for auto directional nav
            AutoNavVizPlugin // Add this plugin
        ))
        .run();
}

Configuration

The plugin can be configured via its gizmo config group AutoNavVizGizmoConfigGroup.

fn setup(mut config_store: ResMut<GizmoConfigStore>) {
    let mut config = config_store.config_mut::<AutoNavVizGizmoConfigGroup>().1;
    // e.g.
    config.drawing_mode = AutoNavVizDrawMode::EnabledForCurrentFocus;
}

Limitations

Currently, this plugin does not nicely visualize navigation between UI nodes that overlap. Any ideas are welcome -- comment in the GitHub issue about it!

License

This project is dual-licensed under

• MIT License (LICENSE-MIT or https://opensource.org/license/MIT)
• Apache License Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)

at your discretion.

Contributing

Code contributions are welcome. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

No AI contributions allowed.

Feel free to open any issues on GitHub.