Plugin Documentation

Installation Guide

Please follow the steps below to install the plugin:

  1. Download the plugin file.
  2. Open the game, click Option > Extensions > Managing plugins, which will automatically open the file manager and locate the plugin directory.
  3. Extract the downloaded plugin file into the game’s plugin directory.
  4. Restart the game, and the plugin will be automatically activated in the game.

After completing these steps, you can view and enable the installed plugin in the game’s plugin management page.

Development Guide

If you wish to develop your own plugin, here are the basic steps for creating and configuring it:

  1. Create a folder and name it after the plugin (it doesn’t have to match the plugin name).
  2. In the plugin folder, create a file named plugin.json and place it in the root directory of the project.
  3. Configure the basic structure of the plugin.json file as follows:

{
    "plugin_name": "name",
    "version": 1,
    "author": "by",
    "description": "description",
    "configuration": {
    }
}
            

In the plugin.json file, you can set the plugin’s name, version, author, description, and other configuration items. Ensure that the file format is correct and contains the necessary fields.

Once configured, you can install the plugin into the game and see it on the Option > Extensions page.

Plugin Example

Here is an example of a plugin configuration:


{
    "plugin_name": "Sword Extension",
    "version": 1.1,
    "author": "Realm of Echoes",
    "description": "Core extension",
    "configuration": {
        "item":[
            "Enhanced-Iron-Ingot",
            "Enhanced-Iron-Sword",
            "Geargrinder",
            "Star-Mist",
            "Unyielding-Forged-Blade",
            "Starlight",
            "Pure-Gold-Sword",
            "Crystal-Shard",
            "Platinum-Sword-II",
            "Chrome-longsword-II"
        ]
    }
}
            

In the example above, the configuration registers the items included in the plugin (item). You can add more features to the configuration as needed, and you can also include both objects (object) and items (item) in the configuration list.

Adding Features

Create an "A" folder (Assets) and a "B" folder (Behaviors) in your plugin project’s root directory.

  1. Create Items
  2. Create Objects