bevy_light_2d 0.6.0

General purpose 2d lighting for the Bevy game engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# `bevy_light_2d`

[![Discord](https://img.shields.io/discord/805147867924267018?logo=discord&color=7289DA)](https://discord.gg/yZmJgXnqfv)
[![Crates.io](https://img.shields.io/crates/v/bevy_light_2d)](https://crates.io/crates/bevy_light_2d)
[![docs](https://docs.rs/bevy_light_2d/badge.svg)](https://docs.rs/bevy_light_2d/)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jgayfer/bevy_light_2d/blob/master/LICENSE)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/jgayfer/bevy_light_2d/build.yml)
[![Crates.io](https://img.shields.io/crates/d/bevy_light_2d)](https://crates.io/crates/bevy_light_2d)

General purpose 2D lighting for the [`bevy`](https://bevyengine.org/) game engine.
Designed to be simple to use, yet expressive enough to fit a variety of needs.

<img src="https://github.com/jgayfer/bevy_light_2d/blob/main/static/dungeon.gif?raw=true" width="400">

## 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`](https://github.com/jgayfer/bevy_light_2d/blob/main/examples/basic.rs) example, all we need is the plugin, a camera, and a light source.

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

```rust
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.16 | 0.6           |
| 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`](https://github.com/zaycev/bevy-magic-light-2d)
- [`bevy_2d_screen_space_lightmaps`](https://github.com/goto64/bevy_2d_screen_space_lightmaps)
- [`bevy_incandescent`](https://github.com/443eb9/bevy_incandescent)

## Asset credits

- [Pixel Dungeon](https://pixel-poem.itch.io/dungeon-assetpuck) by [Pixel Poem](https://pixel-poem.itch.io/)