From 9c789fdc8bc708305f79da8f4cf105e16bc3da1b Mon Sep 17 00:00:00 2001 From: Digvijaysinh Gohil Date: Thu, 12 Oct 2023 23:06:13 +0530 Subject: [PATCH] Update README.md Document formatting --- README.md | 48 +++++++++++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 44b4f71..bf71c80 100644 --- a/README.md +++ b/README.md @@ -2,34 +2,36 @@ Visual shader node library for Godot engine. Adds various extra nodes to use in built-in visual shader editor. -## Installation +# Installation Copy the contents of **_addons/ShaderLib_** into the same folder in your project. No activation needed. Custom visual shader nodes work the same way as standard visual shader nodes. -## Uninstallation +# Uninstallation Delete the contents of **_addons/ShaderLib_** folder from your project. Make sure to delete it using the Godot editor instead of your default file system program. -## Nodes documentation -### Procedural nodes -___ +# Nodes documentation
-#### Voronoi node +

Procedural nodes

 +
+

Voronoi node

 Generates a Voronoi or Worley noise based on input UV. Voronoi noise is generated by calculating distances between a pixel and a lattice of points. By offsetting these points by a pseudo-random number, controlled by **_angle offset_**, a cluster of cells can be generated. - + **Inputs** |Name|Type|Binding|Description| |---|---|---|---| |uv|vec2|UV|Input UV value| |cell density|float|none|Density of generated cells| |angle offset|float|none|Offset values for points| - + **Outputs** |Name|Type|Binding|Description| |---|---|---|---| |output|float|None|Output noise value| |cells|float|None|Raw cell data| +___
-___ -### UV nodes -___ -#### Flipbook node +
+
+

UV nodes

 +
+

Flipbook node

 Creates a flipbook, or texture sheet animation, of the UVs supplied to input UV. The amount of tiles on the sheet are defined by the values of the inputs **_rows_** and **_columns_**. This node can be used to create a texture animation functionality, commonly used for particle effects and sprites, by supplying Time to the input Tile and outputting to the UV input slot of a Texture Sampler. @@ -48,7 +50,9 @@ This node can be used to create a texture animation functionality, commonly used |---|---|---|---| |uv|vec2|None|Output UV value| ___ -#### Radial Shear node +
+
+

Radial Shear node

 Applies a radial shear warping effect similar to a wave to the value of input UV. **Inputs** @@ -64,7 +68,9 @@ Applies a radial shear warping effect similar to a wave to the value of input UV |---|---|---|---| |uv|vec2|None|Output UV value| ___ -#### Rotate node +
+
+

Rotate node

 Rotates value of input UV around a reference point defined by input **_center_** by the amount of input **_rotation_**. **Inputs** @@ -80,7 +86,9 @@ Rotates value of input UV around a reference point defined by input **_center_** |---|---|---|---| |uv|vec2|None|Output UV value| ___ -#### Spherize node +
+
+

Spherize node

 Applies a spherical warping effect similar to a fisheye camera lens to the value of input UV. **Inputs** @@ -96,7 +104,9 @@ Applies a spherical warping effect similar to a fisheye camera lens to the value |---|---|---|---| |uv|vec2|None|Output UV value| ___ -#### Tiling and Offset node +
+
+

Tiling and Offset node

 Tiles and offsets the value of input UV by the inputs **_tiling_** and **_offset_** respectively. This is commonly used for detail maps and scrolling textures over TIME. **Inputs** @@ -111,7 +121,9 @@ Tiles and offsets the value of input UV by the inputs **_tiling_** and **_offset |---|---|---|---| |uv|vec2|None|Output UV value| ___ -#### Twirl node +
+
+

Twirl node

 Applies a twirl warping effect similar to a black hole to the value of input UV. **Inputs** @@ -127,3 +139,5 @@ Applies a twirl warping effect similar to a black hole to the value of input UV. |---|---|---|---| |uv|vec2|None|Output UV value| ___ +
+
\ No newline at end of file