Guidelines for Requesting Scene Troubleshooting Help

Ryan Guy edited this page Jul 6, 2018 · 1 revision

This document will detail guidelines on how to request help with troubleshooting simulation and scene issues in the FLIP Fluids addon. We can only support versions of the addon that have been distributed on the Blender Market. Contact us for support with scene troubleshooting if you are having trouble with a simulation setup, need guidance on simulation settings, or require advice on how to execute an idea.

To get support for scene troubleshooting issues, you must contact us through the Blender Market messaging system. If you think that your scene issue is actually a bug, please submit a bug report.

Guidelines

The following guidelines will give you some tips for how to request support effectively so that we can begin to help you quickly and efficiently. If your request does not adhere to the following guidelines, or you do not provide enough information, you may be asked to clarify some details or resubmit your request. If you have any questions on how to request scene troubleshooting support, please do not hesitate to ask us on the Blender Market or through email at flip.fluids[at]gmail.com!

Check the Documentation

Before requesting help, please check the documentation for any info regarding your issue.

The Scene Troubleshooting document lists common scene and simulation problems and details how to resolve these issues. Your issue may already be listed with an easy fix.

If you are having trouble with certain simulation setting(s), take a look at the Settings Documentation. This area of documentation describes simulation settings for the Domain, Fluid, Obstacle, Inflow, and Outflow objects.

Attach a .blend file

To receive help with a scene or simulation, you must attach a .blend file. Describing the issue will not provide us enough information to work with in most cases. You may attach a .blend file directly to your Blender Market message.

Scene File Guidelines

  • Remove irrelevant data - If textures and objects not related to the simulation are not needed to demonstrate the issue, please remove them. This will keep the file size down and will make it easier for us to navigate your scene.
  • Set a relative cache directory - please set your cache directory to be relative to the .blend file (ex: //flip_fluid_cache).
  • 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 take us extra 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.

Be Complete

  • Provide descriptive instructions for how to reproduce the issue or how to use your .blend file.
  • Be descriptive of what the actual scene issue is that you are experiencing. Describe what you have tried and what did or did not seem to work. Tell us what you expected to happen, and what actually happened.
  • If the issue is visual, attaching a screenshot or animation can help greatly with communicating the problem

When submitting a request for help, you must always provide the following information:

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

example:

  • Blender Version: Blender 2.79
  • FLIP Fluids Version: 1.0.4
  • Operating System: Windows 10
  • CPU: Intel i7-7700 @ 3.60GHz
  • GFX: GTX 1080, 8GB
  • RAM: 32GB
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.