bevy_lit 0.7.0

A lighting 2d library for Bevy
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

![bevy_lit demo](https://github.com/malbernaz/bevy_lit/raw/main/static/demo.webp)

# `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:

```sh
cargo add bevy_lit
```

Or add `bevy_lit` to your `Cargo.lock`:

```toml
[dependencies]
bevy_lit = "*"
```

### Usage

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

```rust
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

| `bevy` | `bevy_lit` |
| ------ | ---------- |
| `0.16` | `0.7`      |
| `0.15` | `0.4..0.6` |
| `0.14` | `0.3`      |


## Contributing

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

## License

`bevy_lit` is licensed under the MIT License. See [LICENSE](LICENSE) for more details.