> ## Documentation Index
> Fetch the complete documentation index at: https://docs.thunder-studio.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Real-time water level control for FiveM servers.

TS Flood lets admins control the map water level in real time from an in-game menu. You can smoothly raise or lower it, pick a preset mode, or force an instant level change.

<CardGroup cols={2}>
  <Card title="Installation" icon="download" href="/scripts/flood/installation">
    Setup guide and dependencies.
  </Card>

  <Card title="Configuration" icon="sliders" href="/scripts/flood/config">
    Preset modes, increase rate and keybinds.
  </Card>

  <Card title="Commands" icon="terminal" href="/scripts/flood/commands">
    Available in-game commands.
  </Card>

  <Card title="Events" icon="bolt" href="/scripts/flood/events">
    Client events and exports.
  </Card>
</CardGroup>

## Features

* In-game zUI menu to manage water level
* Smooth transitions with configurable rate
* Preset modes defined in config
* Manual level input and instant force option
* Client export to read the current water level
* EN / FR locale support via ox\_lib

## Dependencies

* [ts-lib](https://store.thunder-studio.net/download/ts-lib)
* [ox\_lib](https://coxdocs.dev/ox_lib)
* [zUI-v2](https://github.com/ZProject-Official/zUI-v2)
* [ts\_flood\_water](https://github.com/Thunder-Scripts/script-content/releases/tag/flood-scripts)
