# How to configure

## Welcome | Goodbye

```
Welcome:
  Admin: #Rank name
    Display: '&4%player% &6joined the lobby!' #The message that is displayed.
    Permission: lobbysystem.admin #The permission you need to be announced.
  VIP:
    Display: '&6%player% &6joined the lobby!'
    Permission: lobbysystem.vip
  Player:
    Display: '&7%player% &6joined the lobby!'
    #If no permission is entered, this rank name is used as the normal
    #rank, i.e. this is displayed each time a player joins / leaves.
Goodbye:
  Admin:
    Display: '&4%player% &6left the lobby!'
    Permission: lobbysystem.admin
  VIP:
    Display: '&6%player% &6left the lobby!'
    Permission: lobbysystem.vip
  Player:
    Display: '&7%player% &6left the lobby!'
```

***

## Random lobby

```
Other:
  RandomLobby:
    Filter: lobby #Only warps that start with this term.
```

The LobbySystem only searches for warps that start with this word, for example if you have warps with the name lobby-1, lobby-2, lobby-3 the LobbySystem selects a random warp and so you end up in a random lobby.

***

## Chat | Also with custom textures

{% hint style="warning" %}
To display custom textures ranks/prefixes in the chat, you need the [ItemsAdder](https://www.spigotmc.org/resources/ItemsAdder.73355) & [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245) plugin!\
It is important that you follow the [instructions](https://itemsadder.devs.beer/plugin-usage/adding-content/ranks-prefixes#create-a-rank) provided by ItemsAdder!\
To display them in the chat, you must follow [these](https://itemsadder.devs.beer/plugin-usage/adding-content/ranks-prefixes#tab-plugin) steps. (No external chat plugin is required!)
{% endhint %}

<figure><img src="/files/K3TwT1pbzghAraPcSFVB" alt=""><figcaption><p>Example of custom textures in the chat</p></figcaption></figure>

***

```
Chat:
  Global: #This chat format is used when you are not in a lobby.
    Prefix: '%vault-prefix%' #Prefix that is displayed in the chat.
    Suffix: '' #Suffix that is displayed in the chat.
    Display: '%player%&r: %message%' #How the chat format is shown.
  Admin: #Rank name
    Prefix: '&7[&4Admin&7]'
    Suffix: '&7[Boss]'
    Display: '%player%&r: %message%'
    Permission: lobbysystem.admin
  VIP:
    Prefix: '&7[&6VIP&7]'
    Suffix: ''
    Display: '%player%&r: %message%'
    Permission: lobbysystem.vip
  Player:
    Prefix: '&7[&8Player&7]'
    Suffix: ''
    Display: '%player%&r: %message%'
    #If no permission is entered, this rank name is used as the normal
    #rank, i.e. this is displayed if the player has no permission.
```

***

## Tab | Also with custom textures

{% hint style="warning" %}
To display custom textures ranks/prefixes in the tab, you need the [ItemsAdder](https://www.spigotmc.org/resources/ItemsAdder.73355) & [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245) plugin!\
It is important that you follow the [instructions](https://itemsadder.devs.beer/plugin-usage/adding-content/ranks-prefixes#create-a-rank) provided by ItemsAdder!\
To display them in the tab, you must follow [these](https://itemsadder.devs.beer/plugin-usage/adding-content/ranks-prefixes#tab-plugin) steps. (No external tab plugin is required!)
{% endhint %}

<figure><img src="/files/em1bVV58LmuPqyJjZTqB" alt=""><figcaption><p>Example of custom textures in the tab</p></figcaption></figure>

***

```
Tab:
  Admin: #Rank name
    Prefix: '&7[&4Admin&7]' #Prefix that is displayed before the name.
    Suffix: '&7[Boss]' #Suffix that is displayed after the name.
    Nametag: '&c' #The color used for the name is also used over the player's head.
    Permission: lobbysystem.admin #Permission you need to get this rank.
    Priority: 1 #Set the height in the tab of the rank the higher the further down.
  VIP:
    Prefix: '&7[&6VIP&7]'
    Suffix: ''
    Permission: lobbysystem.vip
    Priority: 2
  Player:
    Prefix: '&7[&8Player&7]'
    Suffix: ''
    Priority: 3
    #If no permission is entered, this rank name is used as the normal
    #rank, i.e. this is displayed if the player has no permission.
```

***

## Scoreboard

<pre><code><strong>Scoreboard:
</strong>  Refresh: #Refresh rate in milliseconds.
    Title: 60 #How quickly should the scoreboard title be updated?
    Lines: 120 #How quickly should the scoreboard lines be updated?
  Title: #Scoreboard title, if you enter more than one it will be updated in the speed you entered in Refresh Title.
  - '&#x26;bLobbySystem 3'
  - '&#x26;1LobbySystem 3'
  - '&#x26;9LobbySystem 3'
  - '&#x26;3LobbySystem 3'
  Lines: #Scoreboard lines, with "||" in the same line you create another text in the same line, is updated after Refresh Lines. 
  - '&#x26;6Welcome to the server %player%!||&#x26;aWelcome to the server %player%!||&#x26;eWelcome to the server %player%!'
  - '&#x26;6Your lobby: %lobby%'
  - '&#x26;6Coins: &#x26;e%vault-economy%||&#x26;6Rank: %vault-prefix%'
  - '&#x26;6Players in your lobby: &#x26;e%lobbyplayers%||&#x26;6Players in all lobbies: &#x26;e%lobbyallplayers%'
</code></pre>

***

## Automatic repeating actions

<pre><code><strong>AutoRepeat:
</strong> news: #Name of the group.
   Repeat: 60 #In how many seconds it should repeat.
   Actions: #The actions that are to be executed.
   - '[ACTIONBAR] &#x26;aWelcome to the server, have fun!'
   - '[MESSAGE] &#x26;aIf you have any questions, please contact support.'
 newsbossbar:
   Repeat: 120
   Actions:
   - '[BOSSBAR] &#x26;3This is a cool BossBar!#50#GREEN'
</code></pre>

***

## Custom commands

```
CustomCommands:
  hello: #Main command.
    Aliases: #Other commands that execute the main command.
    - hey
    Actions: #Actions that are executed.
    - '[MESSAGE] &aHello back!'
    - '[ACTIONBAR] &6Hello back!'
  sun:
    Aliases:
    - sunshine
    Actions:
    - '[PERMISSION] lobbysystem.sun#&cYou do not have permission for this.'
    - '[COMMAND] /weather clear'
    - '[MESSAGE] &aThe weather is beautiful again.'
```

***

## Create items

{% hint style="info" %}
To learn more about using custom skull skin (head), [click here](/lobbysystem-3/faq/how-to-use.md#custom-skull-skin-head).\
\
To display custom items from ItemsAdder, you must use the following formatting for example:\
iaspecial\_swords:guitar\_sword | (From which content folder):(Which item from the items folder)
{% endhint %}

```
Items:
  holyApple: #Item group name.
    Slot: 3 #Item slot.
    Name: '&6Holy Apple' #Item display name.
    Material: APPLE #Item material.
    Glow: false #Makes the item glow. (Enchant effect)
    Amount: 1 #Item amount.
    Actions: #Actions that are executed.
    - '[CONSOLE] give @p minecraft:golden_apple 1'
    - '[MESSAGE] &6Have fun with the Holy Apple.'
    Lore: #Item lore.
    - '&2Right-click on the item.'
```

***

## Creating a menu (GUI)

To create a menu, you must create a new file in the <mark style="background-color:blue;">**LobbySystem3/Menus/**</mark> folder, for example test.yml.\
You can open the menu either with the command <mark style="background-color:blue;">**/LobbySystem opengui test**</mark> or with the action <mark style="background-color:blue;">**\[MENU] test**</mark>.

{% hint style="info" %}
To learn more about using custom skull skin (head), [click here](/lobbysystem-3/faq/how-to-use.md#custom-skull-skin-head).\
\
To display custom items from ItemsAdder in a GUI, you must use the following formatting for example:\
iaspecial\_swords:guitar\_sword | (From which content folder):(Which item from the items folder)
{% endhint %}

```
Slots: 9 #How many slots should the menu have? (9, 18, 27, 36, 45, 54)
Title: Lobby switcher #Menu title.
Items: #The items that are displayed in the menu.
  lobby1: #Item group name.
    Slot: 3 #Item slot.
    Name: '&aLobby 1' #Item display name.
    Material: NETHER_STAR #Item material.
    Glow: false #Makes the item glow. (Enchant effect)
    Actions: #Actions that are executed.
      - '[COMMAND] /lobbysystem warp lb1'
    Lore: #Item lore.
      - '&ePlayers: %lobbyplayers-lb1%'
  lobby2:
    Slot: 6
    Name: '&aLobby 2'
    Material: NETHER_STAR
    Glow: false
    Actions:
      - '[COMMAND] /lobbysystem warp lb2'
    Lore: 
      - '&ePlayers: %lobbyplayers-lb2%'
```

***

## Create own pets

{% hint style="warning" %}
Pets can only be created via menus (GUIs)!
{% endhint %}

```
enderman: #Name of the pet.
  Slot: 12 #Item slot.
  Name: '&aEnderman' #Item display name.
  Material: ENDERMAN_SPAWN_EGG #Item material.
  Actions: #Actions that are executed.
    - '[CLOSE]'
    - '[BUY] 0###[EQUIP:pet] enderman' #Actions to set this entity as pet. (MUST BE THE SAME AS PET NAME)
```

***

## Animated items in GUI

{% hint style="info" %}
The animation is mainly created in the material column.\
Example: Material: MATERIAL,SECONDS;MATERIAL,SECONDS;...
{% endhint %}

```
  bedwars: #Item group name.
    Slot: 13 #Item slot.
    Name: '&aBedWars' #Item display name.
    Material: RED_BED,3;GREEN_BED,3 #Material,seconds;Next Material
    Actions:
      - '[COMMAND] /lobbysystem warp bedwars'
      - '[CLOSE]'
    Lore:
      - '&8Test lore'
```

<figure><img src="/files/k4SfUCNy9zXOGrZT5xJf" alt=""><figcaption><p>Example animation</p></figcaption></figure>

## Fill item in menus (GUIs)

```
fill: #Item group name.
  Slot: -1 #Item is set everywhere where there is no item.
  Name: '&r' #Item display name.
  Material: GRAY_STAINED_GLASS_PANE #Item material.
```

***

## Create a jumppad (Launchpad)

<figure><img src="/files/EKD7FwEz4uMHNRJG2pxw" alt=""><figcaption></figcaption></figure>


---

# 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://neonn-development.gitbook.io/lobbysystem-3/faq/how-to-configure.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.
