How to use - MathiasMC/BattleDrones GitHub Wiki

GUI

The BattleDrones is GUI-based plugin. There are three GUI types in total: Shop GUI, player drones GUI , drone GUI. PlaceholderAPI placeholders can be used in the GUI configuration.
Configuration files location: /BattleDrones/gui.

Text above drone

You can improve the performance of BattleDrones with only using 1 line of text this will have so it only teleports 1 armor stand instead of 2

    name:
      searching: ''
      target: ''
    text:
      searching: '&aSearching...'
      target: '&cDetected Enemy...'

Shop

Accessible with the /bd shop command. The shop is the place where a player buy drones for built in coins or vault currency (if vault is enabled in the config.yml). By console you can also open the shop for specific player with /bd shop <player>.

If you want to add a custom drone model to the shop GUI, then remove the variable HEAD and add MODEL-DATA:

20:
  NAME: '&6Laser drone'
  LORES:
    - '&f-----------------'
    - '&fDrones armed with'
    - '&flaser weapons.'
    - ' '
    - '&7Cost: 100 coin(s)'
  MODEL-DATA: 1234567
  AMOUNT: 1
  OPTIONS:
    - DRONE_LASER_BUY
  SHOP-COMMANDS:
    BOUGHT:
      - 'battledrones message {player} &7[&dBattleDrones&7] &aYou have bought the &6Laser Drone&a!'
    COINS:
      - 'battledrones message {player} &7[&dBattleDrones&7] &cYou dont have enough coins to buy the drone!'
    HAVE:
      - 'battledrones message {player} &7[&dBattleDrones&7] &cYou already have bought the drone!'
    PERMISSION:
      - 'battledrones message {player} &7[&dBattleDrones&7] &cYou dont have access to buy this laser drone.'
  COST: 100

Player menu

Accessible with the /bd menu command. The player menu is the place where a player have all own bought drones. By console you can also open the menu for specific player with /bd menu <player>.

Drone menu

Accessible from Player menu by middle click on the drone. The menu may differ depending on the drone type.

Additional variables

You can add permission nodes and commands that will be executed when you click on the item in the GUI by adding COMMANDS option.
Example:

0:
  NAME: 'My new item'
  LORES: []
  MATERIAL: BLACK_STAINED_GLASS_PANE
  AMOUNT: 1
  COMMANDS:
    PERMISSION: battledrones.sometexthere
    NO-PERMISSION:
      - 'cmd'
      - 'cmd'
    PLAYER:
      - 'cmd'
      - 'cmd'
    CONSOLE:
      - 'cmd'
      - 'cmd'
Variable Datatype Description
PERMISSION String Permission node.
NO‑PERMISSION String List of commands that will be executed when clicking on the item without having permission defined above.
PLAYER String List of commands that will be executed as player when clicking on the item with having permission defined above.
CONSOLE String List of commands that will be executed as console when clicking on the item with having permission defined above. Placeholder {player} can be used here.

You can also add a visual enchant effect to any item in the GUI or ammo item:

You can close the current inventory if you have CLOSE in the options

0:
  NAME: 'My new item'
  LORES: []
  MATERIAL: BLACK_STAINED_GLASS_PANE
  AMOUNT: 1
  OPTIONS:
    - GLOW
    - CLOSE

Currency

The BattleDrones can use built-in currency coins or as well the vault.

For vault money to show in the gui instead of coins you need to replace the lore placeholder with PlaceholderAPI Vault placeholder

config.yml:

# Vault (Use vault economy instead of build in coins system)
vault: false
⚠️ **GitHub.com Fallback** ⚠️