-
Notifications
You must be signed in to change notification settings - Fork 2
Basic Settings Document
This is the documentation about the main function of this plugin - Custom Command Configuration File. You can view the usage and function instructions for each setting here.
Configuration file for reference:
- None (waiting for supplementation)
- Create a new configuration file
- Basic Settings Description Document
- Special Settings Description Document
- Other Settings Description Document
- Create a new file in the "plugins/LiteCommandEditor/Commands" Folder
- Edit the file name "[Name].yml", for example: Example.yml (it is recommended that the file name be consistent with the command name for recognition)
- Open the file and write the following content to it (Requirements)
Tip: You can create more folders in the directory to manage the classification of custom command configuration files. When loading the plugin, all configuration files in the directory will be loaded.
Enabled: true
Prefix: [CommandPrefix] #If this option is not filled in, it defaults to "litecommandeditor"
Name: [CommandName] #The name of the main command, which is the name used when using '/[command name]'
Command-Executor: {} #Command executor options waiting for editing
Tab-Completer: {} #Tab completer options waiting for editing
- Use command "/litecommandeditor reload" or "/litecommandeditor load [FileName]" or restart server to load file.
- The creation is completed, and now you can start configuring.
- Enabled
- Prefix
- Name
- Aliases (Optional)
- Permission (Optional)
- Description (Optional)
- Usage (Optional)
Description: Whether to enabled this command configuration file.
Option: Enabled
Since the command configuration file will be automatically loaded as long as it exists, this option can be used during debugging to prevent loading.
#Example:
Enabled: true
Description: Used to declare the source of the command (usually the plugin name)
Option: Prefix
Support the use of special characters such as Chinese, and spaces are not allowed.
For example, the prefix of the command "/minecraft:gamemode" is "minecraft", and commands such as "/gamemode" and "/tp" all originate from "minecraft"
If this option is not filled in, it defaults to "litecommandeditor"
#Example:
Prefix: 'litecommandeditor' #Prefix is "/litecommandeditor:"
Description: The name of the main command
Option: Name
Support the use of special characters such as Chinese, and spaces are not allowed.
For example, the name of the command "/gamemode" is "gamemode".
This option must be filled in, otherwise the configuration file for this command cannot be loaded
#Example:
Name: 'example' #Name is "/example"
Description: The aliases of the main command
Option: Aliases
Support the use of special characters such as Chinese, and spaces are not allowed.
Fill in the other names of this command in this list, which can be used with "/[CommandAlias]" and "/[CommandPrefix]:[CommandAlias]" to trigger this command configuration file.
#Example:
Aliases: #This command configuration file can also be triggered using "/lcewiki"
- 'lcewiki'
Description: The permission of the main command
Option: Permission
This permission applies to the entire command. If the player does not have this permission, they cannot use this command.
#Example:
Permission: litecommandeditor.customcommand.example
Description: The description of the main command
Option: Description
This description will be displayed in the "/litecommandeditor info" or "/help" command
#Example:
Description: Here are the description for this command
Description: The usage of the main command
Option: Usage
This description will be displayed in the "/litecommandeditor info" or "/help" command
#Example:
Usage: Here are the usage for using the command
Description: Used to handle the execution of commands, corresponding functions will be run based on function settings.
Option: Command-Executor
Click here to view document
#Basic setting specifications: (Note that function names cannot be duplicated!)
#You can freely created multiple functions, with default execution order from top to bottom
Command-Executor:
[Function1]:
(Options...)
[Function2]:
(Options...)
...
Description: Use to handle the automatic filling function of the TAB key of the command, and will return the corresponding filling result according to the function settings
Option: Tab-Completer
Click here to view document
#Basic setting specifications: (Note that function names cannot be duplicated!)
#You can freely created multiple functions, with default execution order from top to bottom
#After executing all functions, the merged results of all formulas will be returned as the automatic filling content for this time
Tab-Completer:
[Function1]:
(Options...)
[Function2]:
(Options...)
...
Description: Used to set JSON Components, using corresponding placeholders in various settings in this article can make them the corresponding JSON components.
The JSON components set here will also be added to the plugin's JSON component list, meaning you can use this command to configure the JSON components set in the file anywhere.
Therefore, the greatest role of this setting in the command configuration file is to unify management and facilitate differentiation.
Option: JSON-Components
Click here to view document
#Basic setting specifications: (Note that component names cannot be duplicated!)
JSON-Components:
[Component1]:
(Options...)
[Component2]:
(Options...)
...
Description: This option is used to manually create items with special parameters, making it convenient to directly use the NBT and other data of the item in the custom command configuration file.
Meanwhile, the command /litecommandeditor itemcollection can also be used to serialize and save items in the game directly under this setting.
Option: Item-Collection
Click here to view document
#Basic setting specifications: (Note that item names cannot be duplicated!)
Item-Collection:
[Item1]:
(Options...)
[Item2]:
(Options...)
...