Skip to content

Instantly share code, notes, and snippets.

@KageDesu
Created February 20, 2025 23:54
Show Gist options
  • Save KageDesu/de131833c9523b8b53a51f1f7b6304c7 to your computer and use it in GitHub Desktop.
Save KageDesu/de131833c9523b8b53a51f1f7b6304c7 to your computer and use it in GitHub Desktop.
Alchemy Workshop Plugin Guide

Alchemy Workshop Plugin Guide

2025-02-21_02-03-16

Author: Pheonix KageDesu
Target: RPG Maker MZ / MV
Website: KD Workshop


Overview

  • Plugin adds an alchemy workshop where player can mix different items and add ingredients to create new items with new properties.
  • Plugin allows you to create new items, add new properties to existing items, change existing item properties.

How to Use

Alchemy Workshop

Use next script call: OpenAlchemyWorkshop(); to open alchemy workshop.

2025-02-21_02-13-00

How to use alchemy workshop:

  • Select Base Item
  • Add materials
  • Click "Create" button to create new item

2025-02-21_02-41-39


Base Item

  • Process of creating new item is based on selecting base item and adding materials (other items) to it.

  • You must add special (required) tags to item in database to make it base item

  • You can add optional tags to customize alchemy workshop behavior

2025-02-21_02-15-48

Required Tags

  • <alchemyBaseItem> - this tag makes item base item for alchemy workshop.
  • <alchemySlot:ID,0|1> - slot for material item. ID - material ID. If 0 - slot is optional, if 1 - slot is required (you should set material item to this slot).

2025-02-21_02-04-08

Note: Base item can have multiple slots. You can add multiple <alchemySlot> tags to item. But at least one slot must be added.

Note: Slot ID can be any text value. It will be used as slot identifier for material item.

Note: Free (basic) version of plugin allow you add only two slots to base item. If you need more slots (unlimited), you can purchase (or subscribe) PRO version of plugin.

Example:

<alchemyBaseItem>
<alchemySlot:A,1>
<alchemySlot:B,0>
<alchemySlot:B,0>

Optional Tags

  • <baseItemCopyFrom:ID> - ID of another item from Database that will be used as base item. All tags from this item will be copied to current item. By default this value is 0 = used same item for copy.

  • <newName:NAME> - New item name for created item. NAME - new item name. By default new item name will be same as base item name.

  • <keepDescription> - Keep base item description. By default = remove base item description.


Material Item

  • Material item is item that you can add to base item to create new item. All properties from material item will be added to base item.

  • Material item can be added to base item only if it has <alchemyMaterialItem:ID> tag with same ID as base item slot support.

  • Materal item can have optional tags to customize alchemy workshop behavior

2025-02-21_02-27-41

Required Tags

  • <alchemyMaterialItem:ID,...> - this tag makes item material item for alchemy workshop. ID - supported slot ID of base item. You can add multiple IDs separated by comma.

Example:

<alchemyMaterialItem:A>
<alchemyMaterialItem:A,B>

Optional Tags

  • <addPostfix:POSTFIX> - add postfix to item name. POSTFIX - text that will be added to item name. By default = empty.
<addPostfix:of thunder>
  • <addSuffix:SUFFIX> - add suffix to item name. SUFFIX - text that will be added to item name. By default = empty.
<addSuffix:Big>
  • <addExtraNotesFrom:ID> - ID of another item from Database that will be used as source for extra notes. All notetags from this item will be added to current item. By default this value is 0.

  • <newName:NAME> - New item name for created item. NAME - new item name. By default new item name will be same as base item name.

Example:

<newName:Super Potion>
  • <newIconIndex:INDEX> - New icon index for created item. INDEX - new icon index. By default new icon index will be same as base item icon index.

Example:

<newIconIndex:422>
  • <replaceIcon> - add this for replace icon of base item with icon of material item.

  • <replaceDamage> - add this for replace damage of base item with damage of material item.

  • <replaceAnimation> - add this for replace animation of base item with animation of material item.

  • <replaceConsumable> - add this for replace consumable flag of base item with consumable flag of material item.

  • <replaceScope> - add this for replace scope of base item with scope of material item.

  • <replaceOccasion> - add this for replace occasion of base item with occasion of material item.

  • <price:add|replace|ignore> - price behavior. Add - add price to base item, Replace - replace price of base item, Ignore - ignore price of material item. By default = ignore.

Example:

<price:replace>
  • <name:add|replace|ignore> - name behavior. Add - add name to base item, Replace - replace name of base item, Ignore - ignore name of material item. By default = ignore.

  • <description:add|replace|ignore> - description behavior. Add - add description to base item, Replace - replace description of base item, Ignore - ignore description of material item. By default = ignore.

  • <damageFormula:add|replace|ignore> - damage formula behavior. Add - add damage formula to base item, Replace - replace damage formula of base item, Ignore - ignore damage formula of material item. By default = ignore.

  • <repeats:add|replace|ignore> - repeats behavior. Add - add repeats to base item, Replace - replace repeats of base item, Ignore - ignore repeats of material item. By default = ignore.

  • <tpGain:add|replace|ignore> - tp gain behavior. Add - add tp gain to base item, Replace - replace tp gain of base item, Ignore - ignore tp gain of material item. By default = ignore.

  • <success:add|replace|ignore> - success rate behavior. Add - add success rate to base item, Replace - replace success rate of base item, Ignore - ignore success rate of material item. By default = ignore.

  • <speed:add|replace|ignore> - speed behavior. Add - add speed to base item, Replace - replace speed of base item, Ignore - ignore speed of material item. By default = ignore.

  • <effects:add|replace|ignore> - effects behavior. Add - add effects to base item, Replace - replace effects of base item, Ignore - ignore effects of material item. By default = ignore.

  • <notes:add|replace|ignore> - notes behavior. Add - add notes to base item, Replace - replace notes of base item, Ignore - ignore notes of material item. By default = ignore.


Plugin Customization

Plugin Parameters

  • Plugin have parameters for customization.

Visual Customization

  • Plugin visuals based on NUI

  • You can modify the appearance of the treasure chest by editing the .json files located in: data\PKD_AlchemyWorkshop\ (all files starting with NUI_).

  • Images are stored in the img\PKD_AlchemyWorkshop\ folder. You can replace these images with your.


Enjoy the plugin!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment