Enchantments Viewer

Outward mod that let's you view details of enchantments without wiki pages. Additionally shows on equipment all available and missing enchantments.

By GymMed

https://github.com/GymMed/Outward-Enchantments-Viewer

Last updated	12 hours ago
Total downloads	9656
Total rating	2
Categories	Items Utility UI
Dependency string	GymMed-Enchantments_Viewer-1.0.1
Dependants	5 other packages depend on this package

This mod requires the following mods to function

Outward Mods Communicator enables seamless communication between mods through shared events and configuration syncing. It also lets users override any changes made by other mods, giving them full control over their settings.

Preferred version: 1.2.0

sinai-dev-SideLoader

API and Mod Development Toolkit for Outward.

Preferred version: 3.8.4

BepInEx-BepInExPack_Outward

BepInEx pack for Outward.

Preferred version: 5.4.19

README

Outward Enchantments Viewer

Pictures

Outward added item enchantments description.

Outward added enchantment properties description.

Outward mod that provides additional descriptions for items and enchantments.

Enchantment Descriptions

Enchantments provide item type and enchantment descriptions

Item Descriptions

Enchantable items provide list of all compatible enchantments you have on your character and missing ones. Enchantments with a number in parentheses (e.g., (2)) show how many enchantments you currently have on your character.

Item Detailed Descriptions

Depending on your config settings your enchantable items can have calculations and effects on each enchantment description.
Calculations picture

Why use this mod?

Do you find yourself constantly switching between Outward and the Outward Wiki? Tired of alt-tabbing and letting Chrome consume unnecessary system resources just to find information that should already be available in-game?

The Outward Enchantments Viewer Mod has you covered!

Features:

Detailed Enchantment Descriptions – Enchantments now display both their bonuses and drawbacks.
Enchantment Availability Count – Item descriptions indicate the total number of enchantments available for that item.
Inventory Compatibility Tracking – Item descriptions show how many compatible enchantments exist in your inventory.
Enchantment Listing – All enchantments that can be applied to the item are listed in the description.
Dynamic Enchantment Descriptions – The system retrieves enchantment details from other mods, ensuring comprehensive and up-to-date descriptions.
Adaptive Item Descriptions – Item descriptions dynamically update by gathering information from other mods about available enchantments.
Fixed Scroll View for Item Display Details – Improves handling of longer modded descriptions by adjusting the scroll view, allowing for better readability and navigation. This enhances precision, provides more screen space, and ensures smooth scrolling, even when using a controller.
Custom Enchantment Descriptions – Allows players to define their own enchantment descriptions through XML, which are then loaded into the game for a personalized experience.

Modders can insert their xml file through ModsCommunicator.

Example:

using OutwardModsCommunicator.EventBus;
...
public static void PublishEnchantmentDescriptions()
{
    var payload = new EventPayload
    {
        ["filePath"] = "filePath/fileName.xml",
    };
    EventBus.Publish("gymmed.outward_enchantments_viewer_*", "LoadCustomEnchantmentsDescriptionsXml", payload);
}

Configurable Display Settings – Control how enchantment information is displayed.

Calculations explanation

base value => final value

Detailed equipment enchantment descriptions provide calculations. Base value shows current item stat value. Final value shows stat changes after enchanting it. Symbol => symbolizes change/shift. You can change if you need this kind of information through config settings:ShowDetailedOwnedEnchantments, ShowDetailedUnownedEnchantments.
Calculations picture

Configurable Display Settings

Control how enchantment information is displayed through BepInEx\config\gymmed.outwardenchantmentsviewer.cfg. Customize the visibility of enchantment details using the following settings:

ShowEnchantmentDescriptions – Enable or disable detailed enchantment descriptions.
ShowEquipmentDescriptions – Toggle the display of enchantments on equipment.
ShowAllAvailableEnchantmentsCountForEquipment – Choose whether to show the total number of enchantments available for each piece of equipment.
ShowMissingEnchantmentsForEquipment – Decide if missing enchantments for equipment should be displayed.
ShowDescriptionsOnlyForInventory – Restrict enchantment descriptions to items currently in the player’s inventory, hiding details for items in shops.
ShowDetailedOwnedEnchantments – Enables detailed own enchantments descriptions for equipment.
ShowDetailedUnownedEnchantments – Enables detailed not own enchantments descriptions for equipment.
ShowInShopEnchantmentWithEquipmentType – Enables enchantments in shop to show compatible equipment type.

How to use

Either clone/download the repository with Git or GitHub Desktop, or simply download the code manually.
Open src/OutwardEnchantments.sln with any C# IDE (Visual Studio, Rider, etc)
When you're ready, build the solution. It will be built to the Release folder (next to the src folder).
Take the DLL from the Release folder and put it in the BepInEx/plugins/ folder. If you use r2modman, this can be found by going into r2modman settings and clicking on Browse Profile Folder.

How to create personalized enchantment descriptions

To add custom enchantment descriptions, follow these steps:

Copy the example file BepInEx\config\gymmed.Mods_Communicator\Enchantments_Viewer\PlayersCustomEnchantmentsDescriptions.example.xml and rename it to PlayersCustomEnchantmentsDescriptions.xml.
Open the newly created file and add your custom enchantment descriptions by copying and modifying existing <enchantment> tags.
You can find the IDs for vanilla enchantments in vanillaRecipesID.txt.
The overwrite attribute determines how your custom description interacts with existing ones:
- overwrite = true → Completely replaces the default enchantment description.
- overwrite = false → Adds your custom text as an addition to the existing description.
To remove a custom description, simply delete the entire <enchantment> tag block from the XML file.

This system allows for full customization, letting you personalize enchantment descriptions to fit your preferences.

Get the Thunderstore App