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

# Global Configuration

## Global Configuration

Config lives at `plugins/SimplyMines/config.yml`. Most day-to-day mine settings (block composition, reset timers, warnings, physics, requirements) are edited through the in-game GUI rather than this file — `config.yml` mainly controls global plugin behavior and every user-facing message.

{% hint style="info" %}
Any message key is added automatically (with its default value) the first time the plugin needs it, so `config.yml` will grow as you use more features. Run `/sm reload` after editing it by hand.
{% endhint %}

***

### Global settings

{% code title="config.yml" %}

```yaml
# Change ONLY if you know what you are doing
max_workload: 20000000       # hard cap on queued block placements across all mines
save_mines_seconds: 1800     # how often mines are auto-saved to disk, in seconds
max_milles_per_tick: 2.5     # workload budget per server tick, in milliseconds
```

{% endcode %}

| Setting               | Description                                                                           |
| --------------------- | ------------------------------------------------------------------------------------- |
| `max_workload`        | Safety ceiling on the total number of pending block placements in the workload queue. |
| `save_mines_seconds`  | Interval for the periodic auto-save of all mines to their JSON files.                 |
| `max_milles_per_tick` | How much of each server tick (in ms) the Workload System may spend placing blocks.    |

{% hint style="warning" %}
Raising `max_milles_per_tick` speeds up resets but increases tick lag; lowering it does the opposite. Only change it if you understand the trade-off.
{% endhint %}

***

### Messages

Every player-facing message supports [MiniMessage](https://docs.advntr.dev/minimessage/format.html) formatting and is fully overridable. Placeholders like `<mine>`, `<x>`, `<y>`, `<z>`, `<seconds>`, `<level>`, and `<input>` are substituted per-message where relevant.

{% code title="config.yml" %}

```yaml
messages:
  mine-reset: "<green>Mine <mine> has been reset!"
  no-permission-mine: "<red>You don't have permission to mine here."
  higher-efficiency-level: "<red>You need a tool with Efficiency <level> or higher to mine here."
  warn-global: "<yellow><mine> <gray>resets in <red><seconds>s<gray> (server-wide)!"
  warn-near: "<yellow><mine> <gray>resets nearby in <red><seconds>s<gray>!"
```

{% endcode %}

See the shipped `config.yml` for the complete, up-to-date list of message keys.

***

### Mine storage

Each mine is its own file: `plugins/SimplyMines/mines/<name>.json`. It stores the region, block composition, reset/mine requirements, teleport location, and warning settings for that mine.

{% hint style="danger" %}
You generally shouldn't hand-edit these files. Use the GUI or the [API / Developer Guide](/simplymines-docs/introduction/api-developer-guide.md) instead — malformed JSON can prevent a mine from loading.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://simplymines.gitbook.io/simplymines-docs/introduction/configuration/global-configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.