https://github.com/shanecelis/bevy_terminal_shader

An old school terminal shader for the bevy game engine
https://github.com/shanecelis/bevy_terminal_shader

Last synced: about 1 month ago
JSON representation

An old school terminal shader for the bevy game engine

• Host: GitHub
• URL: https://github.com/shanecelis/bevy_terminal_shader
• Owner: shanecelis
• License: apache-2.0
• Created: 2024-01-09T09:39:29.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-07-23T06:58:02.000Z (5 months ago)
• Last Synced: 2024-10-07T17:34:45.782Z (3 months ago)
• Language: WGSL
• Size: 1.3 MB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# bevy_terminal_shader

![Maintenance](https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg)

[![CI](https://github.com/shanecelis/bevy_terminal_shader/actions/workflows/rust.yml/badge.svg)](https://github.com/shanecelis/bevy_terminal_shader/actions)

  [![crates-io](https://img.shields.io/crates/v/bevy_terminal_shader.svg)](https://crates.io/crates/bevy_terminal_shader)

  [![api-docs](https://docs.rs/bevy_terminal_shader/badge.svg)](https://docs.rs/bevy_terminal_shader)

This crate provides an old school terminal-like, or oscilloscope, effect that

can be applied to 2D and 3D objects on the [bevy game

engine](https://bevyengine.org).

![Terminal shader example](https://github.com/shanecelis/bevy_terminal_shader/assets/54390/05308e0a-439f-4ae8-9aa2-07144222aa3e)

# Install

``` sh

cargo add bevy_terminal_shader

```

# Usage

## Add plugin to app

```compile

use bevy::prelude::*;

fn main() {

    App::new()

        .add_plugins(bevy_terminal_shader::TerminalShaderPlugin)

        .run()

}

```

## Add settings to camera

```compile

use bevy::prelude::*;

fn setup(

    mut commands: Commands,

    mut meshes: ResMut>,

    mut materials: ResMut>) {

    commands.spawn(Camera2dBundle::default());

    

    commands.spawn(MaterialMesh2dBundle {

        mesh: meshes

            .add(shape::Quad::new(Vec2::new(1300., 800.)).into())

            .into(),

        material: materials.add(TerminalMaterial::green()),

        ..default()

    });

```

# Example

Run the "quad" example like so:

``` sh

cargo run --example quad

```

This will show a large quad like the one shown at the beginning of this README.

``` sh

cargo run --example cube

```

This will show a rotating cube with the shader as its surfaces.

# TODO

- [ ] Consider renaming crate to `bevy_oscilloscope_shader`.

# Compatibility

| bevy_terminal_shader | bevy   |

|----------------------|--------|

| 0.2                  | 0.14   |

| 0.1                  | 0.12.1 |

# License

This crate is licensed under the MIT License or the Apache License 2.0 or CC0 License.

# Acknowlegments

* [Terminal Shader](https://www.shadertoy.com/view/DdSGzy) by [mrange](https://www.shadertoy.com/user/mrange) originally released under the CC0 License.

* [The sRGB Learning Curve](https://medium.com/@tomforsyth/the-srgb-learning-curve-773b7f68cf7a) by [Tom Forsyth](https://mastodon.gamedev.place/@TomF).