/love2dfluid

Fluid dynamics system for LÖVE2D

Primary LanguageLuaMIT LicenseMIT

LÖVE 2D Fluid

love2dfluid is a real time fluid simulation framework for LÖVE2D

Screenshot

About

The fluid system in this repository was originally created as a self decided school project. The main idea is to allow easy fluid particle integration in two-dimensional environments for the LÖVE2D framework while still maintaining a steady performance for normal game related processing. The repository is still work in progress meaning that all of the current developments are subject to change.

Implementation

To add the fluid framework to your LÖVE2D project all you have to do is to insert the fluidsystem.lua file into your love-project's root folder. From there you will have to add require("fluidsystem") to the start of your main.lua file. Creating new fluid systems is quite simple. The module allows developers to easily create new systems by calling fluidsystem.new(parameters). The function takes in a table containing named variables which will be assigned to the newly created system. The system is then returned as a reference and can then be directly manipulated. There are also a set of other functions that can be used to more closely manage the entire fluid system.

For more information on these please refer to FUNCTIONS.md. For a list of variables that can be passed when creating a new system have a look at PARAMETERS.md.

License

This repository is released under the MIT license. For more information please refer to LICENSE