# Previews

ExcellentCrates features fully customizable preview GUIs to display possible crate rewards and their chances!

Preview configurations located in the /plugins/ExcellentCrates/previews/ directory.

By default there is only one preview configuration called default.yml.

# Preview Creation

To create a new preview, simply duplicate the existing one and rename it to whatever you like.

Configure it to your preferences and issue the /crate reload command to apply changes.

# Preview Configuration

Inside a preview file, there is a config comments section on top of it explaining Settings and Content sections of the GUI.

However, there is one more section called Rewards that defines display settings for crate rewards:

# Name

Overrides display name of the reward item. See Text Formation for a list of available tags and colors.

By default it uses internal %reward_name% placeholder that matches display name of the reward item.

# Lore.Default

Overrides lore of the reward item. See Text Formation for a list of available tags and colors.

Available placeholders:

  • Internal Crate and Reward placeholders.
  • %empty-if-above% - Inserts an empty line if the previous line is not empty.
  • %empty-if-below% - Inserts an empty line if the next line is not empty.
  • %limits% - Inserts Lore.Limits.Info text if there are any limits in the reward.
  • %no_permission% - Inserts Lore.No_Permission text if player don't have required permissions for the reward.

# Slots

List of slots where rewards displayed in the GUI.

# Hide_Unavailable

When enabled, hides rewards that a player can not obtain by whatever reason.

# Linking Preview

You can link preview to a crate using the editor.

  1. Open the editor.
  2. Click the Crates button.
  3. Click the desired crate.
  4. Right click the Preview button if it says that preview is disabled.
  5. Left click the Preview button.
  6. Select a desired preview from a list in chat.

# Disabling Preview

You can disable a preview GUI completely for a certain crate using the editor.

  1. Open the editor.
  2. Click the Crates button.
  3. Click the desired crate.
  4. Right click the Preview button so it says that preview is disabled.