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

# SantumBorder

{% embed url="<https://youtu.be/uAvnM-Uq_xw>" %}

## 🚀 Main Features

* **Strict and Direct Blocking:** When crossing the border, movement is completely blocked. There are no "whoosh" effects, particles, or annoying teleportations backwards
* **Teleport and Pearl Prevention:** Prevents traveling outside the allowed zone using `/tp` or ender pearls
* **Minimalist Configuration:** Goodbye to extensive and unnecessary configurations. The plugin only manages a few key rules (blocking mob spawning, ender pearls, and external block placement)
* **Dimension Management:** Allows defining specific borders for any world or dimension, saving cleanly in `borders.yml`
* **Tab-Completion Support:** The plugin's command is intuitive and fully supports tab-completion

## 🛠️ Commands

`SantumBorder` works primarily based on a single command to manage border creation

* `/santumborder [worldname] [dimension] corners <x1> <z1> <x2> <z2>`
  * **Description:** Allows you to configure a border by specifying the base world name, its dimension (overworld, nether, end), and the extreme coordinates
  * **Example:** `/santumborder world overworld corners -120 -120 120 120`
* `/santumborder reload`
  * **Description:** Reloads the main `config.yml` configuration and the stored borders in `borders.yml`

## 🔒 Permissions

* `santumborder.admin`
  * Allows executing plugin administration commands (like setting borders and reloading the system)
  * Granted by default to OPs (operators)
* `santumborder.bypass`
  * Allows crossing the established border without being blocked

## ⚙️ Configuration (`config.yml`)

The plugin contains an extremely clean configuration with just what's needed:

```yaml
round-border: true            # If set to true, applies the round algorithm; otherwise, borders act as a box.
deny-enderpearl: true         # Blocks the use of ender pearls outside the border
prevent-block-place: false    # Prevents blocks from being placed beyond the border
prevent-mob-spawn: false      # Prevents creatures from spawning beyond the border
```

## 📦 Storage System (`borders.yml`)

Data is saved in a simple and readable way without cluttering the console:

```yaml
borders:
    world:
        dimension: overworld
        corners:
            x1: -120
            z1: -120
            x2: 120
            z2: 120
```


---

# 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://donkolia.gitbook.io/minesantum/santumborder.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.