This article explains how to prepare an effective error report so our Support team can reproduce and resolve issues quickly.
Overview
As with any piece of software, it is possible that users occasionally face bugs like artifacts, crashes, errors, etc. - in such cases please contact the Chaos Support team.
The Chaos Support will investigate the report, determine the cause and where possible - provide a suitable workaround, so that you may continue working on your project, while our teams resolve the issue.
To make the process as smooth and efficient as possible, it is greatly appreciated when sufficient information is provided.
Submitting a Report
Make research prior to reporting - the issue might have already been discussed and fixed. Checking the Chaos Forums or a quick Google search can help you find a solution or a workaround.
1. Describe the issue in detail
Keep it brief, but clear. A shortlist of steps to reproduce the issue is always helpful, and feel free to provide any additional information. Be precise - make sure to report the exact names of features, functionalities, UI element states, and options.
2. Provide information about the environment
3. Provide reproduction steps
Provide an extensive list of steps to reproduce the issue. Let us know if the issue is only reproducible with a specific project, or on any scene, even a new one. Example:
4. Provide a screenshot or record a video/gif
Attaching a screenshot that clearly illustrates how the issue looks like when it is reproduced will help ensure that Chaos Support is on the right track.
Recording a video of the screen showing each step is just as easy and is quite helpful. There are a number of free and easy-to-use screen-capturing tools on the internet. Take a look at How to record a video for the Chaos support article.
5. Provide logs and Crash Dump files
These steps should supply the Chaos Support team with sufficient information to work with. If a bug is reproduced, it is added to the internal bug tracking system, from where the developers pick up the case. Otherwise, the Support team will request additional information.
Any file that can help identify and replicate the problem is useful. It ensures that the report is well understood by the Support team and sets a focus point when working on the issue’s reproduction. For example, when having trouble with animation flickering, provide a few rendered frames where the flickering is visible.
There are a few key files that you should always attach:
Render outputs. Share images and specify where the issue is visible.
Project files. Providing the project files is essential for reproducing the problem.
They act as a foundation when working on an issue’s fix. Make sure to include all external assets that are crucial to replicating the issue - such as proxy files, textures, or simulation caches. Include any assets used by Third-party plugins such as ForestPack, MultiScatter, Yeti, etc. in the scene if they are relevant for the reproducing of the issue.
Take a look at How to upload files to Chaos Support article for specific instructions for each host application.
7. Submitting all collected data
Use one of the following methods to share files securely with our team:
- Package the data: Use any convenient archive type such as .zip, .7z, etc.
- Provide access details: Ensure sharing permissions or credentials are included if needed.
- Send by Email (only small files): Attach the archive directly to your email reply.
- Preferred method: Use our contact form uploader to upload up to 100 GB and 100 files - no external platforms required.
- Large projects: In cases where the project files are large and cannot be sent through any of the above-mentioned methods, the Chaos Support team will provide access to secure servers, where the data may be uploaded.