🎇Create Firework

Guide to create a new firework

In this section we will only talk aboutfirework_type, we will not talk about the other sections, so if you want to know more, click here.

material_no_permission

This material will be displayed when a player does not have the necessary permission for the message. To learn more about the materials and how you should use them, click here.

fireworks.yml

Menu:
 material_no_permission: 'BARRIER'

No permissions

Create new firework

Below you have the model to be able to copy and paste in your configuration file, it is important that you modify the name "key_name" to avoid errors with the plugin.

It is important that you follow the firework_type step correctly, it must be arranged as it is shown, not change the order of this section.

fireworks.yml

  key_name:
   material: 'MATERIAL_NAME'
   display_name: 'FIREWORK_NAME'
   slot: 1
   lore:
    - 'Here enter the text you like'
    - 'Remember that you can also use variables from PlaceholderAPI'
    - 'and special variables of fireworks'
    - ''
   firework_type: 'Type:<TYPE>;Colors:<COLOR1>,<COLOR2>;Fade:<COLOR1>,<COLOR2>;Power:<POWER>;Amount:<AMOUNT>'
   permission: 'PERMISSIONS'

firework_type

Type

The types of fireworks are as follows. Place the name correctly to avoid errors.

1) CREEPER

2) BURST

3) STAR

4) BALL

5) BALL_LARGE

Colors

The list of colors available are as follows:

BLUE, RED, GREEN, AQUA, BLACK, FUCHSIA, GRAY, LIME, MAROON, WHITE, SILVER, YELLOW, OLIVE, TEAL, NAVY, PURPLE, ORANGE

You can also use these colors for Fade

Power

The power is with the force that the firework will be thrown, the larger the number the farther the firework will be thrown. It is recommended to only use up to 4. This so that users can visualize it.

Amount

The quantity is how many fireworks will be launched at once when a player logs in. Only 3 is recommended to avoid being annoying and causing lag.

permission

This section is optional, if you want all users to be able to select this firework without permission, just put "none", it should be:

fireworks.yml

permission: 'none'

But if you like, you can place a permission, this so that only users with this permission can select it.

fireworks.yml

permission: 'customjoin.firework_name'

Examples

Well, here are some examples of fireworks, if you like, you can copy them and put them in your configuration file.

Remember to change the name of the path (only if there is one repeated) and the place where it is located.

Example 1

fireworks.yml

  powerful:
   material: 'FIREWORK_ROCKET'
   display_name: '&9&lPowerful'
   slot: 1
   lore:
    - ''
    - '&9&nCharacteristics:'
    - ''
    - ' &a&l‣ &fType: &b%firework_type%'
    - ' &a&l‣ &fColors: &b%firework_colors%'
    - ' &a&l‣ &fFade: &b%firework_fade%'
    - ' &a&l‣ &fStatus: %firework_status_selected%'
    - ''
    - '%firework_status_locked%'
   firework_type: 'Type:CREEPER;Colors:GREEN,ORANGE;Fade:AQUA,WHITE;Power:4;Amount:3'
   permission: 'customjoinevents.firework.powerful'

Example 2

fireworks.yml

  magnificent:
   material: 'FIREWORK_ROCKET'
   display_name: '&a&lMagnificent'
   slot: 2
   lore:
    - ''
    - '&9&nCharacteristics:'
    - ''
    - ' &a&l‣ &fType: &b%firework_type%'
    - ' &a&l‣ &fColors: &b%firework_colors%'
    - ' &a&l‣ &fFade: &b%firework_fade%'
    - ' &a&l‣ &fStatus: %firework_status_selected%'
    - ''
    - '%firework_status_locked%'
   firework_type: 'Type:BALL;Colors:BLACK,TEAL;Fade:LIME,MAROON;Power:2;Amount:1'
   permission: 'customjoinevents.firework.magnificent'

Example 3

fireworks.yml

  zeus:
   material: 'FIREWORK_ROCKET'
   display_name: '&d&lZeus'
   slot: 3
   lore:
    - ''
    - '&9&nCharacteristics:'
    - ''
    - ' &a&l‣ &fType: &b%firework_type%'
    - ' &a&l‣ &fColors: &b%firework_colors%'
    - ' &a&l‣ &fFade: &b%firework_fade%'
    - ' &a&l‣ &fStatus: %firework_status_selected%'
    - ''
    - '%firework_status_locked%'
   firework_type: 'Type:BALL_LARGE;Colors:FUCHSIA,OLIVE;Fade:LIME,PURPLE;Power:1;Amount:3'
   permission: 'customjoinevents.firework.zeus'
   

Example 4

fireworks.yml

  star:
   material: 'FIREWORK_ROCKET'
   display_name: '&9&lLittle Star'
   slot: 4
   lore:
    - ''
    - '&9&nCharacteristics:'
    - ''
    - ' &a&l‣ &fType: &b%firework_type%'
    - ' &a&l‣ &fColors: &b%firework_colors%'
    - ' &a&l‣ &fFade: &b%firework_fade%'
    - ' &a&l‣ &fStatus: %firework_status_selected%'
    - ''
    - '%firework_status_locked%'
   firework_type: 'Type:STAR;Colors:YELLOW,GREEN;Fade:ORANGE,NAVY;Power:2;Amount:2'
   permission: 'customjoinevents.firework.littlestar'
   

Firework variables

Here are the variables that can be occupied solely in this event (lore), but you can also occupy PlaceholderAPI variables.

Variable	Description
%firework_name%	Displays the name of the firework, depending on the option it has (key/display_name). Example: star or Little Star
%firework_type%	Shows the type of firework that was defined in the firework_type section. Example: BALL_LARGE
%firework_colors%	Shows the colors placed in the firework_type section. Example: RED,BLUE
%firework_fade%	Shows the colors placed in the firework_type section. Example: ORANGE,YELLOW
%firework_power%	Shows the amount placed in the firework_type section. Example: 3
%firework_amount%	Shows the amount placed in the firework_type section. Example: 2
%firework_status_locked%	It shows the state of the firework, if the user has the corresponding permission, the message that you configured in translations will appear. Example: Unlocked or Locked
%firework_status_selected%	It shows the state of the firework, if the user has the corresponding permission, the message that you configured in translations will appear. Example: Selected or Unselected
%player%	Shows the name of the player who is interacting with the menu. Example: _ImJona