egor

A dead simple cross-platform 2D graphics engine

![Screenshot](media/ss.png)

## Why Egor? **Egor** is dead **simple**, **lightweight** and **cross-platform**. The same code runs on native and web (WASM) with minimal boilerplate. It's is built from small, composable crates on top of modern graphics and windowing abstractions **Egor** gives you the essentials for 2D apps and games: - Efficient 2D rendering (shapes, textures, text) - Keyboard & mouse input - Camera & world-space transforms - Interactive UIs with optional **egui** integration - Optional hot-reload during development ## Platform Support | Target | Backend(s) | Status | | ---------- | ------------------------ | ---------- | | Windows | DX12, Vulkan, OpenGL | ✅ Stable | | MacOS | Metal, Vulkan (MoltenVK) | ✅ Stable | | Linux | Vulkan, OpenGL | ✅ Stable | | Web (WASM) | WebGPU, WebGL2 | ✅ Working | > [!NOTE] > Mobile (Android/iOS) isn't (intended to be) supported & neither is touch input ## Getting Started Add **egor** to your project: ```bash cargo add egor ``` Example: ```rust let mut position = Vec2::ZERO; App::new() .title("Egor Stateful Rectangle") .run(move |FrameContext { gfx, input, timer, .. } | { let dx = input.key_held(KeyCode::ArrowRight) as i8 - input.key_held(KeyCode::ArrowLeft) as i8; let dy = input.key_held(KeyCode::ArrowDown) as i8 - input.key_held(KeyCode::ArrowUp) as i8; position += vec2(dx as f32, dy as f32) * 100.0 * timer.delta; gfx.rect().at(position).color(Color::RED); }) ``` To see more of **egor** in action, check out [demos/](demos) > [!TIP] > Running a demo for WASM? You’ll need to move [index.html](demos/index.html) into a demo, or just use the included [run.sh](demos/run.sh) script (see usage). It simplifies running native, WASM & hot-reload builds For full documentation see the [official docs](https://docs.rs/egor/latest) ### Running a Native Build Simply run `cargo`: ```bash cargo run ``` ### Running a WASM Build Run `trunk` (defer to [Trunk docs](https://docs.rs/crate/trunk/latest) for setup): ```bash trunk serve ``` ### Try Out Subsecond Hot-reloading Compile with the `hot_reload` feature enabled. Hot reload will automatically wrap `AppHandler::update` when the feature is active Run `dioxus-cli` (defer to [Dioxus CLI docs](https://docs.rs/crate/dioxus-cli/latest) for setup): ```bash dx serve --hot-patch ``` > [!NOTE] > Subsecond hot-reloading is experimental; native is working ## Contributing **egor** is moving fast. Before opening a PR or submitting a change, please read [CONTRIBUTING.md](CONTRIBUTING.md) Check out some [issues](https://github.com/wick3dr0se/egor/issues), open a new one, drop a PR or come hang in [Discord](https://opensourceforce.net/discord) --- **egor** is maintained with ❤️ by [Open Source Force](https://github.com/opensource-force)

Statistics

Topics

Details

Quality Indicators