Vastboard

A simple Valence plugin for making scoreboards easier to manage.

Its usage has been inspired by the FastBoard library for Bukkit.

Installation

Add Vastboard to your project

[dependencies]
vastboard = { git = "https://github.com/pepperoni21/vastboard" }

Add Vastboard plugin to your app

use vastboard::VastboardPlugin;

---

App::new()
    .add_plugins((DefaultPlugins, VastboardPlugin))

Usage

Create a scoreboard

create_vastboard(
    &mut commands, // Bevy Commands
    client_entity, // Client bevy entity
    "Title".into(), // Title of scoreboard (Text)
    vec![
        "Line 1".to_string(), // Lines
        "Line 2".to_string(), // Lines
        "Line 3".to_string(), // Lines
        "Line 4".to_string(), // Lines
        "Line 5".to_string(), // Lines
        "Line 6".to_string(), // Lines
    ]
);

Update the title/lines

You can update the title by updating the VastboardTitle component of the client entity with the new title and same for the lines with the VastboardLines component.

In this example, we update the title to "Sneaking" when the player starts sneaking, and "Not sneaking" when the player stops sneaking:

pub fn example_system(
    mut sneaking: EventReader<SneakEvent>,
    mut clients: Query<(&mut VastboardTitle, &mut VastboardLines)>
) {
    for event in sneaking.iter() {
        if let Ok((mut title, mut lines)) = clients.get_mut(event.client) {

            title.update(match event.state {
                SneakState::Start => "Sneaking",
                SneakState::Stop => "Not sneaking"
            }.bold());

            lines.update(vec![
                match event.state {
                    SneakState::Start => "Sneaking".to_string(),
                    SneakState::Stop => "Not sneaking".to_string()
                }
            ]);
        }
    }
}

Remove a scoreboard

remove_vastboard(
    &mut commands, // Bevy Commands
    client_entity // Client bevy entity
);

pepperoni21/vastboard