bevy_mod_gizmos

KO | EN

gitlite — search

#javascript #hacktoberfest #llm #machine-learning #rust #deep-learning #nodejs #windows #awesome #cli #kubernetes #awesome-list #security #ios

bevy_mod_gizmos

(★ 11)

Visual gizmos to assist with Bevy game development

bevy_mod_gizmos Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Visual Gizmos for Bevy

Visual gizmos to aid with development and debugging in [Bevy](https://bevyengine.org/)

[<img alt="bevy tracking" src="https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue?style=for-the-badge" height="24">](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)
[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/LiamGallagher737/bevy_mod_gizmos/rust.yml?branch=main&style=for-the-badge" height="24">](https://github.com/LiamGallagher737/bevy_mod_gizmos/actions)
[<img alt="github" src="https://img.shields.io/badge/github-bevy__mod__gizmos-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="24">](https://github.com/LiamGallagher737/bevy_mod_gizmos)
[<img alt="crates.io" src="https://img.shields.io/crates/v/bevy_mod_gizmos.svg?style=for-the-badge&color=fc8d62&logo=rust" height="24">](https://crates.io/crates/bevy_mod_gizmos)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-bevy__mod__gizmos-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="24">](https://docs.rs/bevy_mod_gizmos)

</div>

# [Demo](examples/demo.rs)

This examples showcases all built-in gizmo types and interactions. Try hovering and clicking the center gizmo!

```
cargo run --example demo 
```

<div align="center">
    <img src="examples/images/DemoScreenshot.png" alt="Demo Example Screenshot" width="600" />
</div>

# Setup

Add the following to your `Cargo.toml`
```toml
bevy_mod_gizmos = "0.4.0"
```

Add this to any file you want to use gizmos in
```rust
use bevy_mod_gizmos::*;
```

Add the plugin to your app
```rust
.add_plugin(GizmosPlugin)
```

For interactive gizmos add the following bundle when spawning your camera
```rust
GizmoInteractionCamera::default()
```

To increase performance I recommend the following in your `Cargo.toml`
```toml
[profile.dev.package."*"]
opt-level = 3
```

# Usage

Draw a single gizmo
```rust
draw_gizmo(gizmo);
```

Draw multiple gizmos
```rust
draw_gizmos(vec![gizmo, gizmo, gizmo]);
```

Draw multiple gizmos and a connecting line
```rust
draw_gizmos_with_line(vec![gizmo, gizmo, gizmo]);
```

Draw a line
```rust
draw_line(points, color);
```

Draw a closed line
```rust
draw_closed_line(points, color);
```

# Interactions

```rust
Gizmo::new(translation, size, color).on_click(|| println!("Clicked!"))
Gizmo::new(translation, size, color).on_hover(|| println!("Hovered!"))
Gizmo::new(translation, size, color).on_click_system(|time: Res<Time>| ...)
Gizmo::new(translation, size, color).on_hover_system(|query: Query<&Transform>| ...)
```

# Bevy Tracking

|Bevy|bevy_mod_gizmos|
|---|---|
|main|development|
|0.10|0.4.0|
|0.9|0.3.1|
|0.7|0.1.1|

# License

All code in this repository is dual-licensed under either:

* MIT License ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))

at your option. This means you can select the license you prefer! This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are [very good reasons](https://github.com/bevyengine/bevy/issues/2373) to include both.

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

bevy_mod_gizmos

bevy_mod_gizmos Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

bevy_mod_gizmos

bevy_mod_gizmos Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README