🛠️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.

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

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

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

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

delivery:

All the configuration for every delivery is located inside it.

Delivery ID

  hourly:

ID for the delivery.

Icon Item

    icon-item: van@WHITE_WOOL@1

This item will be used to display the delivery on the main board menu. Check Allowed Item String for details regarding format

Title

    title: '&9&lHOURLY Delivery'

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

Position Slot

    position-slot: 11

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

Max Submissions

    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

    cooldown: 350000

The cooldown or delay after the delivery gets refreshed

Skip Cost

Set the cost of skipping this delivery.

    skip-cost: 1

Refresh Alert

Should all the online players be notified whenever this delivery refreshes

send-alert: false

Allowed Materials

    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 for formatting style.

Reward Setup

    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.

Max Reward cannot exceed the amount of rewards listed in the Random Reward Pool.

Random Reward Pool

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. Refer to Reward String for formatting style.

Confirmed Rewards

        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 for formatting style.