bevy_text_popup 0.1.0

Easily create temporary text pop-up nodes in the Bevy game engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

# Bevy Text Popup

[![Bevy Text Popup](https://github.com/edouardpoitras/bevy_text_popup/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/edouardpoitras/bevy_text_popup/actions/workflows/rust.yml)
[![Latest version](https://img.shields.io/crates/v/bevy_text_popup.svg)](https://crates.io/crates/bevy_text_popup)
[![Documentation](https://docs.rs/bevy_text_popup/badge.svg)](https://docs.rs/bevy_text_popup)
![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
![Apache](https://img.shields.io/badge/license-Apache-blue.svg)

Bevy plugin to easily create UI text popups with events.

Popups are meant to be short-lived and on top of all other UI components.

Useful for notifications and prompting user input.

Current Customization Options:
- Font: `cargo run --example custom_font`
- Background: Color and Transparency (image background to come)
- Border: `cargo run --example border`
- Buttons: `cargo run --example buttons`
- Timeouts: Dismiss automatically after X seconds
- Modal: `cargo run --example modal`

Upcoming Customization Options:
- Dismiss: Click anywhere to dismiss, X close button, etc.
- Input: Allow for user input.
- Hover/Click: Color change on button/popup hover/click.
- Animations: Open/Close/Dismiss/Click/etc.

## Examples

This example will display a modal popup for 10s with a 'Close' button.

```rust,ignore
use bevy::prelude::*;
use bevy_text_popup::{TextPopupEvent, TextPopupPlugin, TextPopupTimeout};

fn main() {
    App::new()
        .add_plugins((DefaultPlugins, TextPopupPlugin))
        .add_systems(Startup, setup)
        .run();
}

fn setup(mut commands: Commands, mut text_popup_events: EventWriter<TextPopupEvent>) {
    commands.spawn(Camera2dBundle::default());

    text_popup_events.send(TextPopupEvent {
        content: "Modal Example".to_string(),
        modal: Some(Color::BLUE.with_a(0.75)),
        timeout: TextPopupTimeout::Seconds(10),
        dismiss_button: Some(TextPopupButton {
            text: "Close".to_string(),
            ..Default::default()
        }),
        ..default()
    });
}
```

### Buttons

`cargo run --example buttons`

![Buttons Example](examples/buttons.png?raw=true "Buttons")

### Border

`cargo run --example border`

![Border](examples/border.png?raw=true "Border")

### Custom Font

`cargo run --example custom_font`

![Custom Font Example](examples/custom_font.png?raw=true "Custom Font")

### Locations

`cargo run --example locations`

![Locations](examples/locations.png?raw=true "Locations")

### Modal

`cargo run --example modal`

![Modal](examples/modal.png?raw=true "Modal")

### Transparency

`cargo run --example transparency`

![Transparency](examples/transparency.png?raw=true "Transparency")

## Bevy Compatibility

|bevy|bevy_text_popup|
|---|---|
|0.11|0.1|