diff options
author | Silas Bartha <[email protected]> | 2024-04-24 14:03:15 -0400 |
---|---|---|
committer | Silas Bartha <[email protected]> | 2024-04-24 14:03:15 -0400 |
commit | f98b27592b2482dc89adc055073a3ee015f2424e (patch) | |
tree | 43a52b2ba3640a0711306beee74cc27273d2f017 /README.md |
Initial Commitv0.1.0
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7c497cd --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# grex_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 +![](./doc/screenshot.png) +![](./doc/screenshot_plant.png) +Configuration Used: +```rs +grex_dither_post_process::components::DitherPostProcessSettings::new(3, images); +``` +## Compatibility + +| Crate Version | Bevy Version | +|--- |--- | +| 0.1 | 0.13 | + +## Installation + +### Using git URL in Cargo.toml +```toml +[dependencies.grex_dither_post_process] +git = "https://github.com/exvacuum/grex_dither_post_process.git" +``` + +## Usage + +In `main.rs`: +```rs +use bevy::prelude::*; +use grex_dither_post_process; + +fn main() { + App::new() + .add_plugins(( + DefaultPlugins, + grex_dither_post_process::DitherPostProcessPlugin, + )) + .run(); +} +``` + +When spawning a camera: +```rs +commands.spawn(( + // Camera3dBundle... + grex_dither_post_process::components::DitherPostProcessSettings::new(level, images); +)); +``` + +This effect will only run for cameras which contain this component. + |