bevy_simple_rich_text 0.6.0

A tiny rich text helper for Bevy
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

# bevy_simple_rich_text

[![crates.io](https://img.shields.io/crates/v/bevy_simple_rich_text.svg)](https://crates.io/crates/bevy_simple_rich_text)
[![docs](https://docs.rs/bevy_simple_rich_text/badge.svg)](https://docs.rs/bevy_simple_rich_text)
[![Following released Bevy versions](https://img.shields.io/badge/Bevy%20tracking-released%20version-lightblue)](https://bevyengine.org/learn/book/plugin-development/#main-branch-tracking)

A tiny, unambitious rich text helper for `bevy_ui` with a simple bbcode-inspired syntax.

## Usage

```rust
// Register style tags by spawning `StyleTag` with `TextFont`, `TextColor`,
// and any other arbitrary Component.
commands.spawn((
    StyleTag::new("lg"),
    TextFont {
        font_size: FontSize::Px(40.),
        ..default()
    },
));
commands.spawn((
    StyleTag::new("fancy"),
    TextColor(Color::hsl(0., 0.9, 0.7)),
    FancyText,
));

// And use them
commands.spawn(RichText::new("[lg]Hello [lg,fancy]World"));
```

See also [`examples/advanced.rs`](./examples/advanced.rs).

## Performance

Modifying a `RichText` completely rebuilds the `TextSpans`, so it's probably pretty slow.

But you can attach arbitrary marker components to styles to achieve fast animations.

## Compatibility

| `bevy_simple_rich_text`  | `bevy` |
| :--                      | :--    |
| `0.6`                    | `0.19` |
| `0.5`                    | `0.18` |
| `0.4`                    | `0.17` |
| `0.3`                    | `0.16` |
| `0.2`                    | `0.15` |
| `0.1`                    | `0.14` |

## Contributing

Please feel free to open a PR. The goal of this project isn't to support every feature or use-case, but to be good enough for simple projects while remaining very maintainable.

Please keep PRs small and scoped to a single feature or fix.