# bevy_mod_billboard

**Repository Path**: happydpc/bevy_mod_billboard

## Basic Information

- **Project Name**: bevy_mod_billboard
- **Description**: “bevy_mod_billboard”是一个针对 Bevy 游戏引擎的模块，旨在简化公告牌和 UI 元素的管理与展示。该模块允许开发者在游戏中轻松创建和配置公告牌，以显示文本或图像内容，增强玩家的交互体验。其设计考虑了性能与美观，适用于各种游戏场景，为开发者提供了灵活的选项以定制公告牌的外观和行为。
- **Primary Language**: Rust
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-03
- **Last Updated**: 2025-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# bevy_mod_billboard
Billboard text and texture support for bevy

![showcase](images/showcase.png)

## Todo
- Add documentation
- Follow Rust API Guidelines: https://rust-lang.github.io/api-guidelines/about.html
- Batching

## Features
- Styled text with multiple fonts.
- Textures.
- Depth culling enabling/disabling (enabled by default).
- Y-axis locking (disabled by default).
- Full rotation lock for stuff like 3D world-space text (@robftm)
- HDR support (@robtfm)

## Bevy Compatibility

| Bevy Version | Crate Version |
|--------------|---------------|
| `0.14`       | `0.7.0`       |
| `0.13`       | `0.6.0`       |
| `0.12`       | `0.5.1`       |
| `0.11`       | `0.4.1`       |
| `0.10`       | `0.3.0`       |
| `0.10`       | `0.2.1`       |
| `0.9`        | `0.1.1`       |

## Example

Setup:
```rs
use bevy_mod_billboard::prelude::*;

App::new()
    .add_plugins((DefaultPlugins, BillboardPlugin));
```

Text:
```rs
commands
    .spawn((
        BillboardText::default(),
        TextLayout::new_with_justify(JustifyText::Center),
        Transform::from_scale(Vec3::splat(0.0085)),
    ))
    .with_child((
        TextSpan::new("IMPORTANT"),
        TextFont::from_font(fira_sans_regular_handle.clone()).with_font_size(60.0),
        TextColor::from(Color::Srgba(palettes::css::ORANGE)),
    ))
    .with_child((
        TextSpan::new(" text"),
        TextFont::from_font(fira_sans_regular_handle.clone()).with_font_size(60.0),
        TextColor::from(Color::WHITE),
    ));
```

Texture:
```rs
commands.spawn((
    BillboardTexture(image_handle.clone()),
    BillboardMesh(meshes.add(Rectangle::from_size(Vec2::splat(2.0)))),
    Transform::from_xyz(0.0, 5.0, 0.0),
));
```

Full examples at [examples](examples).

## Changelog

### [0.7.0] - 2024-07-11
- Upgrade to Bevy 0.14 (@interwhy).
- Add Billboard marker component.

### [0.6.0] - 2024-06-09
- Upgrade to Bevy 0.13 (@RobWalt).
- Enable bevy's wayland & X11 features.

### [0.5.1] - 2023-12-05
- Fix billboard propagation not working.

### [0.5.0] - 2023-12-04
- Upgrade to Bevy 0.12 (@robftm).
- Remove texture array implementation.
- Use 1:N game world -> render world mapping.
- Remove asset type BillboardTexture.
- Add BillboardTextureHandle wrapper.
- Reduce memory usage.
- Increase performance for most used text case.
- Add stress_test example (@alice-i-cecile).
- Add rotating camera to most of the examples to showcase better.

## License

Licensed under either of

* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.