soaos/bevy_dither_post_process
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Silas Bartha 2025-04-02 19:41:07 -04:00
parent 092b56799e
commit 8da65d0246
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -2,19 +2,17 @@
[![Crates](https://img.shields.io/crates/v/bevy_dither_post_process)](https://crates.io/crates/bevy_dither_post_process)
![License](https://img.shields.io/badge/license-0BSD%2FMIT%2FApache-blue.svg)
![Tag](https://img.shields.io/github/v/tag/exvacuum/bevy_dither_post_process)
[![Docs](https://img.shields.io/docsrs/bevy_dither_post_process)](https://docs.rs/bevy_dither_post_process)
A plugin for the [Bevy](https://bevyengine.org) engine which adds a dither post-processing effect.
The effect is implemented as a bilevel ordered dither using a Bayer matrix with a configurable level. It dithers the image to black and white only, and operates on the entire screen.
## Screenshots
![](https://git.exvacuum.dev/bevy_dither_post_process/plain/doc/screenshot.png)
![](https://git.exvacuum.dev/bevy_dither_post_process/plain/doc/screenshot_plant.png)
![](doc/screenshot.png)
![](doc/screenshot_plant.png)
Configuration Used:
```rs
bevy_dither_post_process::components::DitherPostProcessSettings::new(3, &asset_server);
bevy_dither_post_process::components::DitherPostProcessSettings::new(3, asset_server);
```
## Compatibility
@ -35,7 +33,7 @@ bevy_dither_post_process = "0.3"
### Using git URL in Cargo.toml
```toml
[dependencies.bevy_dither_post_process]
git = "https://git.exvacuum.dev/bevy_dither_post_process"
git = "https://git.soaos.dev/soaos/bevy_dither_post_process.git"
```
## Usage
@ -59,7 +57,7 @@ When spawning a camera:
```rs
commands.spawn((
// Camera3d...
bevy_dither_post_process::components::DitherPostProcessSettings::new(level, &asset_server);
bevy_dither_post_process::components::DitherPostProcessSettings::new(level, asset_server);
));
```