Welcome to the plugin tutorial for DropPartyFiesta, your all-in-one plugin for throwing the most engaging and varied drop parties for your players! The plugin currently supports 5 ways to throw drop parties:

• Throw drop party at pre-defined locations (players pick up items shot from locations)
• Throw drop party at player location (players pick up items shot from a player)
• Throw drop party in chat (players click on a message for items)
• Throw drop party with mobs (players attack the mob for items)
• Throw drop party into inventories (items drop into online player inventories)

Note: For most use-cases, you have no need to touch config files at all. The default config.yml is good enough for most cases while party-specific configurations can be managed via an in-game UI! The available configuration options are also clearly listed within the in-game editor.

The initial setup of the plugin is very simple. By default, the plugin works out of the box and you can start throwing an example party in-game (/dp throw chat example). Simply download the JAR file from spigot, drop it into your server and do a quick restart!

General options are found at the very top of config.yml under the General Configurations section and the fields are as listed below:

lang-file: en.yml
location-drop-enabled: true
player-drop-enabled: true
mob-drop-enabled: true
chat-drop-enabled: true
inventory-drop-enabled: true

The plugin comes default with the English language. However, you can easily create a file in another language, drop it within the lang folder of the plugin and then update the lang-file field above in your config.yml to use the new file.

For the rest of the 5 options, they correspond to each of the possible drop party types. By default, all are enabled but if you are super particular about performance, disabling those that you do not use may help a bit. Note that performance impact is really minimal, if not none so don't expect disabling drop parties to change anything much.

The sound & particles section can be found within the Sound & Particles Configurations section. The fields provided are as listed below:

drop-sound: ENTITY_PLAYER_LEVELUP
sound-types:
  - ENTITY_FIREWORK_ROCKET_LAUNCH
effects:
  - VILLAGER_HAPPY
show-boss-bar: true
boss-bar-colors: ["PURPLE", "PINK", "RED", "YELLOW", "GREEN", "BLUE"]
boss-bar-title: "&aDrop Party: %party_display_name%"
points-particle: SOUL_FIRE_FLAME

The drop-sound determines the sound played when a drop party is started. This can be a good way to alert your players who are alt-tabbed but have sound enabled when a party is being thrown.

The sound-types and effects determine the selection list of sound/effects that can be configured when items are being thrown. This selection list is used when configuring parties via the in-game UI.

From version 1.2.0, boss bar has been added and is enabled by setting show-boss-bar to true. The boss-bar-title and boss-bar-colors options are used to configure the appearance of the boss bar. Note that if multiple colors are specified (which is the default), the boss bar cycles through the colors on every update.

Lastly, points-particle is used to show where you have set the locations to throw drop parties. It can be toggled on and off via the /dp togglepoints <party> command in-game.

The random drop configurations are only relevant if you're trying to randomize your drop parties. This is done by specifying a list of random-drops where each random drop also contains a drops list. The default setup is as shown below:

random-drops:
  random1:
    drops:
      - mob;cow;example
      - mob;pig;example
      - mob;sheep;example
  random2:
    drops:
      - player;%random_player%;example
      - location;example
  random3:
    drops:
      - chat;example
      - inventory;example

In short, the above setup defines 3 groups of random drops (random1, random2 and random3). Within each random drop, the drops list specifies the parties that may be thrown in the format <throw type>;<optional player|mob>;<party>. Note that <throw type> here refers to one of the following 5 supported ways to throw your drop party:

• mob
• player
• location
• chat
• inventory

The <optional player|mob> is only applicable if <throw type> is mob or player, while <party> specifies the party to be thrown. In addition, players may also be randomized via the %random_player% placeholder as shown in the random2 example. If in doubt about the usage of this section, try running /dp random random1 a few times in-game to observe the behavior!

There are 2 miscellaneous configurations that are as below:

max-inv-pages: 10
parties-per-page: 10

The max-inv-pages determines the number of pages of inventories for putting the drop party items when using the in-game UI editor. By default, this is set to 10 but you can increase this limit if you are creating a massive drop party.

The plugin comes with the following permissions and their associated commands/actions:

Permission Nodes Recommended for Players:

• None (players should not be able to throw drop parties or they could give themselves unlimited items)

Permission Nodes Recommended for Admins:

• dpfiesta.* (gives access to all commands)

• dpfiesta.create

  • Command: /dp create
  • Description: creates a drop party

• dpfiesta.edit

  • Command: /dp edit
  • Description: edits a drop party

• dpfiesta.delete

  • Command: /dp delete
  • Description: deletes a drop party

• dpfiesta.clone

  • Command: /dp clone <existing_party> <new_party>
  • Description: clones a drop party

• dpfiesta.list

  • Command: /dp list
  • Description: lists all parties

• dpfiesta.setdisplayname

  • Command: /dp setdisplayname
  • Description: sets the display name of a party

• dpfiesta.setpoint

  • Command: /dp setpoint
  • Description: sets location for a party based on where you are looking at

• dpfiesta.unsetpoint

  • Command: /dp unsetpoint
  • Description: unsets location for a party based on where you are looking at

• dpfiesta.unsetallpoints

  • Command: /dp unsetallpoints
  • Description: unsets all locations for a party

• dpfiesta.togglepoints

  • Command: /dp togglepoints
  • Description: toggles particles to visualize locations for a party

• dpfiesta.help

  • Command: /dp help
  • Description: shows all commands

• dpfiesta.reload

  • Command: /dp reload
  • Description: reloads the plugin

• dpfiesta.throw.*

  • Command: /dp throw
  • Description: throws all types of drop parties

• dpfiesta.throw.location

  • Command: /dp throw location
  • Description: throws location drop parties

• dpfiesta.throw.player

  • Command: /dp throw player
  • Description: throws player drop parties

• dpfiesta.throw.mob

  • Command: /dp throw mob
  • Description: throws mob drop parties

• dpfiesta.throw.chat

  • Command: /dp throw chat
  • Description: throws chat drop parties

• dpfiesta.throw.inventory

  • Command: /dp throw inventory
  • Description: throws inventory drop parties

• dpfiesta.random

  • Command: /dp random
  • Description: picks a party randomly to throw

• dpfiesta.stop

  • Command: /dp stop
  • Description: stops drop party (if name is not provided, stops all drop parties)

The in-game editor is well furnished for you to configure your drop parties. Here is an example of how the UI looks:

The entire section on the left shows the 24 available options which you may interact with to configure your drop party. The top-right section is where you'll place the items you wish to include in the drop parties. Finally, the bottom-right section is where you may view a summary by hovering over the compass, navigate the inventory pages as well as save your configurations. When in doubt, hover over the items and you will get a clear explanation such as below:

As of version 1.1.1, the plugin also supports hex color codes in messages. An example usage for red (#ff0000) color in the reload message is as shown below:

• '#ff0000DropPartyFiesta has been reloaded!'

Note that since # is now identified as a special character for hex color code, you will need to escape it with \# if you want to use # in your string without it being interpreted as a color code.

Normal minecraft color codes (e.g. '&c') are still supported!

While the GUI is fully customisable, this is not encouraged since the GUI is only viewed and used by admins. However, if you insist, you may refer to the default configurations for the GUI which has detailed comments on how you may change the UI.

This section is relevant if you're looking to migrate from DropParty over to DropPartyFiesta. Migration can be done in 3 quick steps:

1. Replace the lite version JAR with the premium version JAR and restart your server.
2. Copy the contents of your parties folder from dropparty folder into droppartyfiesta folder and reload the plugin.
3. If you are using any permission nodes, update it to match the premium plugin (e.g. dp.throw.* -> dpfiesta.throw.*).

Note: It is not recommended to copy over the lang/en.yml file and menu/party.yml files as the premium version has new fields not present in the lite version. If you do choose to copy those over, you will have to manually patch the missing fields.