https://github.com/foxzool/bevy_fog_of_war
A Bevy Plugin for Fog of War.
https://github.com/foxzool/bevy_fog_of_war
Last synced: about 1 year ago
JSON representation
A Bevy Plugin for Fog of War.
- Host: GitHub
- URL: https://github.com/foxzool/bevy_fog_of_war
- Owner: foxzool
- License: apache-2.0
- Created: 2025-01-06T03:05:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-21T11:31:46.000Z (about 1 year ago)
- Last Synced: 2025-05-21T12:42:13.097Z (about 1 year ago)
- Language: Rust
- Size: 1000 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Bevy Fog of War
[](https://github.com/foxzool/bevy_fog_of_war/actions)
[](https://crates.io/crates/bevy_fog_of_war)
[](https://crates.io/crates/bevy_fog_of_war)
[](https://docs.rs/bevy_fog_of_war)
[](https://github.com/Seldom-SE/seldom_pixel#license)
A fog of war implementation for the Bevy game engine. This crate provides a simple way to add fog of war effects to
your 2D games, with support for multiple light sources, smooth transitions, and explored area tracking.
## Features
- 2D fog of war with smooth transitions and customizable colors.
- Support for multiple dynamic vision sources with various shapes.
- Explored area tracking, with options for how explored areas remain visible.
- Chunk-based map processing for efficient updates, suitable for large maps.
- Snapshot system for persisting explored fog data.
- Highly configurable via the `FogMapSettings` resource.
- Efficient GPU-based implementation using WGSL compute shaders.
## Usage
To use `bevy_fog_of_war` in your project, follow these steps:
(You can import most commonly used items via `use bevy_fog_of_war::prelude::*;`)
1. **Add the plugin to your app:**
Add the `FogOfWarPlugin` to your Bevy `App`:
```rust
use bevy::prelude::*;
use bevy_fog_of_war::FogOfWarPlugin;
fn main() {
App::new()
.add_plugins(DefaultPlugins)
.add_plugins(FogOfWarPlugin) // Add the fog of war plugin
// ... other setup ...
.run();
}
```
2. **Add `FogOfWarCamera` to your camera:**
The plugin needs to know which camera is used for the fog of war effect. Add the `FogOfWarCamera` component to your main 2D camera entity.
```rust
use bevy::prelude::*;
use bevy_fog_of_war::prelude::FogOfWarCamera;
fn setup(mut commands: Commands) {
commands.spawn((Camera2d, FogOfWarCamera));
}
```
3. **Add `VisionSource` to entities:**
Entities that should reveal the map need a `VisionSource` component. You can create different shapes for the vision area, such as circles, squares, or cones.
```rust
use bevy::prelude::*;
use bevy_fog_of_war::prelude::VisionSource;
fn setup_entities(mut commands: Commands) {
// Spawn an entity with a circular vision source
commands.spawn((Transform::from_xyz(0.0, 0.0, 0.0), VisionSource::circle(200.0)));
// Spawn another entity with a square vision source
commands.spawn((Transform::from_xyz(100.0, 50.0, 0.0), VisionSource::square(150.0)));
}
```
4. **(Optional) Add `Capturable` to entities:**
If you have entities that should only become visible when a `VisionSource` overlaps them (and remain visible once discovered, depending on your fog settings), add the `Capturable` component to them.
```rust
use bevy::prelude::*;
use bevy_fog_of_war::prelude::Capturable;
fn setup_objects(mut commands: Commands) {
commands.spawn((
Sprite {
color: Color::srgb(0.2, 0.8, 0.8),
custom_size: Some(Vec2::new(60.0, 60.0)),
..default()
},
Capturable, // This entity will be revealed by vision sources
));
}
```
5. **Customize `FogMapSettings` (Optional):**
You can customize the fog of war behavior by inserting a `FogMapSettings` resource. Here's an example of how to configure it:
```rust
use bevy::prelude::*;
use bevy_fog_of_war::prelude::*;
use bevy::render::render_resource::TextureFormat;
fn setup_fog_settings(mut commands: Commands) {
commands.insert_resource(FogMapSettings {
enabled: true, // Enable/disable fog of war effect
chunk_size: UVec2::new(256, 256), // Size of each chunk in world units
texture_resolution_per_chunk: UVec2::new(512, 512), // Texture resolution per chunk
fog_color_unexplored: Color::rgba(0.1, 0.1, 0.1, 0.9), // Color for unexplored areas
fog_color_explored: Color::rgba(0.3, 0.3, 0.3, 0.5), // Color for explored but not visible areas
vision_clear_color: Color::NONE, // Clear color for visible areas (usually transparent)
fog_texture_format: TextureFormat::R8Unorm, // Texture format for fog
snapshot_texture_format: TextureFormat::R8Unorm // Texture format for snapshots
});
}
```
Then add the system to your app:
```rust
.add_systems(Startup, setup_fog_settings)
```
Check the [examples](examples/) directory for more detailed usage scenarios, including dynamic vision sources and different vision shapes.
## Compatibility
| Bevy Version | Plugin Version |
|--------------|----------------|
| 0.16 | 0.2.0 |
| 0.15 | 0.1.0 |
## License
This project is licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT)
at your option.
## Contributing
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as
defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.