# Friend System

## config.yml

### Prefix

The prefix is used by default for each message. It can be set in the message files at the beginning of each message. To set it just write `%prefix%` (placeholder). This will then be replaced by the system with the prefix entered in `config.yml`.

### jump To Message

If this value is set to `true`, the message you find under `options.friend.jumpToMessage` will be sent. If the value is set to `false`, it will not be sent.

### Default Requests

Here you can set how many friend requests each player has by default. Default: `defaultRequests: 100`

### Max Requests

Here you can set, based on permissions, the maximum number of friend requests from a player. Default:

<pre class="language-yaml"><code class="lang-yaml"># permission ; max Requests
# -1 = unlimited
<strong>maxRequests:
</strong>    - "bungeesystem.friends.requests.150;150"
    - "bungeesystem.friends.requests.256;256"
    - "bungeesystem.friends.requests.unlimited;-1"
</code></pre>

### Max Friends

Here you can set the maximum number of friends of a player based on permissions. Default:

```yaml
# permission ; max Friends
# -1 = unlimited
maxFriends:
    - "bungeesystem.friends.friends.150;150"
    - "bungeesystem.friends.friends.256;256"
    - "bungeesystem.friends.friends.unlimited;-1"
```

### Whitelist

If you are using CloudNet v3, the first step is to enable the CloudNet v3 module under modules in `config.yml`. Next, you enter all tasks of CloudNet under the item whitelist, where a player is allowed to get the message from his friends, which is in the message file under `command.friend.switch.message`.

```yaml
whitelist:
    - "BedWars4x1"
    - "BedWars4x2"
    - "BedWars4x4"
    - "MLGRush"
    - "GunGame"
```

### Aliases

You can also define so-called aliases that you can enter instead of /friend. For this you simply add further points under the point `aliases`.

```yaml
aliases:
    - "freunde"
    - "freund"
    - "friends"
```

### Default configuration

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

```yaml
friend:
  prefix: "&7[&9Friends&7]&r"
  jumpToMessage: true
  # permission ; max Requests
  # -1 = unlimited
  defaultRequests: 100
  maxRequests:
    - "bungeesystem.friends.requests.150;150"
    - "bungeesystem.friends.requests.256;256"
    - "bungeesystem.friends.requests.unlimited;-1"
  # permission ; max Friends
  # -1 = unlimited
  defaultFriends: 100
  maxFriends:
    - "bungeesystem.friends.friends.150;150"
    - "bungeesystem.friends.friends.256;256"
    - "bungeesystem.friends.friends.unlimited;-1"
  # if cloudnet v3 is enabled, please insert the cloudnet task, if not insert server names
  # if player connect to this server/task, all friends will get the switch message. if the message is enabled with the friend toggleswitch command
  whitelist:
    - "BedWars4x1"
    - "BedWars4x2"
    - "BedWars4x4"
    - "MLGRush"
    - "GunGame"
  aliases:
    - "freunde"
    - "freund"
    - "friends"
```

{% endcode %}

## Kommandos

### Syntax

| command                  | Explanation                |
| ------------------------ | -------------------------- |
| /friend help \<page>     | Shows the help pages 1-2   |
| /friend add \<player>    | Add a friend               |
| /friend remove \<player> | Remove a friend            |
| /friend accept \<player> | Accept a friend request    |
| /friend deny \<player>   | Reject a friend request    |
| /friend acceptall        | Accept all friend requests |
| /friend denyall          | Reject all friend requests |
| /friend list             | Lists all friends          |
| /friend requests         | Lists all friend requests  |
| /friend clear            | Remove all friends         |
| /friend jump             | Jump to a friend           |
| /friend togglerequest    | Enable/Disable             |
| /friend togglejump       | Enable/Disable             |
| /friend togglenotify     | Enable/Disable             |
| /friend toggleswitch     | Enable/Disable             |


---

# 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://wiki-en.herrtechniker.eu/bungeesystem/module/friend-system.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.