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

# Configuration

Open your plugin folder, and nextly Robbing folder. Here you can find the file `config.yml`, open it with a texteditor (like notepad).

## Config Example

Inside `config.yml` search the section `rob`, it will looks like this:

```yaml
rob:
  # Whether the rob feature should be enabled or not.
  enabled: true
  # Enable alert to send to the robbed target.
  alert: true
  # Whitelist and blacklist notes:
  # blacklist or/and the whitelist lists can be filled with the item name like in the
  # suggested examples, you can find easily item names online, suggested website: https://minecraftitemids.com/.
  # If you want to add a robbing custom item just add it as "robbing:" and the
  # custom item name, for example:
  #   items:
  #     - "robbing:handcuffs"
  #     - "robbing:safe"

  # Blacklist, if enabled all the items in the list will not be robbable.
  blacklist:
    enabled: false
    items:
      - diamond
      - diamond_block
  # Whitelist, if enabled only the items in the list will be robbable.
  whitelist:
    enabled: false
    items:
      - gold_ingot
  # Max distance in blocks during robbing between the robber and the robbed.
  # Beyond this distance, the robbed player's inventory will be closed.
  max-distance: 5
  # Cooldown setting (set timeout to 0 to disable).
  cooldown: 120
  # If enabled, sneak right-click to rob, otherwise just right-click.
  sneak-to-rob: true
  # After a robbery, the target will be blinded.
  # This option simulates a physical aggression to enhance realism.
  blindness-after-robbing:
    enabled: false
    # Blindness duration in seconds.
    duration: 5
  # Whether players can rob NPCs or not.
  NPC-rob: false
  # Catching a robber while robbing.
  # If enabled, this feature will slow down the robber if the robbed player shift left-clicks on them.
  catch-robber:
    enabled: true
    # Deny jumping after being caught.
    can-jump: false
    # Slow effect power after being caught.
    slow-power: 5
    # Duration of the caught effects (in seconds).
    duration: 20
```

Description of all Robbing settings in the config.

## enabled

**Type:** `boolean`

**Default:** `true`

**Usage:**

If `true` the robbing will be enabled in your server.

Set `false` to disable this mechanic.

## alert

**Type:** `boolean`

**Default:** `true`

**Usage:**

If `true` the target of the theft will receive an alert.

Set `false` to disable theft alerts.

## blacklist.enabled

**Type:** `boolean`

**Default:** `false`

**Usage:**

If `true` the blacklist will e enabled.

## blacklist.items

**Type:** `list`

**Default:**

```yaml
    - diamond
    - diamond_block
```

**Usage:**

Add the items you want to make immune to theft in this list.

Use the vanilla item names (`diamond`, `gold_ingot`, …, upper or lower case). For Robbing items use `robbing:` followed by the item id: `robbing:handcuffs`, `robbing:handcuffs_key`, `robbing:lockpick`, `robbing:safe`.

## whitelist.enabled

**Type:** `boolean`

**Default:** `false`

**Usage:**

If `true` the whitelist will be enabled: **only** the items in `whitelist.items` can be stolen.

## whitelist.items

**Type:** `list`

**Default:**

```yaml
    - gold_ingot
```

**Usage:**

The only items that can be stolen when the whitelist is enabled. Same item names as the blacklist.

## max-distance

**Type:** `integer`

**Default:** `5`

**Usage:**

Distance in blocks between robber and victim: when it is exceeded, the victim's inventory is closed to the thief.

## cooldown

**Type:** `integer`

**Default:** `120`

**Usage:**

Interval in **seconds** between one theft and another, to disable it, set the parameter to 0.

## sneak-to-rob

**Type:** `boolean`

**Default:** `true`

**Usage:**

If `true` the thief have to shift + right click to start a rob, if `false` just right click will be enough.

## blindness-after-robbing.enabled

**Type:** `boolean`

**Default:** `false`

**Usage:**

If `true`, the victim of a theft will receive temporary blindness.

## blindness-after-robbing.duration

**Type:** `integer`

**Default:** `5`

**Usage:** to operate it is necessary to have blindness-after-robbing enabled.

How long the blindness lasts, in **seconds**.

## NPC-rob

**Type:** `boolean`

**Default:** `false`

**Usage:**

If `true` players can rob NPCs (e.g. Citizens NPCs).

If `false` NPCs are ignored by the rob feature: right-clicking them never opens a robbery and never sends a message (not even "no permission"), so they keep working with their own plugin.

NPCs are recognised without any dependency: entities with the `NPC` metadata (set by Citizens and most NPC plugins) and player entities that are not connected players. Packet-based NPCs (e.g. FancyNpcs) are not server entities and are never affected.

### catch-robber.enabled

**Type:** `boolean`

**Default:** `true`

**Usage:**

If `true` the target of a rob will be able to catch his robber.

Set `false` to disable this mechanic.

### catch-robber.can-jump

**Type:** `boolean`

**Default:** `false`

**Usage:** to operate it is necessary to have catch-robber enabled.

If `false` (default) the caught robber can't jump until the effect ends.

Set `true` to let the caught robber jump.

### catch-robber.slow-power

**Type:** `integer`

**Default:** `5`

**Usage:** to operate it is necessary to have catch-robber enabled.

Power of slowness to apply to caught robber.

### catch-robber.duration

**Type:** `integer`

**Default:** `20`

**Usage:** to operate it is necessary to have catch-robber enabled.

Sets how long the slowness on the caught thief should last
