Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mvlabat/bevy_egui
This crate provides an Egui integration for the Bevy game engine. 🇺🇦 Please support the Ukrainian army: https://savelife.in.ua/en/
https://github.com/mvlabat/bevy_egui
bevy bevy-engine egui
Last synced: 3 months ago
JSON representation
This crate provides an Egui integration for the Bevy game engine. 🇺🇦 Please support the Ukrainian army: https://savelife.in.ua/en/
- Host: GitHub
- URL: https://github.com/mvlabat/bevy_egui
- Owner: mvlabat
- License: mit
- Created: 2021-01-10T11:11:24.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-04T15:29:32.000Z (3 months ago)
- Last Synced: 2024-10-04T15:41:21.795Z (3 months ago)
- Topics: bevy, bevy-engine, egui
- Language: Rust
- Homepage:
- Size: 554 KB
- Stars: 911
- Watchers: 11
- Forks: 242
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-gamedev - bevy_egui
- awesome-rust-gamedev - bevy_egui
README
[](https://stand-with-ukraine.pp.ua)
**Hey!** I'm the author of the crate, and I was born in Mariupol, Ukraine. When russians started the war in 2014, I moved to Kyiv. My parents, who had been staying in Mariupol till the start of the full-scale invasion, barely escaped the city alive. By the moment of writing (November 5th, 2023), we had [874 air raid alerts in Kyiv, and russians managed to bomb the city 132 times](https://air-alarms.in.ua/en/region/kyiv).
**If you are using this crate, please consider donating to any of the listed funds (see the banner above), that will mean a lot to me.**
# `bevy_egui`
[](https://crates.io/crates/bevy_egui)
[](https://docs.rs/bevy_egui)
[](https://github.com/bevyengine/bevy/blob/master/LICENSE)
[](https://crates.io/crates/bevy_egui)
[](https://github.com/mvlabat/bevy_egui/actions)
This crate provides an [Egui](https://github.com/emilk/egui) integration for the [Bevy](https://github.com/bevyengine/bevy) game engine.
**Trying out:**
An example WASM project is live at [mvlabat.github.io/bevy_egui_web_showcase](https://mvlabat.github.io/bevy_egui_web_showcase/index.html) [[source](https://github.com/mvlabat/bevy_egui_web_showcase)].
**Features:**
- Desktop and web platforms support
- Clipboard
- Opening URLs
- Multiple windows support (see [./examples/two_windows.rs](https://github.com/mvlabat/bevy_egui/blob/v0.29.0/examples/two_windows.rs))
- Paint callback support (see [./examples/paint_callback.rs](https://github.com/mvlabat/bevy_egui/blob/v0.29.0/examples/paint_callback.rs))
- Mobile web virtual keyboard (still rough support and only works without prevent_default_event_handling set to false on the WindowPlugin primary_window)
`bevy_egui` can be compiled with using only `bevy`, `egui` and `bytemuck` as dependencies: `manage_clipboard` and `open_url` features,
that require additional crates, can be disabled.
## Dependencies
On Linux, this crate requires certain parts of [XCB](https://xcb.freedesktop.org/) to be installed on your system. On Debian-based systems, these can be installed with the following command:
```
$ sudo apt install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
```
## Usage
Here's a minimal usage example:
```toml
# Cargo.toml
[dependencies]
bevy = "0.14"
bevy_egui = "0.30"
```
```rust
use bevy::prelude::*;
use bevy_egui::{egui, EguiContexts, EguiPlugin};
fn main() {
App::new()
.add_plugins(DefaultPlugins)
.add_plugins(EguiPlugin)
// Systems that create Egui widgets should be run during the `CoreSet::Update` set,
// or after the `EguiSet::BeginPass` system (which belongs to the `CoreSet::PreUpdate` set).
.add_systems(Update, ui_example_system)
.run();
}
fn ui_example_system(mut contexts: EguiContexts) {
egui::Window::new("Hello").show(contexts.ctx_mut(), |ui| {
ui.label("world");
});
}
```
For a more advanced example, see [examples/ui.rs](https://github.com/mvlabat/bevy_egui/blob/v0.20.1/examples/ui.rs).
```bash
cargo run --example ui
```
## See also
- [`jakobhellermann/bevy-inspector-egui`](https://github.com/jakobhellermann/bevy-inspector-egui)
## Bevy support table
**Note:** if you're looking for a `bevy_egui` version that supports `main` branch of Bevy, check out [open PRs](https://github.com/mvlabat/bevy_egui/pulls), there's a great chance we've already started working on the future Bevy release support.
| bevy | bevy_egui |
|------|-----------|
| 0.14 | 0.28-0.30 |
| 0.13 | 0.25-0.27 |
| 0.12 | 0.23-0.24 |
| 0.11 | 0.21-0.22 |
| 0.10 | 0.20 |
| 0.9 | 0.17-0.19 |
| 0.8 | 0.15-0.16 |
| 0.7 | 0.13-0.14 |
| 0.6 | 0.10-0.12 |
| 0.5 | 0.4-0.9 |
| 0.4 | 0.1-0.3 |