BanItem

BanItem is a simple powerful, lightweight & configurable per world per action ban item plugin. The main goal of the plugin is to disable
specifics actions for
specifics items in
specifics worlds, supporting
specifics permissions.

• Blacklist: players will not be able to use the item, per action configurable;
• Whitelist: (reversed blacklist) - all items & actions will be blocked , you'll have to set which items is allowed with which action;
• Per world configurable;
• Per world per item permissions;
• Per world per item per action permissions;
• Support of meta items (matching the exact item with its metadata);
• Create & filter custom items (items with specific metadata: potions, enchantments etc.);
• Usefull commands;
• Lightweight & activating only necessary listeners;
• Developer API available;
• Full documentation: https://banitem.andross.fr/

Actions: (bannable)

• Armorstandplace: when the player try to place the item on an armorstand; (MC>=1.8)
• Armorstandtake: when the player try to take the item from an armorstand; (MC>=1.8)
• Attack: when the player use left click with the item in the main hand on an entity;
• Bookedit: when the player edits or signs a book and quill item;
• Break: when the item is breaked;
• Brew: when the item (potion) is brewed inside a brewing stand;
• Click: when the player use left click with the item in the main hand;
• Consume: when the player try to consume a food, a potion..
• Craft: the item will not be craftable anymore;
• Crafter: the item will not be crafted by Crafter block (MC>=1.21);
• Delete: when a player open & close an inventory, it will check and delete items which have this action;
• Dispense: when an item is dispensed from a block;
• Drop: when the item is dropped by a player;
• Drops: when the item is dropped from a block;
• Enchant: when the player try to enchant the item;
• Entitydrop: when an entity dies and drop the item;
• Entityinteract: when a player use right click with the item on an entity;
• Fill: when a player use right click with the item on a fluid (water/lava);
• Glide: when a player try to use (activate) an elytra; (MC>=1.9)
• Hangingplace: when a player try to place a hanging entity (itemframe, painting..);
• Hold: when a player try to hold the item in the hand;
• Interact: when a player use right click with main hand on the placed item;
• Inventoryclick: when a player try to click an item in an inventory;
• Mending: when an item is repaired by the mending enchantment; (MC>=1.13)
• Pickup: when the item is picked up;
• Place: when the item is placed;
• Rename: when a player try to rename the item in an anvil, or from a command;
• Smelt: the item will not be smeltable anymore;
• Smith: when the recipe of an item is completed inside a smithing table (MC>=1.16);
• Swap: when the player try to swap the item in hands (MC>=1.9);
• Sweepingedge: when the player attacks an entity with an item that has sweeping edge. The original attack will continue but the sweeping edge damage will be cancelled;
• Transfer: when the player try to transfer the item from an inventory to another;
• Unfill: when a player try to unfill a bucket;
• Use: when a player try to right click with the item in the hand;
• Wear: when the player try to put the item as an armor (you'll need to use also the 'place' action);

Spoiler: Default config

Code (YAML):

+———————————————————————————————————————————————————+

|——————————     BANITEM CONFIGURATION     ——————————|

|——————————————————      v3.7      —————————————————|

+———————————————————————————————————————————————————+

|                   Documentation:                  |

|             banitem.andross.fr/           |

+———————————————————————————————————————————————————+

For any bugs/suggestions, contact me on Discord: andross96

+——————————————————————————————————————————————————————————————————————————————————————————————+

General Informations:

 - The blacklist will block the items.

 - The whitelist will allow only the items set.

   -> The 'message' key represents the message sent to players if they try to use an item which is not in whitelist

   -> The 'ignored' key represents all ignored actions (they will not being by default banned)

#

 - Worlds can be written:

   -> single: 'world' ; 'world_the_end'...

   -> multiple: 'world, world_the_end'...

   -> all: '*'

   -> all except: '*, !world_the_end, !world_nether': all worlds, except world_the_end & world_nether

   -> regex starting with "#": '#world': world, world_nether, world_the_end

#

 - Items can be written: (hub.spigotmc.org/javadocs/spigot/org/bukkit/Mat…)

   -> single: 'stone' ; 'dirt'...

   -> multiple: 'stone, dirt'

   -> all: '*' (also include air [=empty hand]!)

   -> all except: '*, !stone' (all, except stone)

   -> regex starting with "#": '#_BED' will give all material which names matches '_BED'

#

 - Actions can be written:

   -> single: 'place' ; 'break'...

   -> multiple: 'place, break'

   -> all: '*'

   -> all except: '*, !place' (all, except place)

 - Each actions can store some datas to check. They can be written, for example (except for cooldown & log):

   -> entity: pig, cow

   -> entity:

      - pig

      - cow

   -> entity:

      - pig,cow

#

  - Actions data: (* is usable only for actions involving a player)

    -> cooldown(*): allow access to the action each X milliseconds (1 second = 1000 milliseconds)

      -> '{time}': in the message will display the time remaining

    -> entity: the entity interacted or involved in the ban

      -> EntityType: hub.spigotmc.org/javadocs/spigot/org/bukkit/ent…

    -> gamemode(*): the item is only banned if the player is in this gamemode

    -> inventory-from: the inventory where the item come from

      -> InventoryType: hub.spigotmc.org/javadocs/spigot/org/bukkit/eve…

    -> inventory-to: the inventory where the item goes to (same type as above)

    -> material: an additional item checked

      -> For example, in a BREAK action, this data will also check a matches with the item in the player's hand

      -> hub.spigotmc.org/javadocs/spigot/org/bukkit/Mat…

    -> permission(*): check if the player has the custom permission

    -> log(*): true/false - if players with /banitem log will receive a message for this ban

    -> message(*): a string or list of string to be sent if the item is banned

    -> placeholderapi_condition(*): action apply only if the placeholder API value match

    -> region(*): worldguard region

    -> run(*): list of commands run when the action is banned:

      -> '{player}' : the player name

      -> '{world}' : the world name

      -> '{itemname}' : the item name

       +——————————————————————————————————————————————————————+

 - Actions and their possibles datas:

   - ARMORSTANDPLACE: when the player try to place the item on an armorstand [no specific data]

   - ARMORSTANDTAKE: when the player try to take the item from an armorstand [no specific data]

   - ATTACK: when the player use left click with the item in the main hand on an entity

     -> Special data: entity - the entity clicked

   - BOOKEDIT: when the player edits or signs a book and quill item [no specific data]

   - BREAK: when the item is breaked

     -> Special data: material - the item in the player hand

   - BREW: when the item (potion) is brewed inside a brewing stand [no specific data]

   - CLICK: when the player use left click with the item in the main hand

     -> Special data: material - the block clicked, if there is one

   - CONSUME: when the player try to consume a food [no specific data]

   - CRAFT: the item will not be craftable anymore [no specific data]

   - CRAFTER: the item will not be crafted by Crafter block (MC>=1.21) [no specific data]

   - DELETE: when a player open & close an inventory, it will check and delete items which have this action [no specific data]

   - DISPENSE: when an item is dispensed from a block [no specific data]

   - DROP: when an item is dropped by a player [no specific data]

   - DROPS: when an item is dropped from a block

     -> Special data: material - the item in the player's hand

   - ENCHANT: when a player enchants the item

     -> Special data: enchantment - the enchantment applied to the item

   - ENTITYDROP: when an entity dies and drop the item

     -> Special data: entity - the entity type

   - ENTITYINTERACT: when a player use right click with the item on an entity

     -> Special data: entity - the entity interacted

   - FILL: When a player use right click with the item on a fluid (water/lava)

     -> Special data: material - the fluid type

   - GLIDE: when a player try to use (activate) an elytra [no specific data]

   - HANGINGPLACE: when a player try to place a hanging entity (itemframe, painting..)

     -> Special data: entity - the entity created by this placing

   - HOLD: when a player try to hold the item in the hand [no specific data]

   - INTERACT: when the player use right click with main hand on the placed item

     -> Special data: material - the item in player's hand

   - INVENTORYCLICK: when the player try to click an item in an inventory

     -> Special data: inventory-from - the inventory type clicked

   - MENDING: when the player has an item repaired via the mending enchantment [no specific data]

   - PICKUP: when the item is picked up [no specific data]

   - PLACE: when the player try to place a block

     -> Special data: material - the block placed against

   - RENAME: when the player try to rename the item in an anvil, or from a command [no specific data]

   - SMELT: the item will not be smeltable anymore [no specific data]

   - SMITH: when the recipe of an item is completed inside a smithing table

   - SWAP: when the player try to swap the item in hands [no specific data]

   - SWEEPINGEDGE: when the player attacks an entity with an item that has sweeping edge. The original attack will continue but the sweeping edge damage will be cancelled

   - TRANSFER: when the player try to transfer the item from an inventory to another

     -> Special data:

       -> inventory-from: the inventory where the item comes from

       -> inventory-to: the inventory where the item goes to

   - UNFILL: when a player try to unfill a bucket

     -> Special data: material - the block type clicked

   - USE: when a player try to use an item (right click with it)

     -> Special data: material - the block clicked, if there is one

   - WEAR: when the player try to put the item as an armor (you'll need to use also the 'place' action) [no specific data]

       +——————————————————————————————————————————————————————+

 - Examples:

   -> Simple structure:

     blacklist:  ##----> for blacklist

       world: ##----> world where the ban should apply

         ender_pearl: ##----> the item

           place: '&cYou can not use ender pearls in world.' ##----> the action with a message

                       +————————————————————+

   -> Advanced structure:

     blacklist:  ##----> for blacklist

      'world, world_the_end': ##----> worlds where the ban should apply

        'dirt, stone': ##----> the items

          'place, break': ##----> the actions, and below their datas

            message: ##----> a configurable (multi-line, or not) message

            - '&cA first message example'

            - '&cA second message example'

            gamemode: creative ##----> only applies if player is in creative

##