From ebe2694f6d8c05c1680993defd188c433ff83909 Mon Sep 17 00:00:00 2001 From: Digvijaysinh Gohil <48823553+DigvijaysinhGohil@users.noreply.github.com> Date: Thu, 12 Oct 2023 00:45:19 +0530 Subject: [PATCH] Update README.md Documentation for FlipbookUV node. --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 3e81840..bd3538a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ # Godot-Shader-Lib Visual shader node library for Godot engine. + +Adds various extra nodes to use in built-in visual shader editor. +## 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 standart visual shader nodes. +## 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 +### UV nodes +___ +#### Flipbook uv 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. + +**Inputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|uv|vec2|UV|Input UV value| +|rows|int|none|Amount of horizontal tiles in texture sheet| +|columns|int|none|Amount of vertical tiles in texture sheet| +|start frame|int|none|Start tile index texture sheet| +|end frame|int|none|End tile index texture sheet| +|anim speed|float|none|Animation speed| + +**Outputs** +|Name|Type|Binding|Description| +|---|---|---|---| +|uv|vec2|None|Output UV value| +___