Godot ISF Importer

The addon allows importing of an ISF file (.fs) into a PackedScene that contains the buffers and shaders required to run the effect.

After I get most features working, I hope to add an export button so that Godot can be used for developing ISF!

Installation

1. Clone this repo and move the directory under your projects /addons directory
2. Ensure that the addon path is /addons/godot-isf. Rename it if necessary
3. Enable the addon in your project settings

Usage

1. Drag in your .fs files to the project directory. They will be automatically converted to a scene file
2. Drag the effect into your scene
3. Go to the Material to set the input uniforms (hint: they're called Shader Parameters in Godot)

The generated ShaderMaterial is directly accessable on the node. You can peak at the inner workings by right clicking on it and ticking Editable Children

For audio reactive effects, audio input settings have to be enabled in your project

Features

• Basic ISF support
• Vertex Shaders
• Multi-passes
• Persistent buffers
• Audio reactivity (FFT)
• Import from standard ISF directory
• Ability to use the effects in 3D
• Export

Limitations

I did my best to follow the ISF specification, but unfortunately not every GLSL feature can be accounted for in Godot shaders

• Imported images will only work if Godot already supports the file type. So .tiff won't work, but .png/.jpg should work
• Function overloading. You will get an error if the ISF shader overloads a built in function. To fix it you will have to rename the function.
• Global variables aren't supported at all. Try adding const to them instead
• Buffer precision may not be 32-bit per channel. On compatibility it's 8-bit per channel

If you come across a limitation not listed here, please report it by filing an issue on this repository

Writing an ISF shader in Godot

TODO

Why not use CompositorEffect?

While CompositorEffect would bypass many limitations, it comes with some limitations of it's own

• Theres no 2D rendering support
• It's not available on the Compatibility renderer

This could change in the future.

Support

You can support this addon by reporting bugs and donating via kofi

https://ko-fi.com/celyk

Resources

https://github.com/mrRay/ISF_Spec

https://docs.isf.video/quickstart.html#using-isf-compositions

https://gist.github.com/dlublin/2df96d7e9f0a72dd9a1260d8309a722f

https://github.com/dreness/kodelife-generator/blob/main/src/klproj/isf_parser.py