https://github.com/malbernaz/bevy_lit
A lighting 2d library for Bevy
https://github.com/malbernaz/bevy_lit
Last synced: 9 months ago
JSON representation
A lighting 2d library for Bevy
- Host: GitHub
- URL: https://github.com/malbernaz/bevy_lit
- Owner: malbernaz
- License: mit
- Created: 2024-07-22T20:41:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-18T00:13:20.000Z (11 months ago)
- Last Synced: 2025-03-30T01:09:12.245Z (9 months ago)
- Language: Rust
- Size: 2.12 MB
- Stars: 47
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `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>) {
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.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.