Overview:

HeadBlocks is a plugin that allows you to keep your players busy while having fun. The goal is simple, you hide a number of heads in your world and your players have to find them to get many rewards.The most common example of use is for Easter or Christmas headhunting!

Features:

• Very easy to use
• No head limit
• Execute commands when clicking or according to levels
• Multiple head and multiple texture (support HeadDatabase)
• Customize sounds on click
• Send multi-line and centered messages on click
• Customize a firework or an explosion at the head with any colors
• Send a title fully customizable to the player
• Add particles on head already found and not found
• Can be used on a lobby, on a single server or even on several servers simultaneously (with Redis)
• Storage of player data in SQLite or MySQL
• Everything is translatable
• API for developers
• Contains several placeholders (see below)
• Automatic configuration updates
• Supports Minecraft 1.16+ colors
• Show holograms on heads (support placeholders)
• Order or define max click on the heads
• Head push back when already obtained
• Head spin mode (head will rotate simultaneously or not)
• NEW Hint system (actionBar or Sound)
• NEW Per-head rewards (commands, broadcast, message)
• NEW Hide head when found (using PacketEvents)
  Please note, if you are using tiered rewards, make sure it is set up correctly from the start. There is no way to distribute the rewards for the tiers already reached yet!

Wiki:

You can find the wiki here.

Configurations:

• config.yml : Plugin configuration file
• language/ : Folder with translations (en or fr available)
• headblocks.db : SQLite database for storing player data (excluding MySQL)
• locations.yml : File containing the list of head positions

Commands:

• progress : Displays the player's progress (can contain a progress bar customizable in config.yml)
• give : Give a special head. When placed, it becomes a clickable head (one-time per player)
• remove : Remove spawned head by it's uuid
• removeall : Remove all spawned heads
• reset : Resets all data of a player
• resetall : Resets data for all player
• list : Display in the chat the list of all heads with their locations
• rename : Rename a head (used to display the head in gui, stats, chat)
• stats : Displays in the chat the list of recovered and not recovered heads of a player
• top : Displays in the chat a leaderboard of players
• move : Move an existing head without loosing player data
• export : Export HeadBlocks database in another database one
• options : Open a GUI with ordering or max click settings
• reload : Reload the plugin configuration
• version : Display the version of the plugin
• help : Display help message

Permissions:

• headblocks.use : Allows to interact with the heads
• headblocks.commands.top : Top command
• headblocks.commands.progress : Progress command
• headblocks.commands.progress.other : See progress of player
• headblocks.admin : All admin commands (default op)

If you want to run placeholders, you will need PlaceHolderAPI.
If you want to run holograms, you will need ProtocolLib.
If you want to use HeadDatabase heads, you will need HeadDatabase.

Placeholders:

• %headblocks_current% : player current amount of heads found (raw integer)
• %headblocks_left% : player left amount of heads to found (raw integer)
• %headblocks_max% : total amount of heads placed (raw integer)
• %headblocks_hasHead_uuid% : if player has found the head with uuid defined in /hb info command (raw boolean)
• %headblocks_order_previous% : if order is specified, display the previous named head found (raw integer or "-" if not calculable)
• %headblocks_order_current% : if order is specified, display the current named head found (raw integer or "-" if not calculable)
• %headblocks_order_next% : if order is specified, display the next named head to found (raw integer or "-" if not calculable)
• %headblocks_leaderboard__<name|custom|value>% : used to build a leaderboard (custom check config file)

API:

• HeadClickEvent : Event triggered when a head is clicked
• HeadCreatedEvent : Event called when a head is created
• HeadDeletedEvent : Event to trigger when a head is deleted

☕ The entire plugin source code is available on Github.

Know Issues:

• Armorstands may appear over the head. This happens when the DEFAULT config is used for holograms (which is the default) and your ProtocolLib version is out of date. If you can't upgrade your ProtocolLib version, you can change the hologram type (CMI support, HolographicDisplay or DecentHologram) or simply disable holograms.

Special thanks:

Minecraft-heads : large choice of heads textures
Item-NBT-API : head-related management
Config-Updater : update config automatically
XSound from XSeries : used to play sound
Stress-test : Just2Craft

Final words

Found an issue or have a suggestion? Feel free to use Github issue here or discussion!

The plugin is probably not perfect yet, before reviewing, don't hesitate to contact me if you need help or have errors!

Made with ❤️