Format Gradient

Basic

The basic format is really simple and you can follow the example below, as these are the minimum requirements for a gradient format.

Colors are defined using the hexadecimal format, which follows the #FFFFFFFF pattern. Here is an example of how each color entry should be structured in the menu.yml file:

colors:
  - id: 1
    display_name: ⬛⬛⬛⬛⬛⬛⬛⬛⬛
    gradient: true
    permission: gradient.name
    patterns:
      - '#F2709C'
      - '#FF5733'
    style:
      - "STRIKETHROUGH"
  • id: A unique identifier for the color.

  • display_name: The text to display in the menu. You can use special characters or placeholders.

  • gradient: This field must be set to true to activate the gradient effect on the displayName (It will be visible in the menu.)

  • permission: Define the permissions needed for players to use the gradient. If you want all players to have access, you can set it to none.

  • patterns: This is where you add the hexadecimal colors that will form the gradient. You can include multiple colors in the list.

  • style: Here you can add chat styles, such as BOLD, ITALIC, UNDERLINE and STRIKETHROUGH.


Advanced format

The advanced format allows you to create a material, glow, custom model data, amount, and hide attributes by gradient.

Remember that the material, glowing, model_data, hide_attributes and amount paths are not needed to add a new gradient, you can use the basic format.

colors:
  - id: 1
    display_name: ⬛⬛⬛⬛⬛⬛⬛⬛⬛
    gradient: true
    permission: gradient.name
    ################
    material: BEDROCK
    glowing: true
    model_data: 0
    hide_attributes: true
    amount: 3
    ################
    patterns:
      - '#F2709C'
    style:
      - "STRIKETHROUGH"
  • material: You can assign a material that will be visible only for that gradient.

  • glowing: Must or must not be delighted with the gradient

  • model_data: You can assign a custom data model for that gradient

  • hide_attributes: Should the attributes of this gradient be hidden?

  • amount: You can assign a specific amount for that gradient.

Last updated