Enchantments Viewer

Changelog

Release 1.0.1 Version

Fixed

• Bumped version to include mode dependency ModsCommunicator in manifest.json.
• Made front pictures hideable in readme.

Release 1.0.0 Version

Added

• Provided a way for modders to change enchantment descriptions 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); }
• Item enchantment description can be overwritten with custom descriptions. Doesn't remove calculations only modifies/attaches description to enchantment description. Can be tested fully with enchantments: Poltergeist, Thirst.
• Added dependency for ModsCommunicator.

Fixed

• Made sure that custom enchantment descriptions a shown on items enchantments descriptions.
• Changed GUID from gymmed.outwardenchantmentsviewer to gymmed.outward_enchantments_viewer.
• Changed custom enchantment descriptions xml file path to:BepInEx\config\gymmed.Mods_Communicator\Enchantments_Viewer\PlayersCustomEnchantmentsDescriptions.xml

Release 0.5.1 Version

Fixed

• Fixed equipment detailed enchantment descriptions. Now weapon AoE blast damage multiplier is presented in decimals instead of percentage. The same way as in wiki.

Release 0.5.0 Version

Added

• Introduced new configurable display settings:
  • ShowInShopEnchantmentWithEquipmentType – Enables enchantments in shop to show compatible equipment type.

Fixed

• Fixed enchantment descriptions in shops by retrieving equipment type from localized description.

Release 0.4.2 Version

Fixed

• No code changes. Only updated for README pictures and links to change.

Release 0.4.1 Version

Fixed

• Fixed enchantment descriptions errors. Fixed exceptions for out of bounds when trying to get equipment type name from enchantment description.
• Fixed equipment detailed enchantments descriptions in crafting menu. Now it retrieves data from other sources and worse case scenario outputs default description with less information.
• Fixed enchantment descriptions equipment type retrieval. Now it checks equipment type and possibly provides backpack.
• Removed calculations that start with 0 and end with 0 in equipment detailed enchantments descriptions.

Release 0.4.0 Version

Added

• Added detailed equipment enchantment descriptions for bags. Vanilla doesn't provide enchantment for bags but mods do. Nice feature for modders.
• Added enchantment descriptions equipment tag new logic. Now if it cannot be identified by ingredient it just gets it from EnchantmentRecipeItem description. It's fragile but better than creating a map between items and enchantments and testing their compatibility(too many iterations, maybe async in future could be viable). Each determined Equipment type will have "?" to his name.

Fixed

• Fixed enchantment descriptions spacing. Now each recipe is separated by one empty line in EnchantmentRecipeItem.
• Fixed enchantment descriptions effect values.
• Removed detailed equipment enchantment descriptions attack speed base value rounding.

Release 0.3.3 Version

Fixed

• Fixed detailed equipment enchantment descriptions for damage bonus. Now it retrieves weapon enchantment base stat consistently.
• Fixed detailed equipment enchantment descriptions for damager modifiers. Now it shows percentage to weapon enchantments that add percentage of element damage instead of flat damage. Enchantments examples:Redemption, Forbidden Knowledge.
• Fixed detailed equipment enchantment descriptions health/mana regen stat. Now it doesn't try to round small values and presented as per second stat. Enchantments examples:Unexpected Resilience, Rain, Arcane Unison.
• Fixed detailed equipment enchantment descriptions food/drink/sleep depletation rate stat. Now it presents only decrease percentage value. Enchantment example:Abundance.
• Fixed detailed equipment enchantment descriptions stability regen stat. Now it shows percentage final value. Enchantment example:Compass.

Release 0.3.2 Version

Fixed

• Fixed spacing of equipment enchantment descriptions for clarity. Now each enchantment has it's own block of text and is separated by new line character.
• Added spacing to enchantment properties description to match equipment enchantment descriptions.

Release 0.3.1 Version

Fixed

• Added to detailed weapon enchantments descriptions Damage Bonus text for elemental damage descriptions clarity.
• Added to equipment descriptions enchantment description data. Now recipies like Poltergeist show self-repairing properties and modders can add additional text.
• Fixed equipment detailed enchantments description by removing repeating build up status effect.
• Fixed represantation of detailed enchantments description on items by rounding numbers.
• Removed double new line character in detailed equipment enchantments descriptions. Previously it was added by adding conditional text.

Release 0.3.0 Version

Added

• Introduced new configurable display settings:

  • ShowDetailedOwnedEnchantments – Enables detailed enchantment descriptions for equipment you own.
  • ShowDetailedUnownedEnchantments – Enables detailed enchantment descriptions for equipment you do not own.

• Added a counter for each unique enchantment.

• Added mappings for weapon enums to more human-readable text.

• Added mappings for equipment to more human-readable text.

Fixed

• Fixed enchantment counting on equipment – now only unique enchantments are counted.
• Retrieved enchantment descriptions data and added them as text. For example: enchantment Poltergeist now shows self-repairing property.
• Renamed all classes with json in the name to use xml instead for consistency.

Release 0.2.0 Version

Added

• Extended item descriptions beyond the player’s inventory, enabling them to display globally. Additionally, fixed scroll behavior and improved vertical navigation within itemDetailsDisplay.
• Introduced a new configurable display setting:
  • ShowDescriptionsOnlyForInventory – Allows users to limit enchantment descriptions to items currently in their inventory.

Release 0.1.0 Version

Added

• Introduced configurable display settings, allowing players to control which enchantment details are shown or hidden. This can be customized in BepInEx\config\gymmed.outwardenchantmentsviewer.cfg by modifying the following options:
  • ShowEnchantmentDescriptions
  • ShowEquipmentEnchantmentsDescriptions
  • ShowAllAvailableEnchantmentsCountForEquipment
  • ShowMissingEnchantmentsForEquipment
• Implemented customizable enchantment descriptions, enabling players to modify displayed enchantment details through customEnchantmentsDescriptions.xml.

Fixed

• Fixed an issue with the EnchantmentRecipeItem Filter, originally left by the developers, by ensuring each Filter sub-recipe is correctly assigned to prefab.

Release 0.0.2 Version

Fixed

• Resolved an issue where ItemDisplaySection gameObjects would duplicate within the same CharacterUI, occurring when exiting to menu and reloading the game or when closing and reopening split-screen mode.
• Fixed ItemDetailsDisplay scrolling behavior, ensuring proper functionality for both split-screen controller and mouse scroll input.