summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHenrique L. Alves <henriquelalves@gmail.com>2016-02-13 16:31:39 -0700
committerHenrique L. Alves <henriquelalves@gmail.com>2016-02-13 16:31:39 -0700
commit3992f6688c511029285c3ab61d39907ea6fa6ce1 (patch)
tree93cb27e97b33803f65052b4d001ebd0bd4cfbd60 /README.md
parent0d26ce765c5aa4b74bfaad34696327584d954cb7 (diff)
downloadplugin-godot-simple-crt-shader-3992f6688c511029285c3ab61d39907ea6fa6ce1.tar.gz
plugin-godot-simple-crt-shader-3992f6688c511029285c3ab61d39907ea6fa6ce1.tar.bz2
plugin-godot-simple-crt-shader-3992f6688c511029285c3ab61d39907ea6fa6ce1.zip
Updated README and screen sample image.
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6e4fc70..56bc07a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
# SimpleGodotCRTShader
-A simple Godot shader that simulates CRT Displays
+A simple Godot shader that simulates CRT Displays.
+
+# How to install
+Just clone the git repository and open the project using Godot.
+
+There are too 'main' scenes on the project: one of them is a Texture Shader ("ShaderTest.scn"), and the other one is a Display Shader ("ShaderTestsScreen.scn"). Both have the same type of shader implemented, but one of them get the UV's and colors directly from the texture, and the other one actually get the information from the display.
+
+# How the Shader works
+This Shader is made of 3 main components:
+
+* Distortion: It is the effect that causes the '3D'-like monitor effect.
+* Color Bleeding: Creates a small 'color bleeding' on the Red and Blue channel of close pixels.
+* Scanlines: Creates a strip of black, alpha lines that moves constantly on the screen.
+
+All the effects have Uniform variables, so they can be controlled without changing the code.
+
+The effects are based on these articles:
+
+* Distortion: http://www.geeks3d.com/20140213/glsl-shader-library-fish-eye-and-dome-and-barrel-distortion-post-processing-filters/2/
+* Color Bleeding and Scanlines: http://www.magneticrealms.com/posts/2014/02/03/a-crt-filter-without-shaders/
+
+A shoutout for the Godot developpers group on facebook! I would be completely lost without you guys, haha.
+
+The screen sample was made by 'ansimuz' - the art is in public domain (CC0), and can be found in: http://opengameart.org/content/country-side-platform-tiles.