https://github.com/wraithaven-games/bevy_wh_elements

An object-based UI wrapper for Bevy.
https://github.com/wraithaven-games/bevy_wh_elements

bevy bevy-engine ui

Last synced: 11 days ago
JSON representation

An object-based UI wrapper for Bevy.

• Host: GitHub
• URL: https://github.com/wraithaven-games/bevy_wh_elements
• Owner: Wraithaven-Games
• License: mit
• Created: 2023-11-21T17:51:54.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-29T11:11:39.000Z (about 1 year ago)
• Last Synced: 2024-04-18T00:10:23.383Z (8 months ago)
• Topics: bevy, bevy-engine, ui
• Language: Rust
• Homepage:
• Size: 172 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


WhElements

bevy_wh_elements, short for Bevy: Wraithaven's Elements, is a proof-of-content user interface wrapper library for the Bevy game engine. The purpose of this library is to add a level of abstraction over the default implementation of the Bevy user interface in order to reduce a significant amount of the boilerplate that is required to get a simple menu operation.



---

> [!NOTE]

> This project is still considered a proof of concept at this time. As such, there are currently no plans to upload this version of the library to `crates.io` until a cleaner and more well defined version of this codebase are written. This project will also only attempt to maintain the codebase for the latest version of `Bevy`. This package mainly exists for usage within the **Wraithaven** library ecosystem.

## Getting Started

To install this project from git, simply add the following to your `Cargo.toml`, under your existing dependencies.

```toml

[dependencies]

bevy = "0.12.0"

bevy_wh_elements = { git = "https://github.com/TheDudeFromCI/bevy_wh_elements" }

```

Please note that this will use the bleeding edge version of the codebase, which may contain frequent updates, bugfixes, and API changes. If you wish to lock your version to a specific commit of this library, which is highly recommended for active projects, you can also specify the commit version within your `Cargo.toml` to lock the version in place.

```toml

[dependencies]

bevy = "0.12.0"

bevy_wh_elements = { git = "https://github.com/TheDudeFromCI/bevy_wh_elements", rev = "a636f9e" }

```

## Versions

| Bevy Version | WhElements |

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

|       0.12.0 |      0.1.0 |

## Additional Credits

This library uses the custom `cursor.ttf` font provided by `bevy_simple_text_input`. As such, usage of that font falls under the license used by that library.

A special thanks to the developers of that plugin for providing this font, as well as inspiration for code snippets used in the development of this library.