autismo-Custom_Item_Info_Display_reupload_from_vortex icon

Custom Item Info Display reupload from vortex

Lets you customize the information displayed for items in tooltips and the crafting menu. Created by aedenthorn

Last updated 2 years ago
Total downloads 314
Total rating 0 
Categories
Dependency string autismo-Custom_Item_Info_Display_reupload_from_vortex-0.1.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.1601 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured and includes unstripped Unity DLLs.

Preferred version: 5.4.1601

README

Custom Item Info Display

Lets you customize the information displayed for items in tooltips and the crafting menu.

Features

This mod provides a means of editing the information display for items using text files.

When you first run this mod it will create a folder at BepInEx\plugins\CustomItemUI. In this folder it will create a file called template.txt with a default template.

In the folder it will also create a subfolder called ItemTypes with txt files for each item type. These will be used for custom information per item type.

The default template adds the item's spawn name in parentheses.

To reset all templates to default, delete the BepInEx\plugins\CustomItemUI folder and run the game.

Template Tags

The template uses two types of tags, requirement tags and replacement tags. Tags are case sensitive.

Requirement Tags

At the start of a line you can add a list of requirement tags to decide whether to show the line. The tags should be comma-separated, enclosed in square brackets, e.g.:

[durability,crafting]

Possible requirement tags include:

crafted - show if item has a crafter crafting - show if this is for the crafting menu damageMod - show if item provides damage modification dlc - show if item is a dlc item durability - show if item uses durability food - show if item has food value handed - show if item has info about whether it is one-handed or two handed movement - show if item has a movement modifier projectile - show if item fires projectiles quality - show if item has a max quality greater than 1 repairable - show if item is repairable setStatus - show if item set provides a status effect status - show if item provides a status effect teleport - show if item can go through portals timedBlock - show if item provides a timed-block bonus value - show if item has monetary value

Besides these, you can specify an item type using:

[itemType<ItemType>]

to only show if the item is of that type, e.g.:

[itemTypeHelmet]

Finally, each tag can be prefaced with an exclamation mark to provide the opposite requirement, e.g.:

[durability,!crafting]

means the line will only show if it is not in the crafting menu (i.e. in tooltips) and only if the item uses durability.

Replacement Tags

Replacement tags are surrounded by curly braces, e.g.:

{itemDescription}

These tags will be replaced with the values for each specific item. Possible replacement tags are:

{itemDescription} {itemSpawnName} {itemHanded} {itemCrafterName} {itemValue} {itemBaseValue} {itemWeight} {itemQuality} {itemMaxDurability} {itemPercentDurability} {itemDurability} {itemStationLevel} {itemMovementMod} {totalMovementMod} {itemStatusInfo} {itemSetSize} {itemSetStatusInfo} {itemDamage} {itemBaseBlock} {itemBlock} {itemDeflection} {itemBlockBonus} {itemProjectileInfo} {itemDamageModInfo} {itemAttackForce} {itemBackstab} {itemArmor} {itemFoodHealth} {itemSetSize} {itemFoodStamina} {itemFoodDuration} {itemFoodRegen} {itemTypeInfo}

These should be mostly self-explanatory.

{itemTypeInfo} is replaced by the info contained in the template file for each item's type.

Here is the default template.txt file to show how the tags work in practice:

[crafting]{itemDescription} [!crafting]{itemDescription} ({itemSpawnName})

[dlc]<color=aqua>$item_dlc</color> [handed]{itemHanded} [crafted]$item_crafter: <color=orange>{itemCrafterName}</color> [!teleport]<color=orange>$item_noteleport</color> [value]$item_value: <color=orange>{itemValue} ({itemBaseValue})</color> $item_weight: <color=orange>{itemWeight}</color> [quality]$item_quality: <color=orange>{itemQuality}</color> [durability,crafting]$item_durability: <color=orange>{itemMaxDurability}</color> [durability,!crafting]$item_durability: <color=orange>{itemPercentDurability}%</color> <color=yellow>({itemDurability}/{itemMaxDurability})</color> [repairable]$item_repairlevel: <color=orange>{itemStationLevel}</color> {itemTypeInfo} [movement]$item_movement_modifier: <color=orange>{itemMovementMod}%</color> ($item_total:<color=yellow>{totalMovementMod}%</color>) [setStatus]\n$item_seteffect (<color=orange>{itemSetSize}</color> $item_parts):<color=orange>{itemSetStatusInfo}</color>

Config

(some of this section of the read me probably only applys to vortex due to the fact that this is a reupload)

A config file BepInEx/config/aedenthorn.CustomItemUI.cfg is created after running the game once with this mod.

You can adjust the config values by editing this file using a text editor or in-game using the Config Manager https://www.nexusmods.com/valheim/mods/740.

To reload the config from the config file, type customitemui reset into the game's console (F5).

Technical

(some of this section of the read me probably only applys to vortex due to the fact that this is a reupload)

To install this mod, the easiest way is to just use Vortex, the Nexus Mods mod manager. It should take care of all dependencies.

To install manually, place the dll file in the BepInEx/plugins folder. You will need BepInEx.

Code is at https://github.com/aedenthorn/ValheimMods.

If you want to complain or ask for help or help me test my mods, you can visit my Discord server https://discord.com/invite/bs6zHuj.

Click here for a list of all my mods for Valheim https://www.nexusmods.com/valheim/articles/104.