IMPORTANT: If you want to see the complete source code that does not include the Jet Framework as a submodule, see CubbyFlow-v0.
CubbyFlow is voxel-based fluid simulation engine for computer games based on Jet Framework that was created by Doyub Kim. The code is built on C++17 and can be compiled with commonly available compilers such as g++, clang++, or Microsoft Visual Studio. CubbyFlow currently supports macOS (10.12.6 or later), Ubuntu (17.04 or later), Windows (Visual Studio 2017 or later), and Windows Subsystem for Linux (WSL). Other untested platforms that support C++17 also should be able to build CubbyFlow.
Key Features (To do)
- Available fluid dynamics in computer games
- Support game engines (Unity, Unreal and so on)
- Support ML frameworks (TensorFlow, Caffe, Torch and so on)
- Real-time fluid simulation using ML
Every simulator has both 2-D and 3-D implementations.
You will need CMake to build the code. If you're using Windows, you need Visual Studio 2017 in addition to CMake.
First, clone the code:
git clone https://github.com/utilForever/CubbyFlow.git --recursive cd CubbyFlow
For macOS or Linux or Windows Subsystem for Linux (WSL):
mkdir build cd build cmake .. make
mkdir build cd build cmake .. -G"Visual Studio 15 2017 Win64" MSBuild CubbyFlow.sln /p:Configuration=Release
Now run some examples, such as:
All the documentations for the framework can be found from the project website incluing the API reference.
How To Contribute
Contributions are always welcome, either reporting issues/bugs or forking the repository and then issuing pull requests when you have completed some additional coding that you feel will be beneficial to the main project. If you are interested in contributing in a more dedicated capacity, then please contact me.
You can contact me via e-mail (utilForever at gmail.com). I am always happy to answer questions or help with any issues you might have, and please be sure to share any additional work or your creations with me, I love seeing what other people are making.
The class is licensed under the MIT License:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.