/minecraft-treasure-hunt

Minecraft treasure hunt using WorldGuard regions

Primary LanguageJava

Minecraft Treasure Hunt

Treasure hunts for WorldGuard regions. Supports poly and cuboid regions only. Supported hunt types are 'easter', 'halloween', 'thanksgiving', 'christmas' and 'party'.

This plugin can throw a JSON payload at a given endpoint whenever an item is found. It's up to you to write something to handle it.

This plugin is provided free of charge with no guarantees that it will work, and no promise of support. Should you stumble upon this and try to use it, you're welcome to report any issues you may encounter in the 'Issues' tab and I'll try to help you. If you are trying to use the plugin without meeting the requirements set out below, this is not supported and I will be unable to offer any assistance.

Requirements

  • Spigot or Paper v1.20.4 (earlier versions may work but this is not guaranteed)
  • Item NBT API v2.12.3

Configuration options

treasureHuntEnabled: false
apiEndpoint: ''
apikey: ''
hunts:
  world_name:
    region_name:
      enabled: true

treasureHuntEnabled

true if the plugin should attempt to initialise and start treasure hunts. false if treasure hunts are globally disabled and the plugin should do nothing.

apiEndpoint

URL of API endpoint for keeping track of player scores, without a trailing slash. e.g. apiEndpoint: 'https://example.com/treasure-hunt-api'

The data sent in the JSON payload has the following keys:

  • uuid (player UUID)
  • name (player name)
  • egg (name of the item found)
  • region (ID of the WorldGuard region the item was found in)
  • world (name of world where item was found)

The 'API Key' is sent as a query parameter in the GET request to the endpoint, with a name of 'k'.

apiKey

Token for authenticating your game server against the score tracking API

hunts

World and region names must be written in lowercase letters in config.yml Tree comprising world names, and regions within those worlds where treasure hunts are to be configured. Set 'enabled' (boolean) below a region name to either true or false to enable or disable a treasure hunt in this region.