Welcome to the configuration guide for CommandPrompter. The following sub-pages will help you understand the various configuration options available in the "config.yml" file.

The Enable-Permission option enables permission checks before a player can use the prompting feature.

Usage

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

# Enable permission check
# before a player can use
# the prompting feature
Enable-Permission: false

In this example, the permission check is set to false.

Explanation

Enabling the Enable-Permission option allows you to control whether players need specific permissions to use the command prompting feature. When set to true, players must have the required permission to use the command prompting functionality.

Example

To enable permission checks, use the following configuration:

Enable-Permission: true

This will enforce permission checks for using the command prompting feature.

The Prompt-Prefix option allows you to set a custom prefix for CommandPrompter's PluginMessenger.

Usage

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

# Set the plugin prefix
Prompt-Prefix: '[&3Prompter&r] '

In this example, the prefix is set to [&3Prompter&r].

Explanation

The Prompt-Prefix is a string that appears before prompts when using the CommandPrompter plugin. It's customizable to match your server's branding or style.

Example

You can set the Prompt-Prefix to your server's name like this:

Prompt-Prefix: '[&bMyServer&r] '

This will display prompts with the prefix "[MyServer]".

The Update-Checker option determines whether CommandPrompter can check if it's up to date.

Usage

You can configure the Update-Checker by editing the "config.yml" file as follows:

In this example, the update checker is enabled (true).

Explanation

Enabling the Update-Checker option allows CommandPrompter to automatically check whether there are any updates available. When set to true, CommandPrompter can perform version checks and provide notifications if a new version is available.

Example

To disable the update checker, use the following configuration:

This will prevent CommandPrompter from checking for updates automatically.

The Prompt-Timeout option allows you to specify the duration, in seconds, until CommandPrompter cancels a prompt.

Usage

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

In this example, the timeout is set to 300 seconds.

Explanation

The Prompt-Timeout determines the period of inactivity after which CommandPrompter cancels a prompt. Adjust this value to control how long a user has to input a command before the prompt is canceled automatically.

Example

To set the Prompt-Timeout to 120 seconds, use the following configuration:

This will set the timeout to 120 seconds, allowing users two minutes to respond to a prompt.

These configurations are crucial settings within CommandPrompter that require detailed explanation. To better understand how these options work and their implications, please refer to the dedicated pages for each configuration:

By visiting the page listed above, you will gain insight into the purpose and functionality of the Enable-Unsafe and Modification-Delay configurations in CommandPrompter.

The Argument-Regex option determines if a part of a command is a prompt.

Usage

You can configure the Argument-Regex by editing the "config.yml" file as follows:

# This will determine if
# a part of a command is
# a prompt.
# 
# ONLY CHANGE THE FIRST AND LAST
# I.E (.*?), {.*?}, or [.*?]
Argument-Regex: <.*?>

In this example, the argument regex is set to <.*?>. Therefore a command with prompts will look like the following:

/test <this is a prompt>

Explanation

The Argument-Regex allows you to define a pattern that identifies prompts within a command. By customizing this regex, you can specify how CommandPrompter recognizes and handles command arguments as prompts.

Example

To modify the argument regex pattern, use the following configuration:

Argument-Regex: (.*?)

This will set the argument regex to (.*?) for identifying command prompts.

The Cancel-Keyword option determines the word that cancels command prompting.

Usage

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

# Word that cancels command
# prompting.
Cancel-Keyword: cancel

In this example, the cancel keyword is set to "cancel".

Explanation

The Cancel-Keyword is the specific word that, when entered by a user, cancels the prompt queue. It provides users with a way to exit out of the prompt queue without executing any command.

Example

To change the cancel keyword to "exit", use the following configuration:

Cancel-Keyword: exit

This will set "exit" as the keyword that cancels command prompting.

The Permission-Attachment configuration involves important settings that require detailed explanation. To better understand how this option works and its implications, please refer to the dedicated page for the Permission-Attachment configuration:

By visiting this page, you will gain insight into the purpose and functionality of the Permission-Attachment configuration in CommandPrompter.

The Ignore-MiniMessage option allows users to configure whether CommandPrompter ignores MiniMessage syntax when parsing prompts.

Usage

You can customize the Ignore-MiniMessage option by editing the appropriate configuration file, typically named "config.yml" or similar, with the following:

In this example, CommandPrompter is configured to ignore MiniMessage syntax.

Explanation

The Ignore-MiniMessage option ensures that CommandPrompter's parser does not mistake MiniMessage syntax for a prompt. This prevents conflicts and allows users to use both CommandPrompter and MiniMessage without interference.

Example

To disable the ignoring of MiniMessage syntax, set the configuration as follows:

This will enable CommandPrompter to parse MiniMessage syntax along with prompts.

The Debug-Mode option enables debug mode for CommandPrompter.

Usage

You can configure the Debug-Mode by editing the "config.yml" file as follows:

In this example, debug mode is enabled (true).

Explanation

Enabling the Debug-Mode option allows CommandPrompter to operate in debug mode, which can be useful for troubleshooting and identifying issues. Debug mode provides additional information and logs for developers to diagnose and resolve problems.

Example

To disable debug mode, use the following configuration:

This will deactivate debug mode for CommandPrompter.

The Command-Tab-Complete option enables command tab completion for CommandPrompter.

Usage

You can configure the Command-Tab-Complete by editing the "config.yml" file as follows:

In this example, command tab completion is enabled (true).

Explanation

Enabling the Command-Tab-Complete option allows CommandPrompter to provide tab completion functionality for commands. This feature assists users by suggesting or automatically completing commands based on the input provided.

Example

To disable command tab completion, use the following configuration:

This will deactivate command tab completion for CommandPrompter.

The Ignored-Commands option allows you to specify a list of commands that CommandPrompter should ignore.

Usage

You can configure the Ignored-Commands by editing the "config.yml" file as follows:

In this example, the commands sampleCommand and sampleCommand2 are ignored by CommandPrompter.

Explanation

The Ignored-Commands option allows you to specify certain commands that CommandPrompter should not process. By listing these commands, you can ensure that CommandPrompter does not interfere with their execution.

Example

To add more commands to the list of ignored commands, use the following configuration:

This will include anotherCommand in the list of commands ignored by CommandPrompter.

Adjust the content to fit your documentation style and requirements.

The Show-Complete-Command option determines whether CommandPrompter should send the completed command to the player before dispatching it.

Usage

You can configure the Show-Complete-Command by editing the "config.yml" file as follows:

# Should CommandPrompter send
# the completed command to the
# player before dispatching it?
Show-Complete-Command: true

In this example, the option to show the completed command is enabled (true).

Explanation

Enabling the Show-Complete-Command option allows players to view the final form of their command before it is executed. This feature can help prevent mistakes and ensure that the intended command is dispatched accurately.

Example

To disable the display of the completed command, use the following configuration:

Show-Complete-Command: false

This will prevent the completed command from being shown to the player.

The Fancy-Logger option enables a stylish logger for CommandPrompter.

Usage

You can configure the Fancy-Logger by editing the "config.yml" file as follows:

In this example, the fancy logger is enabled (true).

Explanation

Enabling the Fancy-Logger option allows CommandPrompter to utilize a visually enhanced logger for displaying information. The fancy logger provides a more appealing and user-friendly interface for logging activities related to CommandPrompter.

Example

To disable the fancy logger, use the following configuration:

This will deactivate the fancy logger for CommandPrompter.

The Allowed-Commands-In-Prompt option defines a list of commands that CommandPrompter allows when a player executes another command while completing a prompt.

Usage

You can configure the Allowed-Commands-In-Prompt by editing the appropriate configuration file, typically named "config.yml" or similar, with the following:

Allowed-Commands-In-Prompt:
- sampleCommand
- sampleCommand2

In this example, the specified commands (sampleCommand, sampleCommand2) are allowed to be executed while completing a prompt.

Explanation

The Allowed-Commands-In-Prompt option is designed to control which commands are permitted when a player is in the process of completing a prompt. This allows users to execute specific commands without canceling the ongoing prompt, enhancing flexibility and user experience.

Example

To add or remove commands from the allowed list, modify the configuration as needed:

Allowed-Commands-In-Prompt:
- sampleCommand
- newCommand

This will update the list to allow the execution of newCommand in addition to the existing allowed commands.

Important Notes

• Commands listed in Allowed-Commands-In-Prompt should not include the "/" prefix.

• Allowed commands that contains prompts will still be blocked.