Plugin Item Documentation

Plugin Item Creation Guide

Follow the steps below to create a plugin item:

1. Create two folders in the project: A and B.
   The A folder is for item textures, and the B folder is for item configuration files.
2. Create the item's json file in the B/item/ folder (filename: ID+.json).
3. Place the item texture in the A/item/ folder, and the texture filename should match the ID in the json file (filename: ID+.png).

Note: Comments are not supported in JSON format, so you need to remove the comments before using it.

Example 1: Creating Enhanced Iron Ingot

This example shows how to create an item called "Enhanced Iron Ingot", which is made by synthesizing two iron ingots and one blue slime ball.

{
    "ID": "Enhanced-Iron-Ingot",  // Unique identifier for the item
    "type": "items",  // Type of item, here it is a regular item
    "description": "A special type of iron, stronger and more durable than regular iron.",  // Item description
    "mod": "Synthesis_table",  // How the item is crafted, synthesized through a synthesis table
    "table": {  // Materials needed for crafting
        "Type": "items",  // Type of crafted item
        "items": {  // List of specific items for crafting
            "Iron-Ingot": {
                "Num": 2  // Number of iron ingots needed
            },
            "BlueSlime-ball": {
                "Num": 1  // Number of blue slime balls needed
            }
        }
    }
}
            

Example 2: Creating Crystal Shard

This example shows how to create an item called "Crystal Shard", which can drop from monsters, including AzureSkeleton and MysticStoneSentinel.

{
    "ID": "Crystal-Shard",  // Unique identifier for the item
    "type": "Items",  // Type of item, here it is a regular item
    "description": "A sparkling shard of crystal, imbued with mystical energies. It is a key ingredient for crafting powerful weapons and enhancing gear.",  // Item description
    "mod": "Drop",  // How the item is obtained, dropped by monsters
    "table": {  // Drop settings
        "AzureSkeleton": [
            {"scene": "Crystal-Shard", "rarity": 10}  //AzureSkeleton drops crystal shard with a weight of 10
        ],
        "MysticStoneSentinel": [
            {"scene": "Crystal-Shard", "rarity": 17}  // MysticStoneSentinel drops crystal shard with a weight of 17
        ]
    }
}
            

Example 3: Creating Starlight Sword

This example shows how to create a weapon called "Starlight Sword", crafted with sapphire, iron ingot, and wood, and with additional attack properties.

{
    "ID": "Starlight",  // Unique identifier for the item
    "type": "Weapons",  // Type of item, here it is a weapon
    "description": "A gorgeous and dazzling glowing sword, known for its agility and speed.",  // Item description
    "mod": "Synthesis_table",  // How the item is crafted, synthesized through a synthesis table
    "table": {  // Materials needed for crafting
        "Type": "Weapons",  // Type of crafted item
        "items": {  // List of specific items for crafting
            "Sapphire": {
                "Num": 1  // Number of sapphires needed
            },
            "Iron-Ingot": {
                "Num": 1  // Number of iron ingots needed
            },
            "Wood": {
                "Num": 1  // Number of wood pieces needed
            }
        }
    },
    "attack": {  // Attack properties of the item
        "Sharp": "(1,1)",
        "Fast": "(1,3)"
    }
}
            

Example 4: Creating Star Mist Sword

This example shows how to upgrade the Starlight Sword to create a new weapon called "Star Mist Sword".

{
    "ID": "Star-Mist",  // Unique identifier for the item
    "type": "Weapons",  // Type of item, here it is a weapon
    "description": "The blade is like starlight, gleaming with a faint glow, light and formless. It swings like the wind, silent in its deadly intent.",  // Item description
    "mod": "WeaponsUpgrade",  // How the item is upgraded, through upgrading an existing weapon
    "table": {  // Materials needed for upgrading
        "Weapon": "Starlight",  // The weapon being upgraded
        "items": {  // List of materials needed for upgrading
            "Platinum-Ingot": {
                "Num": 1  // Number of platinum ingots needed
            },
            "Enhanced-Iron-Ingot": {
                "Num": 2  // Number of enhanced iron ingots needed
            },
            "Crystal-Shard": {
                "Num": 2  // Number of crystal shards needed
            }
        }
    },
    "attack": {  // Attack properties of the item
        "Sharp": "(1,1)",
        "Fast": "(1,5)",
        "Undead_killer": "(1,1)"
    }
}
            

Plugin Configuration Example

Then, add the ID of your new item to the item section of the plugin.json 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"
        ]
    }
}
            

If the "Type" is "Weapon", then an "Attack" key is required, where the key for the "Attack" key is "(1,1)" representing "(Duration, Strength)".

For the key "attack", you can refer to the Weapon Increase ID.

For the key "mod", you can refer to the Enemy ID when dropping items.

For the crafting table, you can refer to the Item ID.

If the "type" is "Weapons", the "attack" key is required, where "(1,1)" in the attack represents "(duration, strength)".

After configuration, you can install the plugin in the game and view it on the Options > Extensions page.