Krakatoa is a fast particle renderer for use in visual effects applications. More information can be found here.

This repository contains subdirectories with two different projects. The Krakatoa subdirectory contains the underlying code for the Krakatoa renderer itself. The KrakatoaSR subdirectory contains a C++ API for interacting with Krakatoa.

• Reporting Bugs/Feature Requests
• Security issue notifications
• Contributing
• Code of Conduct
• Licensing

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

• A reproducible test case or series of steps
• The version of our code being used
• Any modifications you've made relevant to the bug
• Anything unusual about your environment or deployment

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.

Contributions to Krakatoa are encouraged. If you want to fix a problem, or want to enhance the library in any way, then we are happy to accept your contribution. Information on contributing to Krakatoa can be found in CONTRIBUTING.md.

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.