# Understanding Config

Does this look familiar? Of course it does, because it's the config.

The following code snippet has all the fields that the main config has. We're going to be using this to learn the config.

### Misc.

```yaml
board-location: ''
lang-file: en_US.yml
```

`board-location` stores location of the board. It can be either set using the in-game command or manually from the config.\
`lang-file` the language file is selected here. It must be stored inside `/plugins/DeliveryBoard/lang/`

### GUI Setup

```yaml
gui:
  static:
    fillerMaterial: van@BLACK_STAINED_GLASS_PANE@1
    acceptMaterial: van@LIGHT_BLUE_STAINED_GLASS_PANE@1
    cancelMaterial: van@RED_STAINED_GLASS_PANE@1
    infoMaterial: van@BOOK@1
    skipMaterial: van@EMERALD@1
    nextPageMaterial: van@SPECTRAL_ARROW@1
    previousPageMaterial: van@SPECTRAL_ARROW@1
    infoPageMaterial: van@BOOK@1
    closePageMaterial: van@REDSTONE_BLOCK@1

  titles:
    boardTitle: "<#22ff20>&lDelivery Board"
    editBoardTitle: "&9Edit Delivery"
```

### Delivery

```yaml
delivery:
  hourly:
    icon-item: van@WHITE_WOOL@1
    title: "&9&lHOURLY Delivery"
    position-slot: 11
    max-submissions: 10
    cooldown: 350000
    skip-cost: 1
    send-alert: false
    allowed-materials:
      - 'van@NETHERITE_SCRAP@2'
      - 'van@LEATHER@32'
      - 'van@WHEAT@64'
    reward-setup:
      mixed:
        max-reward: 1
        confirmed-rewards:
          - 'item@EMERALD@1'
          - 'comm@effect give {PLAYER_NAME} minecraft:absorption 10 3'
        random-rewards-pool:
          - 'item@DIAMOND@5@1'
          - 'item@REDSTONE_BLOCK@2@1'
          - 'item@BLACK_SHULKER_BOX@1@2'
          - 'comm@xp add {PLAYER_NAME} 3 levels@5'
```

#### Board Location

```yaml
board-location: ''
```

This field stores the current board location. The block that is in this location will act as Delivery Board and open the GUI when Right Clicked on it. leaving it empty makes it so that there is no active board. You can manually insert a block's location in here then save and reload to make that block the current board. It is advised to use the in-game command to set the board.

#### Delivery Section

```yaml
delivery:
```

All the configuration for every delivery is located inside it.

#### Delivery ID

```yaml
  hourly:
```

ID for the delivery.

#### Icon Item

```yaml
    icon-item: van@WHITE_WOOL@1
```

This item will be used to display the delivery on the main board menu. Check [Allowed Item String](/deliveryboard/deliveryboard-wiki/formatting-string/allowed-item-string.md) for details regarding format

#### Title

```yaml
    title: '&9&lHOURLY Delivery'
```

Display name of the item representing the delivery and the GUI name of the delivery

#### Position Slot

```yaml
    position-slot: 11
```

The slot in which it will appear in the main board GUI

#### Max Submissions

```yaml
    max-submissions: 10 
```

Total amount of submissions to accept for this delivery. In this example a total of 10 players will be able to submit it and then it will get locked. Set it to `-1` to disable

#### Cooldown

```yaml
    cooldown: 350000
```

The cooldown or delay after the delivery gets refreshed

#### Skip Cost

Set the cost of skipping this delivery.

```yaml
    skip-cost: 1
```

#### Refresh Alert

Should all the online players be notified whenever this delivery refreshes

```yaml
send-alert: false
```

#### Allowed Materials

```yaml
    allowed-materials:
      - 'van@CARROT@64'
      - 'van@IRON_HELMET@1'
      - 'van@LEATHER@15'
```

This a list of materials/items which will be used when creating this specific delivery. each entry of this list needs to properly entered using proper format. Refer to [Allowed Item String](/deliveryboard/deliveryboard-wiki/formatting-string/allowed-item-string.md) for formatting style.

#### Reward Setup

```yaml
    reward-setup:
```

Rewards for this specific quest are configured here.

#### Mixed Reward Type

```
      mixed:
```

The only reward type that is supported as of **v1.2**.

#### Max Reward

```
        max-reward: 1
```

The maximum amount of rewards to give the player who completes the delivery. This amount of reward is picked from the [#random-reward-pool](#random-reward-pool "mention").

{% hint style="warning" %}
[#max-reward](#max-reward "mention") cannot exceed the amount of rewards listed in the [#random-reward-pool](#random-reward-pool "mention").
{% endhint %}

#### Random Reward Pool

```yaml
random-rewards-pool:
          - 'item@DIAMOND@5'
          - 'item@REDSTONE_BLOCK@2'
          - 'comm@xp add {PLAYER_NAME} 3 levels'
```

Items from this list are picked at random to be given for the player who completed the delivery. The amount of rewards picked from this list depends of [#max-reward](#max-reward "mention"). Refer to [Reward String](/deliveryboard/deliveryboard-wiki/formatting-string/reward-string.md) for formatting style.

#### Confirmed Rewards

```yaml
        confirmed-rewards:
          - 'item@EMERALD@1'
          - 'comm@effect give {PLAYER_NAME} minecraft:absorption 10 3'
```

These reward are always given to the player upon successful delivery. Refer to [Reward String](/deliveryboard/deliveryboard-wiki/formatting-string/reward-string.md) for formatting style.


---

# 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://nukegh05t.gitbook.io/deliveryboard/deliveryboard-wiki/understanding-config.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.