bevy_lit

A simple 2D lighting library designed for Bevy. It provides basic lighting features through the types:

• Lighting2dSettings: Controls lighting parameters such as shadow softness.
• AmbientLight2d: Provides a general light source that illuminates the entire scene uniformly.
• PointLight2d: Emits light from a specific point, simulating light sources like lamps or torches.
• LightOccluder2d: Creates shadows and blocks light from PointLight2d along side any Mesh2d.

Getting Started

Installation

Install it using the CLI:

cargo add bevy_lit

Or add bevy_lit to your Cargo.lock:

[dependencies]
bevy_lit = "*"

Usage

Below is a basic example demonstrating how to set up and use bevy_lit in your project:

use bevy::prelude::*;
use bevy_lit::prelude::*;

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

fn setup(mut commands: Commands, mut meshes: ResMut<Assets<Mesh>>) {
    commands.spawn((
        Camera2d,
        Lighting2dSettings::default(),
    ));

    commands.spawn(PointLight2d {
        color: Color::WHITE,
        intensity: 3.0,
        radius: 200.0,
        falloff: 2.0,
        ..default(),
    });

    commands.spawn((
        Mesh2d(meshes.add(Circle::new(50.0))),
        LightOccluder2d::default()),
        Transform::from_xyz(0.0, 200.0, 0.0)
    ));
}

Compatibility

Acknowledgement

This library took great inspiration from the following crates:

• bevy_light_2d
• bevy-magic-light-2d
• bevy_mod_outline

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

bevy_lit is licensed under the MIT License. See LICENSE for more details.