Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ahopness/godotretro

A pack of retro shaders to Godot!
https://github.com/ahopness/godotretro

glsl godot retro shader shaders

Last synced: 3 days ago
JSON representation

A pack of retro shaders to Godot!

Awesome Lists containing this project

README

        

[Looking for a godot 3.x compatible version?](https://github.com/ahopness/GodotRetro/tree/3.x)

------


💜 Godot Retro 💜


Old-school shader pack


Logo








## Sumary

* [About](#about)
* [License](#license)
* [Shaders](#shaders)
* [Installation](#installation)
* [Examples](#examples)
* [Features](#features)
* [Limitations](#limitations)
* [Credits](#credits)

## About

**Godot Retro** is a shader pack for godot, with various ports of shades from *ShaderToy*, *Unity* and The *Book Of Shaders*.

## License

* Shaders

All shaders are licensed under **CC0**, with the exeption of the *Glitch* and the *NTSC Basic* shaders, that are licensed under **MIT**.

* Example Scenes

*Models*, *scripts*, *textures* and *sounds* are all under **CC0**.

The *shrWind* shader, used in map 4, is made by **Maujoe** and it's licensed under **MIT**.

## Shaders

- Glitch

- NTSC Basic

- Grain

- Simple Grain

- Jpeg Compression

- Dithering

- Lens Distortion

- NTSC

- Simple Glitch

- TV

- VHS

- VHS Pause

- Accurate CRT

- B&W

- Better CC

- Blur

- Color Precission

- Sharpness

- Hello World

- Hello World 2

### Recommendation

The shaders looks better when they are combined!

**Example :**

This scene uses the following combination : **Lens Distortion + Grain + TV**

And this scene use this combination : **Lens Distortion + Sharpness + NTSC**

- Tip 1 : **Sharpness** is a must have if using any of the *TV*, *VHS* or the *NTSC* shaders for achieving a more realistic retro effect!

- Tip 2 : **Lens Distortion** and high FOV combined can give a MTV 2000 blumbers aesthetics if used correctly!

- Tip 3 : Be careful with **Grain**! It can get really messy really easily!

- Tip 4 : All of the shaders can go beyond their default range values, just open the shader code and just the numbers inside the *hint_range()* function in the variables section.

- Tip 5 : **ALWAYS** check the headers inside the shaders you are using, there's information about *compatibility*, *credits* and *licesing* in there!

## Installation

**To use the shaders you got to** :

1. Copy the *GodotRetro* folder to your project (can be anywhere)

***For normal shader*** :

2. Just add the shader to a *ShaderMaterial*.

***For screen space shaders*** :

2. Create a *ColorRect* and make it a *FullRect* in the *Layout* options

3. Assign the shader of preference to a *ShaderMaterial* in the used *ColorRect*.

**Example :**

![example](https://i.imgur.com/sSti5i8.png)

**Done!** Have fun!

### DISCLAMER :

- To use 2+ shaders at the same time, you need to use a BackBufferCopy set as a Viewport for each effect.

- For UI, be sure to set it above the shaders in the node hierarchy for them to be affected for more imersion.

## Examples

5 free and easy to learn examples are available with the pack.





**General controls**:

| ESC |
|-----------|
| Quit Game |

**Map 1 controls**:

| W | A | S | D | E | Q | Shift |
|--------|-----------|-----------|------------|-----------|-----------|-------|
| Foward | Turn Left | Backwards | Turn Right | Walk Left | Walk Left | Run |

**Map 4 controls**:

| A | D |
|-----------|------------|
| Move Left | Move Right |

## Features

- **22** easy to use godot shaders

- 5 well done **example projects**

## Limitations

Unfortnetly, some shaders arent 100% perfect.

- Some shaders may not work in the web export, please check each used shader's code header for more information!

## Credits

Shaders ported by : **Ahopness ([@ahopness](http://twitter.com/ahopness "My Twitter Account"))**

*B&W* shader where originaly made by : **demofox (ShaderToy)**

*Color Precission* shader where originaly made by : **abelcamarena (ShaderToy)**

*Jpeg Compression* shader where originaly made by : **paniq (ShaderToy)**

*Better CC* shader where originaly made by **Wunkolo(ShaderToy)**

*Lens Distortion* shader where originaly made by **jcant0n(ShaderToy)**

*Sharpness* shader where originaly made by **Nihilistic_Furry(ShaderToy)**

*Grain* shader where originaly made by **spl!te(GitHub) & martinsh(Personal Blog)**

*Simple Grain* shader where originaly made by : **juniorxsound (ShaderToy)**

*TV* shader where originaly made by : **ehj1 (ShaderToy)**

*VHS* shader where originaly made by : **FMS_Cat (ShaderToy)**

*VHS Pause* shader where originaly made by : **caaaaaaarter (ShaderToy)**

*NTSC* shader where originaly made by : **ompuco (ShaderToy)**

*NTSC Basic* shader where originaly made by : **keijiro (Github)**

*Glitch* shader where originaly made by : **keijiro (GitHub)**

*Simple Glitch* shader where originaly made by : **Gaktan (ShaderToy)**

*Blur* shader where originaly made by : **jcant0n (ShaderToy)**

*Hello World* and *Hello World 2* shaders where originaly made by : **Patricio Gonzalez Vivo**