docs.rs failed to build bevy_lit-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: bevy_lit-0.6.0

`bevy_lit`

bevy_lit is a simple and easy-to-use 2D lighting library for Bevy, designed to work seamlessly with a single camera setup. The library provides basic lighting functionalities through the types: AmbientLight2d, LightOccluder2d, and PointLight2d.

bevy_lit demo

Features

AmbientLight2d: Provides a general light source that illuminates the entire scene uniformly.
LightOccluder2d: Creates shadows and blocks light from PointLight2d.
PointLight2d: Emits light from a specific point, simulating light sources like lamps or torches.

Disclaimer

Please note that bevy_lit is in an early development stage. Users will find bugs and incomplete features. Additionally, the documentation is currently lacking. I appreciate any feedback and contributions to help improve the library.

Getting Started

Installation

Note: bevy_lit is not yet available as a crate on crates.io.

To use it, you can clone the repository directly from GitHub - if you want to fine tune the library to your needs. Or add it to your Cargo.lock:

[dependencies]
bevy_lit = { git = "https://github.com/malbernaz/bevy_lit" }

Demo

cargo run --example basic

Usage

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

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

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            Lighting2dPlugin {
                ambient_light: AmbientLight2d {
                    brightness: 0.2,
                    color: Color::Srgba(Srgba::hex("#C09AFE").unwrap()),
                },
                shadow_softness: 32.0,
            },
        ))
        .add_systems(Startup, setup)
        .run();
}

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

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

    commands.spawn(LightOccluder2dBundle {
        light_occluder: LightOccluder2d::new(Vec2::new(50.0, 50.0)),
        transform: Transform::from_xyz(0.0, 200.0, 0.0),
        ..default()
    });
}

Implementation

bevy_lit uses signed distance fields (SDFs) to compute the occluders' distances. To soften the shadows, a blur is applied. This approach is not ideal and might have limitations in terms of performance and visual accuracy, but it provides a starting point for basic 2D lighting effects.

Acknowledgement

This library took heavy inspiration from the work of other developers. I learned a lot about lighting and Bevy development by reading the source code of the following crates:

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.

bevy_lit 0.1.0

bevy_lit