Custom Honeypot Actions
If the built-in Honeypot actions aren't enough for you (And, let's face it, they likely aren't), you can customize your own by defining them in honeypots.yml.
Defining a Honeypot
To get started, find the honeypots.yml file within your configuration. You can download a sample file here.
This file already contains a few demo Honeypot actions. Let's take a look at the first one, demo-everthing
Let's break this down piece by piece
demo-everything
The root key of the action is the name of the action as well. You can name an action whatever you want, as long as it's legal YAML. In this case, since the section is named demo-everything, then the action will be shown as "demo-everything" in-game.
commands
The commands list is a list of commands that Honeypot will run as the Console. Because the player is not running the commands but rather the Server, Honeypot has some placeholders built-in, as well as support for PlaceholderAPI placeholders, that can be used to target whatever is needed in a command. MiniMessage in commands is not supported.
You can have as many commands as you like, or as few as you like, or even none at all. If you don't need to use commands, you can omit the array entirely, or set it to [ ] instead.
permissions
The permissions-add and permissions-remove sections allow you to grant or revoke permissions on break. Permissions require Vault in order to function! If this feature is used while Vault is uninstalled, a log message will be put in Console regarding Vault not being installed. Adding or removing permissions is a great way to discipline players without affecting their overall gameplay. For example, you could configure your shop plugin to double the price of all items if a certain permission is granted, or you can revoke the ability to /tpa if you want. Possibilities are endless
You can add or remove as many permissions as you like, or as few as you like, or even none at all. If you don't need to use permissions or can't due to a lack of Vault, you can omit the array entirely, or set it to [ ] instead.
broadcasts
The broadcasts list is a list of messages that Honeypot will send to all players on the Server. Note this is all players on this server, Broadcasts on networks using a proxy such as Bungee or Velocity will not have the message sent to all of them.
You can have as many broadcasts as you like, or as few as you like, or even none at all. Broadcasts can also include MiniMessage tags, Honeypot placeholders, and PlaceholderAPI placeholders. If you don't need to use broadcasts, you can omit the array entirely, or set it to [ ] instead.
messages
The messages list is a list of messages that Honeypot will send to the player directly.
You can have as many messages as you like, or as few as you like, or even none at all. Messages can also include MiniMessage tags, Honeypot placeholders, and PlaceholderAPI placeholders. If you don't need to use messages, you can omit the array entirely, or set it to [ ] instead.
icon
The icon property in the action is what to show the action as when putting it up in the Honeypot GUI. This icon field is the name of the Material as it is in Bukkit's materials list, found here.
An icon is required for a definition to be valid
Placeholders
Honeypot contains several built-in placeholders as well as support for PlaceholderAPI placeholders when formatting messages, broadcasts and commands. The four built-in placeholders in Honeypot should not be confused with PlaceholderAPI placeholders, as they are only available within custom actions and nowhere else.
Honeypot does not require Placeholder API to function, however if you want to use other Placeholders then it is required.
Placeholder | Description | Example |
|---|---|---|
%player% | The name of the player that triggered the action | TerrorByte |
%pLocation% | The coordinates of the player when the action was taken | 123 75 -48 |
%bLocation% | The coordinates of the Honeypot block that the player broke to trigger the action | 120 75 -47 |
%world% | The name of the world the Honeypot was in | world |
Using your action
Using your custom action is extremely simple, just reload the plugin using /honeypot reload and follow one of the below methods
Type
/honeypot create <action name>. Enabled behavior providers (Including the built-in ones) and custom actions will be displayed in the same list. Action Name will tab-complete based on the names you provided your actions.Run
/honeypot,/honeypot gui, or/hpto open the GUI. Clicking the "Create" button will display all the types of Honeypots you can create. Items in the GUI will display as what was defined in the action's configuration. All items have names corresponding to their name in the configuration as well, making identifying your action quick and easy.