Guidelines for Reporting Bugs and Issues

This document will detail guidelines on how to report bugs and issues found within the FLIP Fluids addon. We only support versions of the addon that have been distributed on Official Marketplaces of the FLIP Fluids Addon.

To get support for a bug or issue, a bug report must be filed to us either through the marketplace where you have purchased the FLIP Fluids addon, through the GitHub Issue Tracker, through the support form, or by email at support[at]flipfluids.com.

Guidelines

The following guidelines will give you some tips for how to create a good bug report. A good bug report allows us to track down the issue quickly and effectively so that the issue can be understood and responded to in a timely manner. If your bug report does not adhere to the following guidelines, you may be asked to resubmit your bug report. If you have any questions on how to file your bug report, please do not hesitate to ask us on the marketplace or through email at support[at]flipfluids.com!

Make sure that it is really a bug

We can only offer support for bugs/issues for versions of the addon that have been distributed on the official marketplaces. We cannot offer support for custom builds or alternative versions.

Check the Scene Troubleshooting document to make sure that it is not a scene issue and is infact an issue with the addon. If possible, check if the bug still exists in the latest version of the addon.

Avoid Duplicates

Check the FLIP Fluids issue tracker for bugs that have already been reported. Please check both open and closed bugs. You may use this filter to display all bugs that are open or closed.

Simplify

Try to simplify the process that triggers the bug so that it is reproducible in the least amount of steps. The .blend file should be as simple as possible. Simplicity allows us to get to the cause of the problem quickly and efficiently.

It is very important that the bug is reproducible. If the bug is not reproducible, there is little that we can do to test the issue.

Attach a .blend file

If your bug/issue is related to a scene, you must attach a .blend file. Describing the issue will not provide us enough information to work with in most cases. If reporting a bug through a marketplace message, you may attach the .blend file directly to your message if possible, or send files to support[@]flipfluids.com. If reporting a bug to the issue tracker, you will need to create .zip file of your scene in order to attach the file to the issue.

Scene File Guidelines

• Remove irrelevant data - Try to remove as many elements of the .blend file that are irrelevant to the issue. If there are textures and objects that are not related to the simulation or are not needed to reproduce the bug, remove them. This will keep the file size down and will make it easier for us to navigate your scene and narrow down what could be causing the issue.
• Use a lower resolution - If a simulation issue can be reproduced at a lower simulation resolution, please use this resolution in your scene. This will allow us to run your scene quickly and provide help in a timely manner. Long running scenes may require additional time to find a solution and respond to the issue.
• Provide a link to large scene files - if your .blend file is too large to be attached to the bug report, please provide a link to the file using an alternative hosting service such as Dropbox or use WeTransfer and send the file to support[at]flipfluids.com.
• Scene content must be Safe For Work - Please ensure that your scene does not contain content that would be considered inappropriate when viewed in a public office setting.

Be Complete

• Provide descriptive instructions for how to reproduce the issue or how to use your .blend file.
• Be descriptive of what the actual bug/issue is that you are experiencing. Describe what you expected to happen, and what actually happened.
• If you receive any error messages, please attach these to the bug report. Tip: you may retrieve the full error message by opening the Blender System Console. You can open this in Windows with Blender > Window > Toggle System Console or on Linux/MacOS by running Blender from the terminal.

When submitting a bug report, you must always provide the following information in your report:

Tip: This information can be filled out and copied to your clipboard by using the topbar Help > FLIP Fluids > Copy System Info operator (Help and Support Operators).

• Blender Version:
• FLIP Fluids Version:
• Operating System:
• CPU:
• GFX:
• RAM:

example:

• Blender Version: Blender 3.4
• FLIP Fluids Version: 1.5.0
• Operating System: Windows 10
• CPU: Intel i7-7700 @ 3.60GHz
• GFX: GTX 1080, 8GB
• RAM: 32GB