Skip to content

AerWyn81/HeadBlocks

Repository files navigation

HeadBlocks

Issue Github Discord Spigot Download bStats Players bStats Servers Translations


OVERVIEW:

Welcome to the Headblocks official code repository.

  • If you want functional information about the plugin or download it, you can click on the following link: Spigot
  • If you want technical information about the plugin, you are at the right place!

The plugin is compatible with servers running in 1.20 to 1.21+ and is compiled with Java 17.

TRANSLATIONS:

Feel free to contribute or download community translations on Crowdin.
Thanks for contributing! ❤️


LINKS:


THIRD PARTY:

I'm using some third party libraries:

  • Item-NBT-API: Used to handle heads textures
  • ConfigUpdater: Used to update the config.yml and message_XX.yml at each update
  • XSound, XParticle from XSeries: Used to translate song name to the correct MC version and particles

I'm not using some bStats metrics or Auto-Updater.


API:

You can get the HeadBlocks plugin instance:

package package.artifactId;

public final class MyPlugin extends JavaPlugin {
    @Override
    public void onEnable() {
        HeadBlocks headBlocksInstance = (HeadBlocks) this.getServer().getPluginManager().getPlugin("HeadBlocks");

        if (headBlocksInstance == null) {
            // HeadBlocks not enabled
        }

        // Access at the entire plugin with the headBlocksInstance instance
        headBlocksInstance..
    }

And use:

Events Explanations
HeadClickEvent Event triggered when a head is clicked (contains success or not)
HeadCreatedEvent Event called when a head is created (contains the location)
HeadDeletedEvent Event to trigger when a head is deleted

WIKI:

Find the wiki here


It's my first plugin, it's not perfect yet, don't hesitate to tell me bugs or suggestions on discord or in issue :) Thank you for your interest ❤️

About

Hide heads in your world and let your players find them to earn rewards

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Languages