Items

Overview

Items are pieces of data stored in the player's inventory. They can serve various purposes, such as being consumable, equippable, or offering other functionalities.

How to Create an Item

Right-click in the Project window of Unity, or go to the Asset menu at the top left.
Navigate to Create > Asteria > Item.
After selecting "Item," give your item a unique name (this refers to the asset in the project, not the name shown in the inspector). To avoid conflicts with other mods, consider naming it something like MyModName_ItemName.

Now that your item is created, you can set up its data. Below, you'll find example items and details about each piece of data that makes up an item.

Item Examples

Greater XP Potion

Rusted Iron Sword

Basic Lockpick

Basic Data

Name	Summary
Name of Item	The name of the item. This can be formatted with colors, animations, etc.
Flavor Text	This is the item's "description." It will appear in the dossier entry for the item.
Item Image ID	The addressable ID of the image used to represent the item. Read about addressables here.
Type of Item	The classification/functionality of this item. Although multi-selectable, you should generally choose only one type to avoid issues or overlapping functionalities.
Override Type of Item Text	If filled, this text will override the type displayed in the inventory. For example, "Brewing Ingredient" could indicate that the item is used for potion brewing. Leave blank if not needed.
Override Interaction Text	If filled, this text will replace the standard Equip/Consume button text. Useful for items that perform non-standard interactions (e.g., "Use" instead of "Consume").
Item Rarity	The base rarity of this item. The rarity can change later, but this sets the starting rarity (e.g., a common item might become legendary through keywords or other overrides).
Granted Skills	[Equipment Only] - Skills granted by equipping the item. These skills are ID-based (e.g., "Slash," "ToxicVolley") and are removed if the equipment is unequipped, unless they are learned permanently.
Effects List	A list of effects the item provides. For example: +25 Hunger (Note: Some effects, like keyword effects or modifiers, may display automatically without manual entries in this list.)
Cached Data	Stores information about the item for other systems. For example, a "LockpickSpeed" entry might determine lockpick speed, while a "LockpickIcon" entry might store the associated image. Read more about Cached Data here.
Weapon Hand Size	[Weapons Only] - Can be set to One-Handed or Two-Handed. One-handed weapons can be equipped in either hand, while two-handed weapons occupy both weapon slots.
Quest Item	Flags the item as necessary for a quest, preventing it from being sold, crafted, or dropped.
Uses Cooldowns	Marks the item as using cooldowns. When enabled, you must specify a "Cooldown Tag" and "Cooldown Length." Items sharing the same Cooldown Tag will share the cooldown period. (E.g., setting a "Potion" tag on potions would make all potions share the same cooldown.)
Uses Durability	Adds a durability value to the item. You can set a maximum durability, and the item can be repaired up to that maximum. Note: For consumables, durability decreases per use. You can choose whether the stack is destroyed when durability reaches zero or allow a "broken" item to remain (e.g., bread consumed three times might disappear entirely instead of leaving a "broken bread" item).
Can Be Used As Crafting Ingredient	Flags whether the item can be used in crafting systems like alchemy or woodworking. This flag is ignored if the item is marked as a quest item.
Item Can Stack	Specifies whether the item can stack. Equipment items cannot stack.
Item Weight	The item's weight in the player's inventory. Items exceeding the inventory weight limit cannot be added.
Override Level On Creation	Allows you to hard set the item's level. If left blank, the item's level will default to its creation settings.

Item Set Data

Name	Summary
Item Set Tag	The name of the items set that it belongs to.
Item Set Count Required	The amount of items needed to be equipped of the same Item Set Tag to grant this items set bonuses.
Pre-Generated Set Modifier Stats	The modifiers granted when the set bonus is active. Read more about Modifiers here.
Set Granted Skills	The skills granted when the set bonus is active. When the set bonus becomes invalid the skill will be unequipped if not already learned.

Usage Tag Data

Name	Summary
On Obtain	Triggers the given Usage Tags when the item is "obtained" (added to the players inventory).
On Equip	Triggers the given Usage Tags when the item is equipped to the player.
On Unequip	NOTE: NOT IMPLEMENTED YET Triggers the given Usage Tags when the item is unequipped to the player.
On Consume	Triggers the given Usage Tags when the item is consumed.
On Any Damage Taken	NOTE: NOT IMPLEMENTED YET Triggers the given Usage Tags when the player takes damage. Only applies to equipped items.
On Physical Damage Taken	NOTE: NOT IMPLEMENTED YET Triggers the given Usage Tags when the player takes physical damage. Only applies to equipped items.
On Magic Damage Taken	NOTE: NOT IMPLEMENTED YET Triggers the given Usage Tags when the player takes magic damage. Only applies to equipped items.
On Thrown Self	Note: In-combat throwing system is still WIP and only triggered through usage tags right now without a proper target system. Triggers the given Usage Tags when the user throws the item at themselves.
On Thrown Target	Note: In-combat throwing system is still WIP and only triggered through usage tags right now without a proper target system. Triggers the given Usage Tags when the user throws the item at another target.

Economy

Name	Summary
Worth	The general worth/value of the item. This is the base value which is then modified based on variable factors per-merchant.
Volatility	The base price volatility of this item. When a volatility change happens the price will be modified by the - to + value of this range (by a random amount). Example: A volatility of 0.5 means that with each volatility change the items value will be changed between -50% & +50%. This could be -5%, or +26% value in the volatility change, this value is random between this range.
Max Volatility	The max volatility multiplier this item can go to. If an item has a max of 1.5 volatility, that means it can only ever get to be 150% more valuable.
Min Volatility	The minimum volatility multiplier this item can go down to. If an item has a minimum of 0.5 volatility, that means it can only ever get to be 50% less valuable (half as valuable).

Usage Requirements

The requirements this item must meet to be interacted with, consumed, equipped, etc.
Read more about Interaction Requirements here.

Modifiers

Name	Summary
Pre-Generated Modifier Stats	The generative modifiers of this item. To understand modifiers better consider reading about modifiers.
Max Keywords	The max amount of keywords this item can have, and the amount of chances that a keyword will generate for the item on creation.
Keyword Chance	The % chance that a keyword is added to the item on creation. When this is set to 100, that means 100%. When set to 50, that's 50%. When set to 1.5, that's a 1.5% chance, etc. (1:1 % Ratio)
Keyword Modifies Rarity	A simple flag which can toggle whether keywords can modify the items rarity or not.
Keyword Blacklist	A list of keywords that cannot apply to this item. Due to how keywords are filtered, by default keywords which do not contain the same available type as this item will be auto-blacklisted.
Guaranteed Keywords	Keywords added to this item on its creation.
Elemental Resistances	The elemental resistances provided by the item.

Repairs

NOTE: NOT IMPLEMENTED YET

Name	Summary
Repairable	If the item has a durability and this is checked it means that the durability of this item can be repaired.
Can Only Be Repaired By Pay	Makes it so that the item can only be repaired by a vendor for a paid amount.
Override Repair Cost	When repairing with a vendor this will set the price of that repair manually to the override value. Otherwise the repair cost is calculated based on the repair ingredients.
Low Cost Repair Recipe	The recipe used by a repair bench/blacksmith to make minor repairs to an unbroken item.
Medium Cost Repair Recipe	The recipe used by a repair bench/blacksmith to make medium repairs to an unbroken item.
Full Cost Repair Recipe	The recipe used by a repair bench/blacksmith to fix a broken item.