The prompt-config.yml file contains various configuration options that allow customization and control over the prompts and user interfaces in the CommandPrompter plugin. This configuration file is essential for managing the behavior and appearance of different prompt-related features within the plugin. Below are the key configuration options available in the prompt-config.yml file:

• Player UI: Configures the visual aspects and behavior of the Player UI Prompt.

• Anvil UI: Manages the settings related to Anvil UI Prompt.

• Chat Prompt: Controls the settings for Chat Prompt.

• Sign UI: Defines the configuration for the Sign UI Prompt.

For detailed information on each configuration option and its specific parameters, refer to the individual pages corresponding to each configuration option within the prompt-config.yml file.

Feel free to customize this overview based on your documentation requirements.

Controls the settings for Chat Prompt.

• Clickable-Cancel

• Cancel-Message

• Cancel-Hover-Message

• Response-Listener-Priority

The TextPrompt.Response-Listener-Priority option allows you to change the priority of the response listener for Chat Prompt.

Usage

You can configure the TextPrompt.Response-Listener-Priority by editing the "prompt-config.yml" file as follows:

TextPrompt:
  Response-Listener-Priority: DEFAULT

In this example, the response listener priority is set to DEFAULT.

Example

To change the response listener priority to a different level, use one of the following values: LOW, LOWEST, NORMAL, HIGH, or HIGHEST in the configuration:

TextPrompt:
  Response-Listener-Priority: HIGH

This will set the response listener priority to HIGH.

The TextPrompt.Cancel-Message option specifies the clickable text message for canceling command completion in the TextPrompt feature.

Usage

You can configure the TextPrompt.Cancel-Message by editing the "prompt-config.yml" file as follows:

TextPrompt:
  Cancel-Message: '&7[&c&l✘&7]'

In this example, the cancel message is set to "[✘]" in red color.

Explanation

The TextPrompt.Cancel-Message option allows you to define the message that appears as the clickable option for canceling command completion. This message provides users with a visual cue to initiate the cancellation process.

Example

To customize the cancel message, use the following configuration:

TextPrompt:
  Cancel-Message: '&7[&4Cancel&7]'

This will display "[Cancel]" in dark red color as the cancel message.

The TextPrompt.Clickable-Cancel option enables clickable cancel functionality in the TextPrompt feature.

Usage

You can configure the TextPrompt.Clickable-Cancel by editing the "prompt-config.yml" file as follows:

In this example, the clickable cancel functionality is enabled.

Explanation

The TextPrompt.Clickable-Cancel option allows you to provide users with the ability to cancel command completion through a clickable option. Enabling this feature can enhance user interaction and make the cancellation process more convenient.

Example

To disable the clickable cancel functionality, use the following configuration:

This will disable the clickable cancel option.

The PlayerUI.Cache-Size option determines the size of the head cache in the PlayerUI feature.

Usage

You can configure the PlayerUI.Cache-Size by editing the "prompt-config.yml" file as follows:

In this example, the head cache size is set to 256.

Explanation

The PlayerUI.Cache-Size option specifies the maximum number of player heads that can be stored in the cache. Adjusting this value allows you to control the capacity of the cache to accommodate the desired number of player heads.

Example

To set the cache size to 128, use the following configuration:

This will limit the head cache to store a maximum of 128 player heads.

The TextPrompt.Cancel-Hover-Message option specifies the message to show when a player hovers over the clickable cancel message in the TextPrompt feature.

Usage

You can configure the TextPrompt.Cancel-Hover-Message by editing the "prompt-config.yml" file as follows:

In this example, the hover message is set to "Click here to cancel command completion" in gray color.

Explanation

The TextPrompt.Cancel-Hover-Message option allows you to define the message that appears when a player hovers over the clickable cancel message. This message provides additional context or instruction to users regarding the functionality of the cancel option.

Example

To customize the hover message for the cancel option, use the following configuration:

This will display "Press to end completion" in gray color when a player hovers over the clickable cancel message in the.

Configures the visual aspects and behavior of the Player UI Prompt.

• Skull-Name-Format

• Skull Custom Model Data

• Size

• Cache-Size

• Cache-Delay

• PlayerUI Control Items

• Sorted

• Per-World

• Empty-Message

The PlayerUI.Cache-Delay option determines the delay in ticks after a player joins before their head gets cached in the PlayerUI feature.

Usage

You can configure the PlayerUI.Cache-Delay by editing the "prompt-config.yml" file as follows:

PlayerUI:
  Cache-Delay: 5

In this example, the cache delay is set to 5 ticks.

Explanation

The PlayerUI.Cache-Delay option controls the duration of the delay before a player's head is cached in the PlayerUI feature after they join the server. Adjusting this value allows you to manage the timing of the caching process.

Example

To set the cache delay to 10 ticks, use the following configuration:

PlayerUI:
  Cache-Delay: 10

This will delay the caching of a player's head by 10 ticks after they join the server.

Skull Custom Model Data Configuration

The Skull-Custom-Model-Data option allows server managers to set a custom model data for the player heads that appear under the PlayerUI.

Usage

You can configure the Skull-Custom-Model-Data option by editing the appropriate configuration file, typically named "prompt-config.yml" or similar, with the following:

Skull-Custom-Model-Data: 0

In this example, the custom model data for player heads is set to 0.

Explanation

The Skull-Custom-Model-Data option enables server managers to customize the appearance of player heads displayed under the PlayerUI by setting a custom model data. This allows for unique visual representations of player heads within the user interface.

Example

To modify the custom model data for player heads, adjust the configuration as needed:

Skull-Custom-Model-Data: 123

This will set the custom model data for player heads to 123 within the PlayerUI.

The PlayerUI.Empty-Message option specifies the message to be displayed when the head cache is empty in the PlayerUI feature.

Usage

You can configure the PlayerUI.Empty-Message by editing the "prompt-config.yml" file as follows:

PlayerUI:
  Empty-Message: '&cNo players found!'

In this example, the empty message is set to "No players found!" in red color.

Explanation

The PlayerUI.Empty-Message option allows you to define the message that appears when there are no players to display in the PlayerUI feature. This message informs users that there are no available players to select.

Example

To customize the empty message, use the following configuration:

PlayerUI:
  Empty-Message: '&cThere are no online players!'

This will display the message "There are no online players!" in red color when the head cache is empty.

Manages the settings related to Anvil UI Prompt.

• Enable-Title

• Custom-Title

• Prompt-Message

• Item

• Enchanted

The PlayerUI.Skull-Name-Format option determines the display name format for the player heads in the PlayerUI.

Usage

You can configure the PlayerUI.Skull-Name-Format by editing the "prompt-config.yml" file as follows:

In this example, the display name format is set to &6%s.

Explanation

The PlayerUI.Skull-Name-Format allows you to define the formatting for the display names associated with player heads in the PlayerUI feature. You can customize this format to enhance the visual appearance of the player heads.

Example

To change the display name format to display in a different color, use the following configuration:

This will display the player heads with names in green color.

The PlayerUI.Sorted option determines whether the player heads in the PlayerUI feature should be sorted by the name of the players.

Usage

You can configure the PlayerUI.Sorted by editing the "prompt-config.yml" file as follows:

In this example, the player heads are not sorted.

Explanation

The PlayerUI.Sorted option allows you to control whether the player heads should be displayed in a sorted order within the PlayerUI feature. Enabling sorting can help organize the player heads for easier navigation.

Example

To enable sorting for the player heads, use the following configuration:

This will sort the player heads within the PlayerUI feature.

The AnvilGUI.Custom-Title option allows you to set a custom title for the Anvil GUI if the title is enabled.

Usage

You can configure the AnvilGUI.Custom-Title by editing the "prompt-config.yml" file as follows:

In this example, no custom title is provided.

Explanation

The AnvilGUI.Custom-Title option enables you to define a personalized title for the Anvil GUI when the title is enabled. You can use this feature to provide users with a more descriptive or engaging title that complements the prompt.

Example

To set a custom title for the Anvil GUI, use the following configuration:

This will display "Enter Your Text Here" as the custom title in the Anvil GUI.

The control items in the PlayerUI feature include the Previous, Next, and Cancel options, each with specific configuration:

• Item: Specifies the item displayed for the Previous control.

• Custom-Model-Data: Sets the custom model data for the item.

• Column: Defines the column in which the Previous control is located.

• Text: Displays the text associated with the Cancel control.

Refer to the "prompt-config.yml" file for the specific configurations related to each control item.

The PlayerUI.Filter-Format option allows users to configure the display format for heads in the Player UI based on different filters.

Usage

You can customize the PlayerUI.Filter-Format by editing prompt-config.yml

PlayerUI:
  Filter-Format:
    World: '&6𑁍 %s'
    Radial: '&cᯤ %s'

In this example, we set the format for both World and Radial. Not all filters will be configured to have a format by default. However, if there are no format defined, it will use the Skull-Name-Format config.

Explanation

The PlayerUI.Filter-Format option enables users to tailor the display format of heads in the Player UI based on different filters.

Example

To modify the display format for a particular filter, adjust the configuration as needed:

PlayerUI:
  Filter-Format:
    World: '&6(w) %s'
    Radial: '&c(r) %s'

Important Notes

• The %s placeholder represents the player's name and will be replaced dynamically in the display format.

• Customize the display formats according to your preferences to enhance the visual representation of heads in the Player UI.

The PlayerUI.Size option determines the size of the UI for the PlayerUI feature.

Usage

You can configure the PlayerUI.Size by editing the "prompt-config.yml" file as follows:

PlayerUI:
  Size: 54

In this example, the size of the UI is set to 54.

Explanation

The PlayerUI.Size option allows you to specify the size of the UI for displaying player heads. Adjusting this value determines the number of slots available in the UI layout.

Example

To set the size of the UI to 36, use the following configuration:

PlayerUI:
  Size: 36

This will adjust the size of the UI to have 36 slots.

Feel free to adjust the content as needed to fit your documentation style and requirements.

The AnvilGUI.Enchanted option determines whether the item on the Anvil GUI should be displayed as enchanted.

Usage

You can configure the AnvilGUI.Enchanted by editing the "prompt-config.yml" file as follows:

In this example, the item on the Anvil GUI is not displayed as enchanted.

Explanation

The AnvilGUI.Enchanted option allows you to control whether the item should appear as enchanted on the Anvil GUI. Enabling this option can add a visually enhanced effect to the item, providing a more distinct appearance for users.

Example

To display the item on the Anvil GUI as enchanted, use the following configuration:

This will present the item on the Anvil GUI with an enchanted visual effect.

The SignUI.Material option specifies the material used for the signs in the Sign UI feature.

Usage

You can configure the SignUI.Material by editing the appropriate configuration file, typically named "config.yml" or similar, with the following:

SignUI:
  Material: OAK_SIGN

In this example, the material for signs is set to OAK_SIGN.

Explanation

The SignUI.Material option allows you to define the material used for signs within the Sign UI feature. The specified material determines the appearance of the signs during user interactions.

Example

To change the material for signs to a different type, update the configuration as follows:

SignUI:
  Material: SPRUCE_SIGN

This will set the material for signs to SPRUCE_SIGN within the Sign UI feature.

Valid Materials

The value assigned to SignUI.Material should match a valid Minecraft material, typically containing the word "SIGN." Common examples include OAK_SIGN, BIRCH_SIGN, ACACIA_SIGN, and more.

Refer to the Minecraft Materials documentation for a comprehensive list of available materials.

The PlayerUI.Per-World option determines whether the listed players in the PlayerUI feature should be limited to players within the same world as the PlayerUI user.

Usage

You can configure the PlayerUI.Per-World by editing the "prompt-config.yml" file as follows:

PlayerUI:
  Per-World: false

In this example, the option to limit the listed players to the same world is disabled.

Explanation

The PlayerUI.Per-World option allows you to control whether the PlayerUI feature should display only the players within the same world as the user accessing the PlayerUI. Enabling this option can help focus the selection on players within the same game environment.

Example

To enable the restriction of listed players to the same world, use the following configuration:

PlayerUI:
  Per-World: true

This will limit the listed players to those within the same world as the PlayerUI user.

The AnvilGUI.Prompt-Message option specifies the message to be displayed on the Anvil GUI

Usage

You can configure the AnvilGUI.Prompt-Message by editing the "prompt-config.yml" file as follows:

AnvilGUI:
  Prompt-Message: ''

In this example, no prompt message is provided.

Explanation

The AnvilGUI.Prompt-Message option allows you to define a message that provides guidance or instructions for users within the Anvil GUI. You can use this message to prompt users on what type of input is expected or guide them through the input process.

Example

To set a prompt message for the Anvil GUI, use the following configuration:

AnvilGUI:
  Prompt-Message: 'Please enter your text here:'

This will display "Please enter your text here:" as the prompt message in the Anvil GUI.

The AnvilGUI.Item option specifies the item to be placed on the Anvil GUI.

Usage

You can configure the AnvilGUI.Item by editing the "prompt-config.yml" file as follows:

AnvilGUI:
  Item:
    Material: Paper
    Custom-Model-Data: 0

In this example, the item on the Anvil GUI is set to Paper with a custom model data of 0.

Explanation

The AnvilGUI.Item option allows you to define the specific item that appears on the Anvil GUI. You can customize the material and additional properties, such as custom model data, to enhance the visual representation of the item for users.

Example

To change the item on the Anvil GUI to a different material with custom model data, use the following configuration:

AnvilGUI:
  Item:
    Material: Diamond
    Custom-Model-Data: 123

This will display a Diamond item with custom model data 123 on the Anvil GUI.

The AnvilGUI.Enable-Title option determines whether to show the first line of the prompt (if with {br}) as the title of the Anvil GUI.

Usage

You can configure the AnvilGUI.Enable-Title by editing the "prompt-config.yml" file as follows:

AnvilGUI:
  Enable-Title: true

In this example, the option to enable the title is set to true.

Explanation

The AnvilGUI.Enable-Title option allows you to control whether the first line of the prompt is displayed as the title in the Anvil GUI. Enabling this option can provide users with a clearer context for their input within the Anvil GUI.

Example

To disable the display of the first line of the prompt as the title, use the following configuration:

AnvilGUI:
  Enable-Title: false

This will prevent the first line of the prompt from being shown as the title in the Anvil GUI.

The SignUI.Input-Field-Location option specifies the line from which the answer should be read in the Sign UI feature.

Usage

You can configure the SignUI.Input-Field-Location by editing the "prompt-config.yml" file as follows:

SignUI:
  Input-Field-Location: bottom

In this example, the input field is set to be read from the bottom line of the sign.

Explanation

The SignUI.Input-Field-Location option determines the specific line on the sign that should be considered as the input field. This setting helps identify where the user's response will be located within the Sign UI feature.

Example

To change the input field location to a different line, use one of the following values: top, top-aggregate, bottom, or bottom-aggregate in the configuration:

SignUI:
  Input-Field-Location: top

This will set the input field location to the top line of the sign in the Sign UI feature.

Defines the configuration for the Sign UI Prompt.

• Input-Field-Location

• Material