Module: command_rewrite

Overview

Module

This module allows defining regex to rewrite the command line issued by a player.

Color Boxes

Note

◉ How it works?

1. Intercept the issued command string packets.

2. Apply the defined rewrite rules to the command string in top-down order.

NOTE: The command_rewrite occurs at the very beginning of the command lifecycle.

You will not receive command suggestions or command exceptions at this stage.

The rewrite rules are applied directly to the raw command string.

◉ Command Lifecycle

1. Issuing – The command is sent as a raw string. At this stage, no command suggestions or exceptions are available.

2. Parsing – The command string is parsed into a command node. At this point, command suggestions and exceptions can be provided.

3. Execution – The actions associated with the command node are executed, producing the intended effects of the command.

Note

◉ The different compared to command_alias module and command_bundle module.

1. The command alias module allows you to define new command, and redirects it into an existing command.

2. The command bundle module allows you to define new command, and define the argument and body of the new command.

3. The command rewrite module didn't define any new command. It just works in network packet level, and modifies the issued command string from the command source player.

Tip

◉ You can use this module to shorten the command string.

Like, rewrite the command string /home into /home tp default.

And provide a shortcut, for /home tp default command.

Configurations

The following JSON content is provided for reference only. It must NOT be copied directly into the configuration directory, as it does not represent valid JSON syntax.

Config

• File Name: config.json
• File Content:

Click to see the default content...

config/fuji/modules/command_rewrite/config.json

{
  /* Defined `rewrite` entries. */
  "rules": [
    {
      /* The `regex` expression used to match the `target string`. */
      "regex": "\\?"
      /* The `pattern` used to replace the `matched target string`. */,
      "replacement": "help"
    }
  ]
}