> For the complete documentation index, see [llms.txt](https://kripto289.gitbook.io/kripto289-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kripto289.gitbook.io/kripto289-docs/readme.md).

# Introduction

Welcome to **KWS2 Dynamic Water System** — a real-time, physically-based water simulation solution for Unity.\
This documentation will guide you through setup, usage, and best practices.

***

#### 🔷 Supported Platforms & Versions

**Unity versions:**\
• Unity 2022.3 and higher\
• Tested on LTS versions (2022.3, 6.0, 6.1)

**Render Pipelines:**\
• Built-in Render Pipeline\
• Universal Render Pipeline (URP)\
• High Definition Render Pipeline (HDRP)

KWS2 automatically detects and adapts to the active render pipeline.

***

#### 🔌 API & Platform Compatibility

* The current API version (**1.0.x**) officially supports **PC platforms** using **DirectX** and **Vulkan**.
* **Metal (macOS), consoles (PS5/Xbox), WebGPU, and VR** are **not tested** and **not officially supported**.
* **Mobile platforms** are **not supported** due to technical limitations of compute shaders — while some devices claim support, actual behavior is unreliable and cannot be guaranteed. Use at your own risk.

***

#### 🆘 Need Help?

If you have questions, feedback, or need technical support, feel free to reach out:

* 📩 **Email:** <kripto289@gmail.com>
* 💬 **Discord:** [Join the community](https://discord.gg/GUUZ9D96Uq)
* 🎥 **YouTube:** [Kripto289 on YouTube](https://www.youtube.com/@kripto289)
