https://github.com/henauxg/bevy_ghx_grid

Bevy plugins and utilities for https://github.com/Henauxg/ghx_grid
https://github.com/henauxg/bevy_ghx_grid

Last synced: 18 days ago
JSON representation

Bevy plugins and utilities for https://github.com/Henauxg/ghx_grid

• Host: GitHub
• URL: https://github.com/henauxg/bevy_ghx_grid
• Owner: Henauxg
• License: apache-2.0
• Created: 2024-03-07T12:55:26.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-10-23T22:28:53.000Z (21 days ago)
• Last Synced: 2024-10-24T05:57:55.835Z (21 days ago)
• Language: Rust
• Homepage:
• Size: 663 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        


# Bevy Ghx Grid

[![Bevy tracking](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://github.com/bevyengine/bevy/blob/main/docs/plugins_guidelines.md#main-branch-tracking)

[![bevy_ghx_grid on crates.io](https://img.shields.io/crates/v/bevy_ghx_grid)](https://crates.io/crates/bevy_ghx_grid)

[![bevy_ghx_grid on docs.io](https://docs.rs/bevy_ghx_grid/badge.svg)](https://docs.rs/bevy_ghx_grid)

Uses and exports [`ghx_grid`](https://github.com/Henauxg/ghx_grid), as well as additional plugins and utilities dedicated to [`Bevy`](https://github.com/bevyengine/bevy).



## Grid debug plugin

`GridDebugPlugin` provides debug utilities for the grid-types within `ghx_grid`:

  - Can draw a debug view of any 2d/3d grid

  - Can draw debug markers on any cells of a grid (controlled via bevy events)

Use it by inserting a `DebugGridView3d` bundle on your `Grid` entity (or `DebugGridView2d`, depending on your Bevy Camera).



  



## Cargo features

*Find the list and description in [Cargo.toml](Cargo.toml)*

- `debug-plugin` *[default]*: compiles the grid debug plugin and its systems.

- `reflect` *[default]*: enables `ghx_grid` reflect feature.

*See also the [main crate](https://github.com/Henauxg/ghx_grid#cargo-features) cargo features*

## Compatible Bevy versions

| **bevy_ghx_grid** | **ghx_grid** | **bevy** |

| :---------------- | :----------- | :------- |

| 0.4               | 0.4          | 0.14     |

| 0.3               | 0.3          | 0.13     |

| 0.2               | 0.2          | 0.13     |

| 0.1               | 0.1          | 0.12     |

## License

### Code

bevy_ghx_grid is free and open source. 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.

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.