Home

debug: true
version: 1

command:
  command1:
    key: f
    requireShift: false
    permission: f-command.example
    commandList:
      - say you pressed f
    cancel: true
    executeAsServer: true
  
  command2:
    key: q
    requireShift: True
    permission: f-command.example
    commandList:
      - say you pressed q while shifting
      - say And two commands got executed!
    cancel: false
    executeAsServer: false

Configuration options

key

Options: F, Q

Configure which key/action executes the command. The config is written in mind of the standard keyboard settings, which would use Q (Drop Item) and F (Swap Hands). If a Player changes their Key binds, they need to press their configured key's to execute the command.

F - Swap Main- and Offhand Q - Drop Item in Mainhand

requireShift

Options: true, false

Configure if the Player needs to sneak during pressing the required Button.

true - Sneak to execute the command. true - Don't sneak to execute the command.

permission

Here you can configure a specific permission, which is needed by the player, to execute a command.

If the player does not need a permission to execute this, you can either completely delete the permission part, leave it empty or enter "null".

If you need a permission plugin, I would suggest you LuckPerms. If you don't know what a permission is, you can read about it here => [Click Me]

commandList

The command which gets executed. Please note, this must be in a List format!

Please consider that the player, which executes the command, may need permissions from other plugins as well.

cancel

Options: true, false

This setting controls if the event is cancelled or not.

true - The item drop or the hand swap will not be executed. false - The item drop or hand swap will be executed normally.

executeAsServer

options: true, false

Should the command be executed by the player or by the console?

true - The command will be executed by the console with full server privileges false - The command will be executed by the player

If set to false, please considere that the player needs permission to use this command. If the player can not execute the same command in his chat, it will not work.