Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
YooPita authored May 17, 2022
1 parent a3849a7 commit 889346d
Showing 1 changed file with 26 additions and 10 deletions.
36 changes: 26 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,6 @@

Unity package. Flexible code to implement in your retro style project.

## Installation

Make sure you have standalone [Git](https://git-scm.com/downloads) installed first.
![alt text](https://github.com/YooPita/com.yoopita.retrotvfx/blob/master/DemoImages/installation.png)
And paste this: `https://github.com/YooPita/com.yoopita.retrotvfx.git#1.0.0`

## Features

- Easy to use. Just give it two textures: input and output
Expand All @@ -20,17 +14,39 @@ And paste this: `https://github.com/YooPita/com.yoopita.retrotvfx.git#1.0.0`
## Demonstration

This is the most popular example of dithering!
![alt text](https://github.com/YooPita/com.yoopita.retrotvfx/blob/master/DemoImages/md_sonic_demo.png)
![alt text](https://github.com/YooPita/com.yoopita.retrotvfx/blob/main/DemoImages/md_sonic_demo.png)

TV example. It's called "RenerTextureFx" and is located in the "Examples" folder.
![alt text](https://github.com/YooPita/com.yoopita.retrotvfx/blob/master/DemoImages/tv_demo.png)
![alt text](https://github.com/YooPita/com.yoopita.retrotvfx/blob/main/DemoImages/tv_demo.png)

Screen effect example. It's called "CameraFx" and is located in the "Examples" folder.
![alt text](https://github.com/YooPita/com.yoopita.retrotvfx/blob/master/DemoImages/tv_fx_2d_widescreen_demo.png)
![alt text](https://github.com/YooPita/com.yoopita.retrotvfx/blob/main/DemoImages/tv_fx_2d_widescreen_demo.png)

## Description of shader settings from the original repository

- Rolling sync flicker — enables a "rolling flicker" type effect you'd see when recording a CRT television with a camera
- Rolling flicker factor — sets the opacity of the rolling flicker effect
- Rolling V-Sync time — sets the phase duration of the V-Sync. 1.0 is perfectly synchronized and will not display any "rolling". Any value other than 1.0 will simulate the "desynchronized" effect
and cause it to roll faster or slower
- RF Noise — sets the amount of RF noise added to the image (RF only)
- YIQ Filter — allows the YIQ signal to be distorted. The chroma plane can be scaled and offset, and the luma signal can also be sharpened here
- Enable burst count animation — enable animating the NTSC burst phase, which causes the scanline flickering. Disabling this will freeze the animation and make the scanline artifacts more apparent, but some
old consoles did work this way.
- Anti flicker — when burst count animation is enabled, this adds an option to reduce the amount of flickering by blending the current and previous frames together. This adds a "motion blur" like effect, but reduces the amount of flickering which may be desirable.

## Installation

Make sure you have standalone [Git](https://git-scm.com/downloads) installed first.

![alt text](https://github.com/YooPita/com.yoopita.retrotvfx/blob/main/DemoImages/installation.png)

And paste this: `https://github.com/YooPita/com.yoopita.retrotvfx.git#1.0.0`

Or just copy the repository to your project files.

## About

This repository is based on this [repository](https://github.com/GlaireDaggers/RetroTVFX). This repository is an improved codebase to make it easier to implement into your project and write custom features with this effect. The author of the original repository did not like this implementation and offered to base his repository on top of it.

- NTSC effect shader by @GlaireDaggers
- Code architecture && examples by @YooPita
- Code architecture && examples by @YooPita

0 comments on commit 889346d

Please sign in to comment.