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

# Watchdog Essentials

**Watchdog Essentials** is an optional addon for Operate My Server that provides automatic server monitoring and condition-based lifecycle actions.\
It is designed to detect unsafe or undesirable server states and respond accordingly - for example, by requesting a controlled restart or shutdown through OMS.

***

### Included Features

Currently included features:

* [**Low TPS**](/oms-wiki/addons/watchdog-essentials/low-tps.md)\
  Requests a controlled restart if the server TPS stays below a configured threshold for a specified duration.
* [**Empty Server**](/oms-wiki/addons/watchdog-essentials/empty-server.md)\
  Stops the server when no players are online for a configured period.
* [**Low Memory**](/oms-wiki/addons/watchdog-essentials/low-memory.md)\
  Monitors server memory and triggers a controlled restart when memory reaches a critical state.

***

### Configuration

The addon uses a single server-side config file:

```
world/serverconfig/watchdogessentials-server.toml
```

Each feature has its own subsection with options such as `enabled`, thresholds, timers, and feature-specific settings.

Detailed configuration instructions for each feature can be found on their respective pages.

***

### Installation

This addon is not bundled with OMS by default.\
To use it, download `watchdogessentials-x.y.z.jar` and place it into your server's `mods/` folder alongside OMS

You can download Watchdog Essentials from:

* [**CurseForge**](https://www.curseforge.com/minecraft/mc-mods/watchdog-essentials)
* [**Modrinth**](https://modrinth.com/mod/watchdog-essentials)
* [**OMS Maven**](https://c0nnor263.github.io/OperateMyServer/maven/)

Kotlin For Forge 4.11.0:

* [**CurseForge**](https://www.curseforge.com/minecraft/mc-mods/kotlin-for-forge)
* [**Modrinth**](https://modrinth.com/mod/kotlin-for-forge)

Required files:

* `oms-x.y.z.jar` - the core OMS mod
* `watchdogessentials-x.y.z.jar` - the Watchdog Essentials addon
* `kotlinforforge-4.11.0.jar` - required Kotlin runtime for OMS and Watchdog Essentials