# config.yml

## ⚙️ Main Configuration

Below is the main configuration section of **LagFixer**.\
It controls general behavior, performance monitoring, error reporting, and command settings.

```yaml
main:
  prefix: "&8[&e&l⚡&8] "
  prefix_hover: true
  monitor:
    resource:
      enabled: true
      interval: 5
    worlds:
      enabled: true
      interval: 30
    map:
      enabled: true
      interval: 3
  errors_reporter: true
  updater: true
  warnings: true
  bStats: true
  command:
    permission: "lagfixer.command"
    aliases:
      - lf
      - antilag
      - lag
```

***

### 🧩 Option Explanations

#### 🔹 `prefix`

Sets the message prefix for all LagFixer chat messages.\
You can use Minecraft color codes (`&e`, `&8`, `&l`, etc.).

**Example:**\
`"&8[&e&l⚡&8] "` → displays as **\[⚡]** in gold and gray.

***

#### 🔹 `prefix_hover`

When enabled (`true`), hovering over the prefix in chat will show plugin version information.\
Useful for quick diagnostics and ensuring everyone runs the latest version.

***

### 📊 Monitor Settings

#### 🖥️ `monitor.resource`

Monitors server resources (TPS, MSPT, CPU usage).

* `enabled`: `true` = on, `false` = off.
* `interval`: How often (in seconds) data is refreshed.\
  \&#xNAN;*Recommended: 5 seconds.* Lower interval provides more frequent updates at minimal CPU cost.

#### 🌍 `monitor.worlds`

Monitors per-world load (entities, chunks, tiles).

* `enabled`: Enable/disable world data collection.
* `interval`: Refresh interval in seconds.\
  \&#xNAN;*Default: 30 seconds* – less frequent updates are sufficient for trend analysis.

#### 🗺️ `monitor.map`

Performance data shown in the map command (`/lagfixer map`).

* `enabled`: Whether the map should be updated.
* `interval`: Map data update interval (in seconds).\
  \&#xNAN;*Recommended:* At least twice as high as `monitor.resource.interval` to avoid overloading the server.\
  Example: If `resource.interval = 5`, then `map.interval = 10` or higher.

***

#### 🔹 `errors_reporter`

If `true`, LagFixer automatically reports unexpected errors and profiler data to the support team for faster debugging.\
Disable this only if you prefer full privacy or run the plugin in a restricted environment.

***

#### 🔹 `updater`

When enabled, LagFixer will automatically check for new updates and notify you in console and chat.\
Recommended to keep it on for security and performance improvements.

***

#### 🔹 `warnings`

Shows console warnings for outdated or legacy API methods that may not be supported in newer Minecraft versions.\
Useful for server owners and developers who want compatibility awareness.

***

#### 🔹 `bStats`

Enables anonymous performance statistics through [bStats.org](https://bstats.org/plugin/bukkit/LagFixer/19292).\
This helps the developer improve LagFixer based on global usage data.\
No personal information is collected.

***

### ⚙️ Command Settings

#### 🔹 `command.permission`

Defines the permission required to use `/lagfixer` and related commands.\
**Default:** `"lagfixer.command"`

You can assign this permission to admins or trusted staff members.

***

#### 🔹 `command.aliases`

A list of alternative command names that can be used instead of `/lagfixer`.\
**Default aliases:**

* `/lf`
* `/antilag`
* `/lag`

These can be customized freely.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://lajczik.gitbook.io/lagfixer/configuration/config.yml.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.