RB_CUSTOMECOMMANDS

RB Custom Commands

A simple and lightweight Paper/Purpur plugin for Minecraft (1.21 to 1.21.11) that allows server administrators to create up to 20 custom commands. When a player executes one of these commands, they receive a private message defined in the configuration.

Features

- Color Code Support: Define up to 20 custom commands in the `config.yml` file. - Color Code Support: Messages are sent privately to the player who executes the command, preventing chat spam. - Color Code Support: Simple and straightforward configuration for adding, modifying, or removing commands. - Color Code Support: Use standard Minecraft color codes (`&`) in your messages.

Compatibility

- Server Software: 1.21 to 1.21.11 - Server Software: Paper, Purpur

Installation

1. Download the latest version of `RBCustomCommands.jar` from the releases page. 2. Place the downloaded `.jar` file into the `plugins` folder of your server. 3. Restart or reload your server to generate the default `config.yml` file. 4. Customize the `config.yml` file to add your own commands.

Configuration

The `config.yml` file is located in the `plugins/RBCustomCommands` directory. Here is an example configuration:

```yaml max-commands: 20 commands: hello: "&aHello!&r" discord: "&bJoin our Discord: &fdiscord.gg/yourserver&r" rules: "&6Read the rules in &e/rules&r" ```

- `max-commands`: The maximum number of custom commands allowed (default is 20). - `commands`: A list of custom commands. Each command has a name (the command itself) and a message (the text sent to the player).

Usage

Once the plugin is installed and configured, players can use the custom commands in-game. For example, if you have a command named `discord`, players can type `/discord` to receive the configured message.

Building from Source

If you want to build the plugin from the source code, you will need:

- Java Development Kit (JDK) 17 or higher - Apache Maven

To build the plugin, run the following command in the root directory of the project:

```bash mvn clean package ```

The compiled `.jar` file will be located in the `target` directory.

License

This project is licensed under the MIT License. See the LICENSE file for details.