Custom Commands Plugin Documentation
Version: 1.0
Minecraft Version: 1.21.4
Author: Your Name
Overview
The
Custom Commands Plugin allows Minecraft server admins to create custom commands that execute user-defined actions. With this plugin, you can easily map commands to specific server actions, which is perfect for enhancing server functionality or automating tasks.
Installation Instructions
- Download the Plugin:
Download the .jar file of the plugin.
- Place in the Plugins Folder:
Move the .jar file into your server's plugins directory.
- Restart or Reload the Server:
Restart your Minecraft server or use the /reload command to load the plugin.
- Verify Plugin is Loaded:
After the server restarts, use /version CustomCommandsPlugin to ensure the plugin is loaded correctly.
Plugin Configuration
There are no configuration files for this plugin. The plugin uses the in-game command /setcustcommand to set up custom commands. However, you can configure command permissions via your server's permissions manager (e.g., PermissionsEx, LuckPerms).
Commands & Usage
/setcustcommand
- Syntax: /setcustcommand <command> <action>
- Description:
Registers a new custom command. The plugin will associate the command with a predefined action, which could be any valid Minecraft command or custom behavior.
- Example Usage:
/setcustcommand /hello say Hello, World!
This will create a new command /hello that, when used, will make the server say "Hello, World!" in the chat.
- Permissions:
Admins (or players with sufficient permissions) can use this command. Permissions can be controlled via your server’s permissions manager.
Custom Commands
Once a custom command has been created using /setcustcommand, players can execute the new command just like any standard Minecraft command. For example, /hello will execute the associated action.
Permissions
You can set up permissions using a permissions plugin like
LuckPerms,
PermissionsEx, or
GroupManager.
- CustomCommandsPlugin.setcustcommand:
This permission grants players the ability to create custom commands using /setcustcommand. Make sure to assign this permission to trusted admins or users.
Example in LuckPerms:
plaintext
/lp user <username> permission set CustomCommandsPlugin.setcustcommand true
Troubleshooting
- Command not working:
Ensure that the command is correctly entered using the /setcustcommand <command> <action> syntax.
- Plugin not loading:
Ensure that the plugin .jar file is correctly placed in the plugins folder and that the server is running a supported Minecraft version (1.21.4).
- Custom commands not executing:
Double-check that the custom command is defined correctly and that players have permissions to run it.
Additional Information
- The plugin supports Spigot and Paper servers running Minecraft 1.21.4.
- The plugin can execute any valid Minecraft command or server-side action, as long as it's entered in the correct syntax.
Changelog
- Version 1.0: Initial release.
Contact & Support
For support or bug reports, please contact
[email protected]