2 unstable releases
0.2.0 | Jul 28, 2024 |
---|---|
0.1.0 | Jul 21, 2024 |
#515 in Game dev
24 downloads per month
42KB
765 lines
bevy_mod_bbcode
Rich text support in Bevy using a custom BBCode markup flavor.
Bevy Compatibility
bevy version |
bevy_mod_bbcode version |
---|---|
0.14 |
0.1 - 0.2 |
Installation
cargo add bevy_mod_bbcode
Usage
Instead of spawning a TextBundle
, spawn a BbcodeBundle
!
use bevy::prelude::*;
use bevy_mod_bbcode::{BbcodeBundle, BbcodePlugin, BbcodeSettings};
fn main() {
App::new()
// Register the font files stored in `assets/fonts`
.add_plugins((DefaultPlugins, BbcodePlugin::new().with_fonts("fonts")))
.add_systems(Startup, setup)
.run();
}
fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
commands.spawn(Camera2dBundle::default());
commands.spawn(BbcodeBundle::from_content(
"test [b]bold[/b] with [i]italic[/i] and [c=#ff00ff]color[/c]",
// Use the "Fira Sans" font family with a default font size of 40
BbcodeSettings::new("Fira Sans", 40., Color::WHITE),
));
}
See examples
for more usage patterns!
Supported Tags
b
: [b]bold[/b] texti
: [i]italic[/i] textc
: [c=#ff0000]colored[/c] text- Register named colors via
ResMut<ColorMap>
and use the names instead of hex values
- Register named colors via
m
: [m=foo]text with marker component[/m]- Register marker components via
BbcodeSettings::with_marker
and use them to update text dynamically
- Register marker components via
font
: [font="Fira Sans"]change the font family[/font]
License
This project is licensed under the terms of the MIT or Apache 2.0 license at your choice.
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.
Note that the assets used in the examples might use different licenses, see assets/CREDITS.md
.
Dependencies
~40–77MB
~1.5M SLoC