README.md

bevy_light_2d

General purpose 2D lighting for the bevy game engine. Designed to be simple to use, yet expressive enough to fit a variety of needs.

Features

• Component driven design
• Configurable point lights
• Light occlusion
• Dynamic shadows
• Camera specific ambient light
• Single camera rendering
• Web support for WebGL2 and WebGPU

Usage

In the basic example, all we need is the plugin, a camera, and a light source.

# Cargo.toml
[dependencies]
bevy = "0.15"
bevy_light_2d = "0.5"

use bevy::prelude::*;
use bevy_light_2d::prelude::*;

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

fn setup(mut commands: Commands) {
    commands.spawn(Camera2d);

    commands.spawn(PointLight2d {
        intensity: 3.0,
        radius: 100.0,
        ..default()
    });
}

To see an in depth example, use cargo run --example dungeon.

Motivation

When I first started experimenting with Bevy, the lack of a first party 2D lighting implementation left me wanting. While there were some rather impressive experimental 2D lighting crates out there, there wasn't much in the way of drop in options available.

My goal with this crate is to fill that void, prioritizing ease of use and general application over depth of features.

Bevy compatibility

bevy	bevy_light_2d
0.15	0.5
0.14	0.2..0.4
0.13	0.1

Acknowledgements

I'd like to thank the authors of the below crates; they were a significant source of inspiration.

• bevy-magic-light-2d
• bevy_2d_screen_space_lightmaps
• bevy_incandescent

Asset credits

• Pixel Dungeon by Pixel Poem