Fluid dynamics for Unity's VFX graph
Branch: master
Clone or download
Latest commit c08ddd4 Feb 5, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Simplify/fix install process, format fixes Jan 8, 2019
Documentation~ Make sure documentation folder isn't ignored Jan 8, 2019
Editor Get rid of SizeMultiplier - redundant and not relevant to simulation Feb 5, 2019
Install 0.3 candidate Feb 4, 2019
ReflectionHelpers 0.2 WIP candidate Jan 15, 2019
Shaders Tweak defaults and constants Feb 5, 2019
.gitignore Make sure documentation folder isn't ignored Jan 8, 2019
Editor.meta Reorganize the repo so Unity can find the package from GitHub Jan 8, 2019
Install.meta Reorganize the repo so Unity can find the package from GitHub Jan 8, 2019
LICENSE.md Reorganize the repo so Unity can find the package from GitHub Jan 8, 2019
LICENSE.md.meta Reorganize the repo so Unity can find the package from GitHub Jan 8, 2019
README.md Update README.md Feb 5, 2019
README.md.meta 🚀 Jan 7, 2019
ReflectionHelpers.meta 0.2 WIP candidate Jan 15, 2019
Shaders.meta Reorganize the repo so Unity can find the package from GitHub Jan 8, 2019
Thinksquirrel.FluvioFX.Runtime.asmdef Reorganize the repo so Unity can find the package from GitHub Jan 8, 2019
Thinksquirrel.FluvioFX.Runtime.asmdef.meta
package.json 0.3 candidate Feb 4, 2019
package.json.meta Reorganize the repo so Unity can find the package from GitHub Jan 8, 2019

README.md

FluvioFX

FluvioFX logo

🚧 Active development 🚧

FluvioFX is currently in early active development. While we will try to maintain backwards compatibility, until 1.0 certain features may be added or removed at any time. Use in larger production projects with care.

Requirements

Unity version

2018.3+

Render pipelines

Fluvio does not handle rendering on its own, instead relying on the Visual Effect Graph for that functionality. As such, HDRP is highly recommended. The legacy pipeline may work, but is not currently supported.

Installation

To install this project, add the following line to dependencies in your manifest.json (in the Packages subfolder of your Unity project):

"com.thinksquirrel.fluviofx": "https://github.com/thinksquirrel/fluviofx.git"

Currently, FluvioFX requires a small patch that must be added to the Visual Effect Graph package before usage. This is needed in order to access some internal classes. Once imported, this process should happen automatically. A FLUVIOFX compilation file will then be automatically added to the current (and any future) build platforms, which will allow Unity to load the FluvioFX assembly.

If you have any compiler errors after importing or reimporting packages, try the following:

  1. Run Tools > FluvioFX > Install...
  2. If the above menu is missing or any files are still broken, try to uninstall and reinstall both FluvioFX and the Visual Effect Graph

This workaround will be removed once the VFX Graph's API has been finalized. See FluvioFXInstall.cs for the full implementation, including all file modifications.

Getting started

To create a new fluid VFX asset, navigate to Assets > Create > Visual Effects > FluvioFX Graph. You can also add a Fluid Particle System to an existing graph under the Systems menu in the graph.

The default graphs include many helpful sticky notes with more information, so it is highly recommended to use this for initial setup.

Documentation

See full documentaion here. Full documentation is coming soon! For now, take a look at the sticky notes in the graph for help.

Examples

Coming soon!

License

MIT