# Border Highlight

The Lands module has a chunk border highlight feature.

Here are the benefits of our highlight feature:
- [x] Simple one-shot command located under the module's command namespace - easy for players to discover and remember.
- [x] It is brighter and stands out more than the built-in Minecraft one or the particle ones from other plugins.
- [x] The highlight color instantly shows if a chunk is free, claimed, belongs to you, or if you are a member.

## :icon-phs-toolbox: Prerequisites

To use this feature, you need one of the following plugins:
- [PacketEvents](https://spigotmc.org/resources/80279/)
- [ProtocolLib](https://spigotmc.org/resources/1997/)

## :icon-phs-gear: Configuration

You can find the highlight settings file at `/config/lands/borders.yml`.

```yaml borders.yml
Settings:
  # Sets the refresh rate of the chunk border highlighting.
  # [Asynchronous]
  # [Default is 10 (0.5 seconds)]
  Refresh-Rate: 10
  # Sets the render distance of chunk borders.
  # [*] 0 = only current chunk
  # [*] 1 or more = current chunk + specified amount of chunks around it
  # Works via client-side packets. High values may lead to client framerate degradation.
  # [Default is 0]
  Render-Distance: 0
  Vertical-Distance: 5
  # Block to display on the corners of the chunk border highlight.
  # [Default is minecraft:stone_brick_wall]
  Corner-Type: minecraft:stone_brick_wall
  # Block connecting the corners of the chunk border highlight.
  # [Default is minecraft:iron_chain]
  Wire-Type: minecraft:iron_chain
```

- By default, it only highlights the borders of the current chunk. To highlight surrounding chunks, increase the `Render-Distance` value.

!!! Missing the config file?
Make sure you have installed all the [prerequisites](#prerequisites).
!!!

## :icon-phs-hand-pointing: Usage

To toggle the highlight, use the `/land borders` command.

!!! Missing the command?
Make sure you have installed all the [prerequisites](#prerequisites).
!!!